Sign in

v1

latestOpenAPI 3.1.0Copyright Pismo2026-07-247702,7523.1 MB
Bank statements

Get transaction banking account balance history

Get the balance history for a transaction banking account.

get/bank-statements/v1/account-balances/{externalAccountId}/history

Path parameters

externalAccountIdstring required

External account ID

Query parameters

startDatestring date

Starting date of the desired date range for the account balance history. If not provided, it defaults to one month prior to the end date. The total date range cannot exceed three years.

end_datestring required
Example:2025-01-30

End date filter, format = yyyy-mm-dd

cursorstring

Cursor to the next page of results. If no value is specified, it fetches the first page.

limitinteger

Maximum number of items per page. Defaults to 100. Maximum is 500

Response

OK

account_idinteger

Account ID

external_account_idstring

Custom account ID. Used as the key for all operations (manage accounts, transactions, etc.) on the corporate layer.

This field is:

  • Unique within the Organization
  • Immutable: The field cannot be updated.
  • Not recyclable: You can't reuse an external account ID, even if the account that was using it has been canceled.
currency_numeric_codestring

Account numeric currency code in ISO 4217 format. If not specified, it's inherited from the program.

currency_alphabetic_codestring

Account alphabetic currency code in ISO 4217 format. If not specified, it's inherited from the program.

Example response

{
  "account_id": 6912345,
  "external_account_id": "b993ba96-b3e8-4ef7-9cf7-7eee5ddafdab",
  "currency_numeric_code": "840",
  "currency_alphabetic_code": "USD",
  "balance_history": [
    {
      "future_dated_credits_balance": 70,
      "future_dated_debits_balance": 70,
      "ledger_balance": 270.35,
      "book_balance": 146.9,
      "available_balance": 123.45,
      "credit_balance": 123.45,
      "debit_balance": 123.45,
      "uncleared_funds": 123.45,
      "earmarked_balance": 123.45,
      "overdraft_limit": 123.45,
      "value_dated_balance": 123.45,
      "date": "2023-06-22",
      "business_date": "2023-03-09",
      "credit_movement": 70,
      "debit_movement": 70,
      "net_movement": 70
    }
  ],
  "pagination": {
    "next_cursor": 124,
    "has_next": true
  }
}