Transactions - Field Descriptions
The following page details each of the fields received in the response when using the Transactions endpoint.
Request Fields
The following table describes fields that can be included in the body of the request when performing a transaction.
Field | Description | Minimum Length | Maximum Length | Type | Mandatory |
|---|---|---|---|---|---|
transactionType | The type of transaction for the request. Select from:
| 3 | 17 | 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 |
feeAmount | Fee applied to the transaction. Only required if the Fee option | 0 | Double | Conditional | |
feeType | The Fee Type of the transaction. Required when transactionType is set to Fee. | 0 | 23 | String | Conditional |
toPublicToken | Target public token of the request. Required when transactionType is set to TransferFunds. | 1 | String | Conditional |
Response Fields
A successful response for the Transactions endpoint will return a 200 response and details of the transaction performed and the updated balance of the card.
| Field | Description |
|---|---|
| transaction | An object that contains the details of the transaction. |
| transactionType | The type of transaction ran by the endpoint. |
| transactionId | The unique transaction identifier for the transaction. |
| amount | The amount of the transaction. |
| currencyCode | The currency code of the transaction |
| publicToken | The publicToken of the card the transaction was ran for. |
| balance | An object that contains the details of the updated balance for the card after the transaction. |
| currencyCode | The currency code associated with the card. |
| cardBalance | The current balance of the card. |
| pendingAmount | Any pending amount associated with the card, |
| availableBalance | The available balance of the card. |
Updated 16 days ago