Sign in

v1

latestOpenAPI 3.1.0Copyright Pismo2026-07-247702,7523.1 MB
Average balance

Get average balance

Get an already calculated average balance for an account.

get/v1/accounts/{accountId}/average-balance

Path parameters

accountIdinteger required

Account ID

Headers

x-idempotency-keystring

A unique identifier to ensure the operation remains idempotent, allowing for operation repetition without causing unintended effects or duplication. An idempotent operation is one that can be applied multiple times, yet the outcome remains the same. it ensures that network errors, retries, or failures can occur without introducing inconsistencies. 36 chars max.

Response

Success

account_idnumber

Account ID.

begin_date_datetimestring date-time

The date and time when the calculation begins. The date and time are displayed in RFC 3339 format, for example: 2024-01-28T10:33:01Z.

end_date_datetimestring date-time

The date and time when the calculation ends. The date and time are displayed in RFC 3339 format, for example: 2024-01-29T10:33:01Z.

balance_types_to_calculatestring[]

Choose a balance to calculate its average balance, you can select multiple balance types to calculate their average balances simultaneously. The balance types are:<br>

  • available
  • savings
  • held_funds

Example response

{
  "account_id": 123456,
  "begin_date_datetime": "2024-01-28T10:33:01.000Z",
  "end_date_datetime": "2024-01-30T10:33:01.000Z",
  "balance_types_to_calculate": [
    "available",
    "savings",
    "held_funds"
  ]
}