--- title: "Get transaction banking account balance" method: GET path: "/bank-statements/v1/account-balances/{externalAccountId}" tags: ["Bank statements"] --- # Get transaction banking account balance `GET /bank-statements/v1/account-balances/{externalAccountId}` Get balances associated with a specific account. These balances include available, credit, debit balance, and so on. ## Path parameters - `externalAccountId` string, required ## Response `200` OK - AccountBalanceResponse - `future_dated_credits_balance` number, 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.
The `future_dated_credits_balance` increases when future-dated credits are posted using the [Post payment](https://developers.pismo.io/pismo-docs/reference/corporate-v2-post-payments) endpoint, and decreases when those payments are settled or canceled. This balance is always a positive value.
`minimum`: `-9223372036854775807` `maximum`: `9223372036854775807` - `future_dated_debits_balance` number, 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.
The `future_dated_debits_balance` increases when future-dated debits are posted using the [Post payment](https://developers.pismo.io/pismo-docs/reference/corporate-v2-post-payments) endpoint, and decreases when these payments are settled or canceled. This balance is always a positive value.
`minimum`: `-9223372036854775807` `maximum`: `9223372036854775807` - `account_id` integer — Account ID - `external_account_id` string — 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_id` integer — Program ID. This is a client-provided ID. - `currency_numeric_code` string — Account numeric currency code in ISO 4217 format. If not specified, it's inherited from the program. - `currency_alphabetic_code` string — Account alphabetic currency code in ISO 4217 format. If not specified, it's inherited from the program. - `ledger_balance` number, float — Ledger balance.
Ledger balance is calculated as `book_balance` + `uncleared_funds`. `minimum: -9223372036854775807` `maximum: 9223372036854775807` - `book_balance` number, float — Book balance.
Book balance is calculated as `credit_balance` - `debit_balance` + `earmarked_balance`. `minimum: -9223372036854775807` `maximum: 9223372036854775807` - `available_balance` number, float — Available balance.
Available balance is calculated as `credit_balance` - `debit_balance` + `overdraft_limit`. `minimum: -9223372036854775807` `maximum: 9223372036854775807` - `credit_balance` number, float — Credit balance - `debit_balance` number, float — Debit balance - `uncleared_funds` number, float — Uncleared funds amount
`minimum: -9223372036854775807` `maximum: 9223372036854775807` - `uncleared_checks_balance` number, float — The total value of checks that have been posted to the account but have not yet cleared. `minimum: -9223372036854775807` `maximum: 9223372036854775807` - `restricted_funds` number, float — The portion of an account balance held under regulatory or operational restrictions and not available for transactions. `minimum`: 0 `maximum`: 9223372036854775807 - `legal_holds` number, 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_balance` number — 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.
`minimum: 0` `maximum: 18446744073709551617` - `overdraft_limit` number, float — Account overdraft limit
`minimum: 0` `maximum: 18446744073709551617` - `value_dated_balance` number, float — The value dated balance results from recalculating credit or debit balance based on the back value date. Defaults to the book balance.
The value dated balance is included in the following events: - [Account balance changed](https://developers.pismo.io/events/docs/account-balances-balance-change-1) - [Account balance history generated](https://developers.pismo.io/events/docs/account-balances-balance-history-1) - `held_funds` number, 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_balance` number, 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_accrued` number, 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 ## Other responses - `400` — Bad Request - `401` — Unauthorized - `403` — Forbidden - `404` — Not Found - `500` — Internal Server Error --- [API](https://skmtc.net/pismo/apis/platform-authentication.md) · [All operations](https://skmtc.net/pismo/apis/platform-authentication/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/pismo/platform-authentication/revisions/935b62e16de4/schema)