Cards

No OAuth-enabled endpoints in this section. Turn off the OAuth filter in the sidebar to see all of its endpoints.

POST/1/cards

Create Card

Authorization
User sessionAPI credentialAction token
Permissions
cards:write
OAuth
-
Request
Request bodyapplication/json
accountIdstringREQUIRED
billingPlanIdstringREQUIRED
deliveryobject
addressstring
addressLine2string
citystring
countryCodestring
firstNamestring
lastNamestring
postalCodestring
nameOnCardstring
sendEmailboolean
typestring
userIdstringREQUIRED
vehicleIdstring
Responses
200OK application/json
dataCardResource
accountobject
accountIdstringREQUIRED
billingPlanobject
billingPlanChangeContextstring
billingPlanChangedAtstring <date-time>
billingPlanIdstringREQUIRED
cancelledboolean
cancelledAtstring <date-time>
cancelledReasonstring
createdAtstring <date-time>
deletedboolean
deletedAtstring <date-time>
deliveryCardDelivery
addressstringREQUIRED
addressLine2stringREQUIRED
citystringREQUIRED
countryCodestringREQUIRED
firstNamestringREQUIRED
lastNamestringREQUIRED
notesstring
postalCodestringREQUIRED
externalPaymentExternalPayment
authorizedAmountBSONMoney
currencystringREQUIRED
minornumberREQUIRED
moneystringREQUIRED
capturedAmountBSONMoney
currencystringREQUIRED
minornumberREQUIRED
moneystringREQUIRED
displayIdentifierstring
failureReasonstring
paymentIdstring
paymentInstrumentIdstring
paymentMethodstring
statusstringREQUIRED
AUTHORIZEDCOMPLETEDFAILEDMISSINGPENDINGVOIDED
systemIdstringREQUIRED
payBridge
fleetIdstring
idstringREQUIRED
migrationAtstring <date-time>
migrationIdstring
mspPaymentMSPPaymentCard
cardCostsAmountBSONMoneyREQUIRED
currencystringREQUIRED
minornumberREQUIRED
moneystringREQUIRED
paymentReceiptIdstring
totalAmountBSONMoneyREQUIRED
currencystringREQUIRED
minornumberREQUIRED
moneystringREQUIRED
vatInfoVatRule
calculatedAtstring <date-time>
erpSystemstring
exactnetsuite
erpVatCodestring | number
exactVatCodestring | number
isNotApplicableboolean
isReverseChargeboolean
lookupTablestring
matchedRuleIdstringREQUIRED
vatCalculatorVersionstring
vatImplementationstring
vatPercentagenumberREQUIRED
nameOnCardstring
providerIdstringREQUIRED
requestUserboolean
requestUserEmailstring
requestUserFirstNamestring
requestUserLastNamestring
statusstringREQUIRED
activedisabledpendingpending-activationpending-paymentsent
tokenobject
tokenAssignedAtstring <date-time>
tokenIdstring
typestringREQUIRED
cardtagvirtual
updatedAtstring <date-time>
userobject
userIdstringREQUIRED
metaobject
limitnumber
skipnumber
statsobject
totalnumber
400Invalid Request application/json
errorobject
detailsobject
messagestringREQUIRED
statusnumberREQUIRED
typestringREQUIRED
401Unauthorized application/json
errorobject
detailsobject
messagestringREQUIRED
statusnumberREQUIRED
typestringREQUIRED
403Forbidden: missing a required permission, or no access to this resource application/json
errorobject
detailsobject
messagestringREQUIRED
statusnumberREQUIRED
typestringREQUIRED
404Not Found application/json
errorobject
detailsobject
messagestringREQUIRED
statusnumberREQUIRED
typestringREQUIRED
500Internal server error application/json
errorobject
detailsobject
messagestringREQUIRED
statusnumberREQUIRED
typestringREQUIRED
POST/1/cards/search/fast

Search Cards

Authorization
User sessionAPI credentialAction token
Permissions
cards:read
OAuth
-
Request
Request bodyapplication/json
accountIdstring
billingPlanstring[]
cancelledboolean
cancelledReasonstring
createdAtobject
$gtenumber | string <date-time>
$ltenumber | string <date-time>
fromstring <date-time>
limitnumber
default 50
nameOrTokenCustomIdstring
searchPhrasestring
skipnumber
default 0
sortobject
default {"field":"createdAt","order":"desc"}
fieldstringREQUIRED
orderstringREQUIRED
ascdesc
statusstring | string[]
tostring <date-time>
tokenIdstring
typestring
Responses
200OK application/json
dataCardSearch[]
accountobject
billingobject
addressFullstring
namestring
accountIdstring
billingPlanobject
namestring
billingPlanIdstring
cancelledboolean
cancelledReasonstring
createdAtstring <date-time>REQUIRED
deliveryDeliveryAddress
addressstring
citystring
countryCodestring
firstNamestring
lastNamestring
postalCodestring
idstringREQUIRED
nameOnCardstring
providerIdstringREQUIRED
statusstringREQUIRED
activedisabledpendingpending-activationpending-paymentsent
tokenobject
contractIdstring
customIdstring
emi3Contractobject
checksumDigitstring
countryCodestring
emaInstancestring
idTypestring
partyIdstring
uidstring
visualNumberstring
tokenAssignedAtstring <date-time>
tokenIdstring
typestringREQUIRED
cardtagvirtual
userobject
emailstring
namestring
userIdstring
metaobject
limitnumber
skipnumber
statsobject
totalnumber
400Invalid Request application/json
errorobject
detailsobject
messagestringREQUIRED
statusnumberREQUIRED
typestringREQUIRED
401Unauthorized application/json
errorobject
detailsobject
messagestringREQUIRED
statusnumberREQUIRED
typestringREQUIRED
403Forbidden: missing a required permission, or no access to this resource application/json
errorobject
detailsobject
messagestringREQUIRED
statusnumberREQUIRED
typestringREQUIRED
404Not Found application/json
errorobject
detailsobject
messagestringREQUIRED
statusnumberREQUIRED
typestringREQUIRED
500Internal server error application/json
errorobject
detailsobject
messagestringREQUIRED
statusnumberREQUIRED
typestringREQUIRED
POST/1/cards/virtual

Create Virtual Card

Authorization
User sessionAPI credentialAction token
Permissions
cards:write
OAuth
-
Request
Request bodyapplication/json
accountIdstringREQUIRED
billingPlanIdstringREQUIRED
excludeProviderPartyIdsstring[]
nameOnCardstringREQUIRED
skipRoamingSyncboolean
tokenUidstring
userIdstringREQUIRED
visualNumberstring
Responses
200OK application/json
dataCard
accountIdstringREQUIRED
billingPlanChangeContextstring
billingPlanChangedAtstring <date-time>
billingPlanIdstringREQUIRED
cancelledboolean
cancelledAtstring <date-time>
cancelledReasonstring
createdAtstring <date-time>
deletedboolean
deletedAtstring <date-time>
deliveryCardDelivery
addressstringREQUIRED
addressLine2stringREQUIRED
citystringREQUIRED
countryCodestringREQUIRED
firstNamestringREQUIRED
lastNamestringREQUIRED
notesstring
postalCodestringREQUIRED
externalPaymentExternalPayment
authorizedAmountBSONMoney
currencystringREQUIRED
minornumberREQUIRED
moneystringREQUIRED
capturedAmountBSONMoney
currencystringREQUIRED
minornumberREQUIRED
moneystringREQUIRED
displayIdentifierstring
failureReasonstring
paymentIdstring
paymentInstrumentIdstring
paymentMethodstring
statusstringREQUIRED
AUTHORIZEDCOMPLETEDFAILEDMISSINGPENDINGVOIDED
systemIdstringREQUIRED
payBridge
fleetIdstring
idstringREQUIRED
migrationAtstring <date-time>
migrationIdstring
mspPaymentMSPPaymentCard
cardCostsAmountBSONMoneyREQUIRED
currencystringREQUIRED
minornumberREQUIRED
moneystringREQUIRED
paymentReceiptIdstring
totalAmountBSONMoneyREQUIRED
currencystringREQUIRED
minornumberREQUIRED
moneystringREQUIRED
vatInfoVatRule
calculatedAtstring <date-time>
erpSystemstring
exactnetsuite
erpVatCodestring | number
exactVatCodestring | number
isNotApplicableboolean
isReverseChargeboolean
lookupTablestring
matchedRuleIdstringREQUIRED
vatCalculatorVersionstring
vatImplementationstring
vatPercentagenumberREQUIRED
nameOnCardstring
providerIdstringREQUIRED
requestUserboolean
requestUserEmailstring
requestUserFirstNamestring
requestUserLastNamestring
statusstringREQUIRED
activedisabledpendingpending-activationpending-paymentsent
tokenAssignedAtstring <date-time>
tokenIdstring
typestringREQUIRED
cardtagvirtual
updatedAtstring <date-time>
userIdstringREQUIRED
metaobject
limitnumber
skipnumber
statsobject
totalnumber
400Invalid Request application/json
errorobject
detailsobject
messagestringREQUIRED
statusnumberREQUIRED
typestringREQUIRED
401Unauthorized application/json
errorobject
detailsobject
messagestringREQUIRED
statusnumberREQUIRED
typestringREQUIRED
403Forbidden: missing a required permission, or no access to this resource application/json
errorobject
detailsobject
messagestringREQUIRED
statusnumberREQUIRED
typestringREQUIRED
404Not Found application/json
errorobject
detailsobject
messagestringREQUIRED
statusnumberREQUIRED
typestringREQUIRED
500Internal server error application/json
errorobject
detailsobject
messagestringREQUIRED
statusnumberREQUIRED
typestringREQUIRED
PATCH/1/cards/{card}

Update Card

Authorization
User sessionAPI credentialAction token
Permissions
cards:write
OAuth
-
Request
Path parameters1
cardstringREQUIRED
Request bodyapplication/json
billingPlanIdstringREQUIRED
deliveryobject
addressstring
addressLine2string
citystring
countryCodestring
firstNamestring
lastNamestring
postalCodestring
disabledReasonstring
nameOnCardstring
sendEmailboolean
statusstring
activedisabledpendingpending-activationsent
typestring
userIdstringREQUIRED
vehicleIdstring | null
Responses
200Card application/json
dataCardResource
accountobject
accountIdstringREQUIRED
billingPlanobject
billingPlanChangeContextstring
billingPlanChangedAtstring <date-time>
billingPlanIdstringREQUIRED
cancelledboolean
cancelledAtstring <date-time>
cancelledReasonstring
createdAtstring <date-time>
deletedboolean
deletedAtstring <date-time>
deliveryCardDelivery
addressstringREQUIRED
addressLine2stringREQUIRED
citystringREQUIRED
countryCodestringREQUIRED
firstNamestringREQUIRED
lastNamestringREQUIRED
notesstring
postalCodestringREQUIRED
externalPaymentExternalPayment
authorizedAmountBSONMoney
currencystringREQUIRED
minornumberREQUIRED
moneystringREQUIRED
capturedAmountBSONMoney
currencystringREQUIRED
minornumberREQUIRED
moneystringREQUIRED
displayIdentifierstring
failureReasonstring
paymentIdstring
paymentInstrumentIdstring
paymentMethodstring
statusstringREQUIRED
AUTHORIZEDCOMPLETEDFAILEDMISSINGPENDINGVOIDED
systemIdstringREQUIRED
payBridge
fleetIdstring
idstringREQUIRED
migrationAtstring <date-time>
migrationIdstring
mspPaymentMSPPaymentCard
cardCostsAmountBSONMoneyREQUIRED
currencystringREQUIRED
minornumberREQUIRED
moneystringREQUIRED
paymentReceiptIdstring
totalAmountBSONMoneyREQUIRED
currencystringREQUIRED
minornumberREQUIRED
moneystringREQUIRED
vatInfoVatRule
calculatedAtstring <date-time>
erpSystemstring
exactnetsuite
erpVatCodestring | number
exactVatCodestring | number
isNotApplicableboolean
isReverseChargeboolean
lookupTablestring
matchedRuleIdstringREQUIRED
vatCalculatorVersionstring
vatImplementationstring
vatPercentagenumberREQUIRED
nameOnCardstring
providerIdstringREQUIRED
requestUserboolean
requestUserEmailstring
requestUserFirstNamestring
requestUserLastNamestring
statusstringREQUIRED
activedisabledpendingpending-activationpending-paymentsent
tokenobject
tokenAssignedAtstring <date-time>
tokenIdstring
typestringREQUIRED
cardtagvirtual
updatedAtstring <date-time>
userobject
userIdstringREQUIRED
metaobject
limitnumber
skipnumber
statsobject
totalnumber
400Invalid Request application/json
errorobject
detailsobject
messagestringREQUIRED
statusnumberREQUIRED
typestringREQUIRED
401Unauthorized application/json
errorobject
detailsobject
messagestringREQUIRED
statusnumberREQUIRED
typestringREQUIRED
403Forbidden: missing a required permission, or no access to this resource application/json
errorobject
detailsobject
messagestringREQUIRED
statusnumberREQUIRED
typestringREQUIRED
404Not Found application/json
errorobject
detailsobject
messagestringREQUIRED
statusnumberREQUIRED
typestringREQUIRED
500Internal server error application/json
errorobject
detailsobject
messagestringREQUIRED
statusnumberREQUIRED
typestringREQUIRED
POST/1/cards/{card}/disable

Disable Card

Authorization
User sessionAPI credentialAction token
Permissions
cards:write
OAuth
-
Request
Path parameters1
cardstringREQUIRED
Request bodyapplication/json
skipRoamingSyncboolean
default false
Responses
200OK application/json
dataCardResource
accountobject
accountIdstringREQUIRED
billingPlanobject
billingPlanChangeContextstring
billingPlanChangedAtstring <date-time>
billingPlanIdstringREQUIRED
cancelledboolean
cancelledAtstring <date-time>
cancelledReasonstring
createdAtstring <date-time>
deletedboolean
deletedAtstring <date-time>
deliveryCardDelivery
addressstringREQUIRED
addressLine2stringREQUIRED
citystringREQUIRED
countryCodestringREQUIRED
firstNamestringREQUIRED
lastNamestringREQUIRED
notesstring
postalCodestringREQUIRED
externalPaymentExternalPayment
authorizedAmountBSONMoney
currencystringREQUIRED
minornumberREQUIRED
moneystringREQUIRED
capturedAmountBSONMoney
currencystringREQUIRED
minornumberREQUIRED
moneystringREQUIRED
displayIdentifierstring
failureReasonstring
paymentIdstring
paymentInstrumentIdstring
paymentMethodstring
statusstringREQUIRED
AUTHORIZEDCOMPLETEDFAILEDMISSINGPENDINGVOIDED
systemIdstringREQUIRED
payBridge
fleetIdstring
idstringREQUIRED
migrationAtstring <date-time>
migrationIdstring
mspPaymentMSPPaymentCard
cardCostsAmountBSONMoneyREQUIRED
currencystringREQUIRED
minornumberREQUIRED
moneystringREQUIRED
paymentReceiptIdstring
totalAmountBSONMoneyREQUIRED
currencystringREQUIRED
minornumberREQUIRED
moneystringREQUIRED
vatInfoVatRule
calculatedAtstring <date-time>
erpSystemstring
exactnetsuite
erpVatCodestring | number
exactVatCodestring | number
isNotApplicableboolean
isReverseChargeboolean
lookupTablestring
matchedRuleIdstringREQUIRED
vatCalculatorVersionstring
vatImplementationstring
vatPercentagenumberREQUIRED
nameOnCardstring
providerIdstringREQUIRED
requestUserboolean
requestUserEmailstring
requestUserFirstNamestring
requestUserLastNamestring
statusstringREQUIRED
activedisabledpendingpending-activationpending-paymentsent
tokenobject
tokenAssignedAtstring <date-time>
tokenIdstring
typestringREQUIRED
cardtagvirtual
updatedAtstring <date-time>
userobject
userIdstringREQUIRED
metaobject
limitnumber
skipnumber
statsobject
totalnumber
400Invalid Request application/json
errorobject
detailsobject
messagestringREQUIRED
statusnumberREQUIRED
typestringREQUIRED
401Unauthorized application/json
errorobject
detailsobject
messagestringREQUIRED
statusnumberREQUIRED
typestringREQUIRED
403Forbidden: missing a required permission, or no access to this resource application/json
errorobject
detailsobject
messagestringREQUIRED
statusnumberREQUIRED
typestringREQUIRED
404Not Found application/json
errorobject
detailsobject
messagestringREQUIRED
statusnumberREQUIRED
typestringREQUIRED
500Internal server error application/json
errorobject
detailsobject
messagestringREQUIRED
statusnumberREQUIRED
typestringREQUIRED
POST/1/cards/{card}/enable

Enable Card

Authorization
User sessionAPI credentialAction token
Permissions
cards:write
OAuth
-
Request
Path parameters1
cardstringREQUIRED
Request bodyapplication/json
skipRoamingSyncboolean
default false
Responses
200OK application/json
dataCardResource
accountobject
accountIdstringREQUIRED
billingPlanobject
billingPlanChangeContextstring
billingPlanChangedAtstring <date-time>
billingPlanIdstringREQUIRED
cancelledboolean
cancelledAtstring <date-time>
cancelledReasonstring
createdAtstring <date-time>
deletedboolean
deletedAtstring <date-time>
deliveryCardDelivery
addressstringREQUIRED
addressLine2stringREQUIRED
citystringREQUIRED
countryCodestringREQUIRED
firstNamestringREQUIRED
lastNamestringREQUIRED
notesstring
postalCodestringREQUIRED
externalPaymentExternalPayment
authorizedAmountBSONMoney
currencystringREQUIRED
minornumberREQUIRED
moneystringREQUIRED
capturedAmountBSONMoney
currencystringREQUIRED
minornumberREQUIRED
moneystringREQUIRED
displayIdentifierstring
failureReasonstring
paymentIdstring
paymentInstrumentIdstring
paymentMethodstring
statusstringREQUIRED
AUTHORIZEDCOMPLETEDFAILEDMISSINGPENDINGVOIDED
systemIdstringREQUIRED
payBridge
fleetIdstring
idstringREQUIRED
migrationAtstring <date-time>
migrationIdstring
mspPaymentMSPPaymentCard
cardCostsAmountBSONMoneyREQUIRED
currencystringREQUIRED
minornumberREQUIRED
moneystringREQUIRED
paymentReceiptIdstring
totalAmountBSONMoneyREQUIRED
currencystringREQUIRED
minornumberREQUIRED
moneystringREQUIRED
vatInfoVatRule
calculatedAtstring <date-time>
erpSystemstring
exactnetsuite
erpVatCodestring | number
exactVatCodestring | number
isNotApplicableboolean
isReverseChargeboolean
lookupTablestring
matchedRuleIdstringREQUIRED
vatCalculatorVersionstring
vatImplementationstring
vatPercentagenumberREQUIRED
nameOnCardstring
providerIdstringREQUIRED
requestUserboolean
requestUserEmailstring
requestUserFirstNamestring
requestUserLastNamestring
statusstringREQUIRED
activedisabledpendingpending-activationpending-paymentsent
tokenobject
tokenAssignedAtstring <date-time>
tokenIdstring
typestringREQUIRED
cardtagvirtual
updatedAtstring <date-time>
userobject
userIdstringREQUIRED
metaobject
limitnumber
skipnumber
statsobject
totalnumber
400Invalid Request application/json
errorobject
detailsobject
messagestringREQUIRED
statusnumberREQUIRED
typestringREQUIRED
401Unauthorized application/json
errorobject
detailsobject
messagestringREQUIRED
statusnumberREQUIRED
typestringREQUIRED
403Forbidden: missing a required permission, or no access to this resource application/json
errorobject
detailsobject
messagestringREQUIRED
statusnumberREQUIRED
typestringREQUIRED
404Not Found application/json
errorobject
detailsobject
messagestringREQUIRED
statusnumberREQUIRED
typestringREQUIRED
500Internal server error application/json
errorobject
detailsobject
messagestringREQUIRED
statusnumberREQUIRED
typestringREQUIRED