Load and Unload Card for Issuer - Field Descriptions

The following page details the fields available in the request and response when using the Load and Unload Card for Issuer endpoint.

Request Fields

The following table describes fields that can be included in the body of the request when loading or unloading funds as an issuer.

Field

Description

Minimum Length

Maximum Length

Type

Mandatory

transactionType

The type of transaction for the request. Select from:

  • Load for loading money onto a card
  • Unload for unloading money from a card

4

6

String

Yes

amount

The monetary amount of the transaction.

0

Double

Yes

currencyCode

the currency used in the transaction.

3

3

String

Yes

user

The actor initiating the transaction request.

0

30

String

No

description

Free text field describing the transaction that is populated on card statement.

0

1024

String

No

Response Fields

A successful response for the Load and Unload Card for Issuer endpoint returns a 200 response and details of the transaction performed, and the updated balance of the card.

FieldDescription
transactionAn object that contains the details of the transaction.
transactionTypeThe type of transaction ran by the endpoint.
transactionIdThe unique transaction identifier for the transaction.
amountThe amount of the transaction.
currencyCodeThe currency code of the transaction
publicTokenThe publicToken of the card the transaction was ran for.
balanceAn object that contains the details of the updated balance for the card after the transaction.
currencyCodeThe currency code associated with the card.
cardBalanceThe current balance of the card.
pendingAmountAny pending amount associated with the card,
availableBalanceThe available balance of the card.