Retrieve Account Balances

Specifications

Request

JSON PATHDescriptionExampleFormatRequired
account_idThe Identifier associated to Accountfcd0cecb-90dd-4ae2-879f-d0eda6fbddd4UUIDYes

Response

JSON PATHDescriptionExampleFormatRequired
account_balanceThe total balance of the account. This is not the amount that can be spent. A minus figure indicates a debit balance200stringYes
available_account_balanceThe value that is available to be spent. A minus figure indicates a debit balance100stringYes
overdraft_valueThe agreed value of the Overdraft. This does not identify the value of the Overdraft used500stringNo
pending_authorized_amountThe total amount of authorized spend if applicable100stringYes
trace_idThe Identifier associated with the API15bfc289-de75-4668-bb11-3998aadf226dstringYes

Example

{
    "account_balance": "200",
    "available_account_balanc": "100",
    "overdraft_value": "500",
    "pending_authorized_amount": "100",
    "trace_id": "15bfc289-de75-4668-bb11-3998aadf226d"
}