Sign in

v1

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

Get transaction banking account balance

Get balances associated with a specific account. These balances include available, credit, debit balance, and so on.

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

Path parameters

externalAccountIdstring required

External account ID

Response

OK

future_dated_credits_balancenumber required

Represents the account balance scheduled to be settled on a future date, after the original posting date. The account's book_balance is credited when the settlement occurs.<br> The future_dated_credits_balance increases when future-dated credits are posted using the Post payment endpoint, and decreases when those payments are settled or canceled. This balance is always a positive value.<br> minimum: -9223372036854775807 maximum: 9223372036854775807

future_dated_debits_balancenumber required

Represents the account balance scheduled to be settled on a future date, after the initial posting date. The account’s book_balance is debited when the settlement occurs.<br> The future_dated_debits_balance increases when future-dated debits are posted using the Post payment endpoint, and decreases when these payments are settled or canceled. This balance is always a positive value.<br> minimum: -9223372036854775807 maximum: 9223372036854775807

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.
program_idinteger

Program ID. This is a client-provided ID.

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.

ledger_balancenumber float

Ledger balance.<br> Ledger balance is calculated as book_balance + uncleared_funds. minimum: -9223372036854775807 maximum: 9223372036854775807

book_balancenumber float

Book balance.<br> Book balance is calculated as credit_balance - debit_balance + earmarked_balance. minimum: -9223372036854775807 maximum: 9223372036854775807

available_balancenumber float

Available balance.<br> Available balance is calculated as credit_balance - debit_balance + overdraft_limit. minimum: -9223372036854775807 maximum: 9223372036854775807

credit_balancenumber float

Credit balance

debit_balancenumber float

Debit balance

uncleared_fundsnumber float

Uncleared funds amount<br> minimum: -9223372036854775807 maximum: 9223372036854775807

uncleared_checks_balancenumber float

The total value of checks that have been posted to the account but have not yet cleared. minimum: -9223372036854775807 maximum: 9223372036854775807

restricted_fundsnumber float

The portion of an account balance held under regulatory or operational restrictions and not available for transactions. minimum: 0 maximum: 9223372036854775807

legal_holdsnumber float

The portion of an account balance held under legal holds (such as court-ordered restrictions) and unavailable for transactions. minimum: 0 maximum: 9223372036854775807

earmarked_balancenumber

Earmark balance. Initially equal to the earmarked amount and decreases as the reserved funds are used up or decreased in a decrease operation. It can also increase if an increase operation is performed.<br> minimum: 0 maximum: 18446744073709551617

overdraft_limitnumber float

Account overdraft limit<br> minimum: 0 maximum: 18446744073709551617

value_dated_balancenumber float

The value dated balance results from recalculating credit or debit balance based on the back value date. Defaults to the book balance.<br> The value dated balance is included in the following events:

held_fundsnumber float

Funds that are temporarily restricted due to regulatory or operational requirements, unavailable for transactions, and representing the total amount of earmarked or otherwise restricted balances. minimum: 0 maximum: 9223372036854775807

held_checks_balancenumber float

The balance from checks that the bank considers available but holds to earn interest. It increases when check holds are applied and decreases when those holds are released or canceled. minimum: 0 maximum: 9223372036854775807

remunerative_interest_accruednumber float

This balance reflects the total interest pending capitalization. It increases as interest accrues and decreases when the accrued interest is added to the principal balance. minimum: 0 maximum: 9223372036854775807

Example response

{
  "future_dated_credits_balance": 70,
  "future_dated_debits_balance": 70,
  "account_id": 6912345,
  "external_account_id": "b993ba96-b3e8-4ef7-9cf7-7eee5ddafdab",
  "program_id": 2222,
  "currency_numeric_code": "840",
  "currency_alphabetic_code": "USD",
  "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
}