Cards
No OAuth-enabled endpoints in this section. Turn off the OAuth filter in the sidebar to see all of its endpoints.
Card Management APIs
Create Card
Creates a request for physical card to be sent to a customer.
User sessionAPI credentialAction tokencards:writeRequest bodyapplication/json
deliveryobject
Name printed on the card. Stored on the card itself and independent of the user record: updating the user does not change this field.
200OK application/json
dataCardResource
deliveryCardDelivery
externalPaymentExternalPayment
authorizedAmountBSONMoney
capturedAmountBSONMoney
AUTHORIZEDCOMPLETEDFAILEDMISSINGPENDINGVOIDEDpayBridgeThe fleet the card's token belongs to. Kept in step with the token, never set on its own.
mspPaymentMSPPaymentCard
cardCostsAmountBSONMoneyREQUIRED
totalAmountBSONMoneyREQUIRED
vatInfoVatRule
exactnetsuiteERP-facing counterpart of exactVatCode. Mixed in Mongo: existing documents hold both strings and numbers.
activedisabledpendingpending-activationpending-paymentsentcardtagvirtualmetaobject
400Invalid Request application/json
errorobject
401Unauthorized application/json
errorobject
403Forbidden: missing a required permission, or no access to this resource application/json
errorobject
404Not Found application/json
errorobject
500Internal server error application/json
errorobject
Search Cards
The search for cards is driven by an index and eventually consistent. That means that an update to a card may take a short while before it is reflected in search results.
User sessionAPI credentialAction tokencards:readRequest bodyapplication/json
createdAtobject
500sortobjectdefault {"field":"createdAt","order":"desc"}
{"field":"createdAt","order":"desc"}ascdesc200OK application/json
dataCardSearch[]
accountobject
billingobject
billingPlanobject
deliveryDeliveryAddress
activedisabledpendingpending-activationpending-paymentsenttokenobject
emi3Contractobject
cardtagvirtualuserobject
metaobject
400Invalid Request application/json
errorobject
401Unauthorized application/json
errorobject
403Forbidden: missing a required permission, or no access to this resource application/json
errorobject
404Not Found application/json
errorobject
500Internal server error application/json
errorobject
Create Virtual Card
A Virtual Card allows for a Charging Token to be generated without the need for a physical charging card or token. Virtual Cards are most useful to control remote sessions across the roaming network e.g. in mobile app implementations, orif there already is an existing physical card that needs to be included within our platform.
User sessionAPI credentialAction tokencards:writeRequest bodyapplication/json
200OK application/json
dataCard
deliveryCardDelivery
externalPaymentExternalPayment
authorizedAmountBSONMoney
capturedAmountBSONMoney
AUTHORIZEDCOMPLETEDFAILEDMISSINGPENDINGVOIDEDpayBridgeThe fleet the card's token belongs to. Kept in step with the token, never set on its own.
mspPaymentMSPPaymentCard
cardCostsAmountBSONMoneyREQUIRED
totalAmountBSONMoneyREQUIRED
vatInfoVatRule
exactnetsuiteERP-facing counterpart of exactVatCode. Mixed in Mongo: existing documents hold both strings and numbers.
activedisabledpendingpending-activationpending-paymentsentcardtagvirtualmetaobject
400Invalid Request application/json
errorobject
401Unauthorized application/json
errorobject
403Forbidden: missing a required permission, or no access to this resource application/json
errorobject
404Not Found application/json
errorobject
500Internal server error application/json
errorobject
Update Card
Updates card fields. Note that userId and billingPlanId are required on every request, even when updating a single field such as nameOnCard. nameOnCard is stored on the card and does not follow the user record: updating a user's email or name leaves it unchanged, so it must be updated through this endpoint. A card cannot be moved to a different account; its account is always derived from the assigned user.
User sessionAPI credentialAction tokencards:writePath parameters1
Request bodyapplication/json
deliveryobject
Name printed on the card. Stored on the card itself and independent of the user record: updating the user does not change this field.
activedisabledpendingpending-activationsent200Card application/json
dataCardResource
deliveryCardDelivery
externalPaymentExternalPayment
authorizedAmountBSONMoney
capturedAmountBSONMoney
AUTHORIZEDCOMPLETEDFAILEDMISSINGPENDINGVOIDEDpayBridgeThe fleet the card's token belongs to. Kept in step with the token, never set on its own.
mspPaymentMSPPaymentCard
cardCostsAmountBSONMoneyREQUIRED
totalAmountBSONMoneyREQUIRED
vatInfoVatRule
exactnetsuiteERP-facing counterpart of exactVatCode. Mixed in Mongo: existing documents hold both strings and numbers.
activedisabledpendingpending-activationpending-paymentsentcardtagvirtualmetaobject
400Invalid Request application/json
errorobject
401Unauthorized application/json
errorobject
403Forbidden: missing a required permission, or no access to this resource application/json
errorobject
404Not Found application/json
errorobject
500Internal server error application/json
errorobject
Disable Card
Upon calling, the card will be disabled and the token will be blocked. An update to the roaming network will be dispatched immediately and the cardholder will not be able to charge.
User sessionAPI credentialAction tokencards:writePath parameters1
Request bodyapplication/json
false200OK application/json
dataCardResource
deliveryCardDelivery
externalPaymentExternalPayment
authorizedAmountBSONMoney
capturedAmountBSONMoney
AUTHORIZEDCOMPLETEDFAILEDMISSINGPENDINGVOIDEDpayBridgeThe fleet the card's token belongs to. Kept in step with the token, never set on its own.
mspPaymentMSPPaymentCard
cardCostsAmountBSONMoneyREQUIRED
totalAmountBSONMoneyREQUIRED
vatInfoVatRule
exactnetsuiteERP-facing counterpart of exactVatCode. Mixed in Mongo: existing documents hold both strings and numbers.
activedisabledpendingpending-activationpending-paymentsentcardtagvirtualmetaobject
400Invalid Request application/json
errorobject
401Unauthorized application/json
errorobject
403Forbidden: missing a required permission, or no access to this resource application/json
errorobject
404Not Found application/json
errorobject
500Internal server error application/json
errorobject
Enable Card
Upon calling, the card will be enabled and the token will be unblocked. An update to the roaming network will be dispatched immediately and the cardholder will be able to charge. A cancelled card cannot be enabled.
User sessionAPI credentialAction tokencards:writePath parameters1
Request bodyapplication/json
false200OK application/json
dataCardResource
deliveryCardDelivery
externalPaymentExternalPayment
authorizedAmountBSONMoney
capturedAmountBSONMoney
AUTHORIZEDCOMPLETEDFAILEDMISSINGPENDINGVOIDEDpayBridgeThe fleet the card's token belongs to. Kept in step with the token, never set on its own.
mspPaymentMSPPaymentCard
cardCostsAmountBSONMoneyREQUIRED
totalAmountBSONMoneyREQUIRED
vatInfoVatRule
exactnetsuiteERP-facing counterpart of exactVatCode. Mixed in Mongo: existing documents hold both strings and numbers.
activedisabledpendingpending-activationpending-paymentsentcardtagvirtual