Average balance

Get average balance

Get an already calculated average balance for an account.

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

Request

Base URL
https://sandbox.pismolabs.io/savings-products
URL
https://sandbox.pismolabs.io/savings-products/v1/accounts/{accountId}/average-balance
Auth
HTTP bearer

Path parameters

accountIdstring required

Account ID. Accepts either the Pismo account_id or your external_account_id. Send the same ID used to generate the access token.

Headers

idempotencystring required

A unique identifier for the request. If you need to retry a request, use the same idempotency key to avoid creating duplicate resources.

Response

Success

account_idnumber

Account ID.

external_account_idstring

External account ID resolved from the account context. Returned when available, including while the calculation status is PROCESSING.

begin_date_datetimestring date-time

The date and time when the calculation begins, normalized to the beginning of the day (00:00:00) in the account's timezone and returned with that timezone offset. The date and time are displayed in RFC 3339 format, for example: 2024-01-28T00:00:00-03:00.

end_date_datetimestring date-time

The date and time when the calculation ends, normalized to the end of the day (23:59:59) in the account's timezone and returned with that timezone offset. The date and time are displayed in RFC 3339 format, for example: 2024-01-30T23:59:59-03:00.

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: [ "AVAILABLE", "SAVINGS", "HELD_FUNDS" ]

Example response

{
  "account_id": 123456,
  "external_account_id": "ext-acct-001",
  "begin_date_datetime": "2024-01-28T03:00:00.000Z",
  "end_date_datetime": "2024-01-31T02:59:59.000Z"
}

Changes

No recorded changes to this operation across all 1 revision of this API.