APIs
Sub-processorsAbout PismoContact us
Start typing to search…

Calculate average balance

post
https://sandbox.pismolabs.io/savings-products/v1/accounts//average-balance

Calculates an average balance for an account.
Using this endpoint, you can specify a datetime range and calculate the average balance of an account over that period. This involves multiplying the balance by the number of days it has remained unchanged, summing the results, and then dividing them by the total number of days in the specified period.

Path Params
integer
required

Account ID.

Body Params
number

Account identifier.

date-time

The specified datetime when the average balance calculation begins. The datetime is displayed in the RFC 3339 format; for example: 2024-01-28T10:33:01Z.

date-time

The specified datetime when the average balance calculation ends. The datetime is displayed in the RFC 3339 format; for example: 2024-01-29T10:33:01Z.

balance_types_to_calculate
array of strings

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

  • available
  • savings
  • held_funds
balance_types_to_calculate
Headers
string
required

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

Responses

Updated 16 days ago

Language
Credentials
Bearer
JWT
Response 
Click Try It! to start a request and see the response here! Or choose an example:
application/json
Updated 16 days ago