data
array of objects
Returned | List of available statement objects.
Allowable Values:
Valid array of one or more statement objects |
data[].start_date
date
Returned | Date when the statement period began.
Allowable Values:
Format:
yyyy-MM-dd |
data[].end_date
date
Returned | Date when the statement period ended.
Allowable Values:
Format:
yyyy-MM-dd |
data[].account_numbers
array of strings
Conditionally returned | Array of account numbers associated with the cardholder.
Allowable Values:
255 char max |
data[].routing_number
string
Conditionally returned | Bank routing number.
Allowable Values:
255 char max |
data[].cycle_start_balance
decimal
Returned | Starting balance of the statement cycle.
Allowable Values:
decimal
Format:
0.00 |
data[].cycle_end_balance
decimal
Returned | Ending balance of the statement cycle.
Allowable Values:
decimal
Format:
0.00 |
data[].transactions
array of objects
Returned | List of transaction objects made during the statement cycle.
Allowable Values:
Valid array of one or more transaction objects |
data[].transactions[].amount
decimal
Returned | Amount of the given transaction.
Allowable Values:
decimal
Format:
0.00 |
data[].transactions[].date
datetime
Returned | Date when the transaction took place.
Allowable Values:
Format:
yyyy-MM-dd |
data[].transactions[].transaction_type
string
Returned | Type of transaction.
Allowable Values:
For a full list of transaction event types, see transaction events. |
data[].transactions[].cardholder_token
string
Returned | Unique identifier of the cardholder.
Allowable Values:
36 char max |
data[].transactions[].account_token
string
Conditionally returned | Unique identifier of the account.
Allowable Values:
36 char max |
data[].transactions[].token
string
Returned | Unique identifier of the transaction.
Allowable Values:
36 char max |
data[].transactions[].currency_code
string
Conditionally returned | The currency code of the transaction.
Allowable Values:
Valid three-character ISO 4217 currency code, such as EUR or USD |
data[].transactions[].transaction_data
object
Conditionally returned | Dynamic object containing transaction-specific fields. Structure can vary depending on transaction_type.
Allowable Values:
Existing JSON object containing information about a specific transaction |
data[].cardholder_tokens
array of strings
Returned | List of tokens identifying the cardholders in the statement.
Allowable Values:
One or more cardholder tokens |
data[].sort_code
string
Conditionally returned | Sort code for UK bank accounts.
Allowable Values:
6 char max |
data[].account_type
undefined
Conditionally returned | Type of account.
Allowable Values:
CHECKING, SAVINGS, WALLET, DEPOSIT_ACCOUNT |
data[].account_token
string
Conditionally returned | Unique identifier of the account.
Allowable Values:
36 char max |
data[].interest_apy
decimal
Conditionally returned | Annual Percentage Yield (APY) for interest calculations.
Allowable Values:
decimal
Format:
0.00 |
data[].interest_earned_ytd
decimal
Conditionally returned | Interest earned year-to-date.
Allowable Values:
decimal
Format:
0.00 |
data[].fees_ytd
decimal
Conditionally returned | Sum of fees charged to the account year-to-date.
Allowable Values:
decimal
Format:
0.00 |
data[].currency
string
Conditionally returned | Currency used in a transaction.
Allowable Values:
Valid three-character ISO 4217 currency code, such as EUR or USD |
is_more
boolean
Returned | - A value of true indicates that more unreturned resources exist.
- A value of false indicates that no more unreturned resources exist.
This field is returned if there are resources in your returned array.
Allowable Values:
true, false |
start_index
integer
Returned | Sort order index of the first resource in the returned array. This field is returned if there are resources in your returned array.
Allowable Values:
Any integer |
end_index
integer
Returned | Sort order index of the last resource in the returned array. This field is returned if there are resources in your returned array.
Allowable Values:
Any integer |
