Sign in

v1

latestOpenAPI 3.0.12026-07-2662118182.1 KB
Transactions

Load or Unload Card

post/api/v1/cards/{publicToken}/transactions

Path parameters

publicTokenstring required

Request body

transactionType'Load' | 'Unload' | 'TransferFunds' | 'BalanceAdjustment' | 'Fee' required

The type of transaction for the request. This will be either Load, Unload, Fee, TransferFunds or BalanceAdjustment.

amountnumber double required

The value corresponding to the transaction. Required, unless transactionType is Fee

currencyCodestring required

The currency of the transaction (3 letter currency code).

userstring nullable

The actor initiating the transaction request.

descriptionstring nullable

Free text field that is populated on card statement.

feeAmountnumber double required

The value corresponding to the transactions fees. Must be a positive amount. Required when transactionType is Fee

feeType'Undefined' | 'FundsTransferFee' | 'PINCVVServiceFee' | 'MonthlyServiceFee' | 'ReloadFromMVCFee' | 'CardConversionFee' | 'PhysicalCardIssuingFee' | 'AdministrationFee' | 'CardReplacementFee' | 'VirtualCardIssuingFee' | 'ParentCardActivationFee' | 'ChildCardActivationFee' | 'FirstLoadFromMVCFee' | 'RecurringFee' required

Fee Type associated with Fee transactions. Required, when transactionType is Fee

toPublicTokenstring required

Target public token of the request. Required if transactionType is TransferFunds.

Example request

{
  "transactionType": "BalanceAdjustment",
  "amount": 500.67,
  "currencyCode": "GBP",
  "user": "user123",
  "description": "Refund",
  "feeAmount": 0.8,
  "feeType": "AdministrationFee"
}

Response

Success

Example response

{
  "transaction": [
    {
      "transactionId": 6157564898,
      "amount": 1000,
      "currencyCode": "GBP",
      "publicToken": "6157564898"
    }
  ],
  "balance": {
    "currencyCode": "GBP",
    "cardBalance": 1000,
    "availableBalance": 1000
  }
}