API Endpoint Format
The following endpoints are available in our REST API. Not all implementations will use every endpoint– the choice is largely up to the integrator / merchant. We do however insist that all integrators implement the Reverse endpoint to allow transactions that effect a card’s balance to be undone if needed.
Endpoint Name Description
Login Merchant authentication for requesting Bearer token required for all further requests
Balance Gets the current balance of the specified card number
BalanceNoPIN Gets the current balance of the specified card number without requiring the card's PIN
InitializeVirtualCard Activates a new virtual / digital card number with the requested amount and returns the new card number
Load Increases the card’s balance by the requested amount. If it is the card’s first transaction, the card’s status is also changed to ‘Active’
Redeem Decreases the card’s balance by the requested amount
RedeemNoPIN Decreases the card’s balance by the requested amount, without requiring the card’s PIN
Refund Works identically to ‘Load’, but is intended for use where a card is loaded as store credit / as a refund, so this can be reported separately from cases where the card loaded and a payment was taken by cash / card.
Reverse 'Undo' a transaction that has already been completed
Unfreeze Unfreeze a card
Unlock Unlock a card