Resources

This page provides information on API request fields and response balance types.

Balances request fields

Use the Balances resource to request a list of all eligible balances, or retrieve balances that match specific criteria.

The following parameters are required with a balances request.

Required API request fields:

Field	Description	Notes
cursor	For selecting a cursor when utilizing paging.	Universally Unique Identifier (UUID): a 36-character alphanumeric string that can be used to identify information.
pageSize	For pagination, this value represents the total number of results to return (maximum accounts).	The maximum accounts that can be returned in single API call is 100.  Where a value for pageSize is not provided, the default is 25 accounts.
Request-Id	Identifier provided by client to distinguish and track individual requests.	This identifier is returned in responses that include error cases as it can aid in problem diagnosis. It is recommended to use UUIDv4.

Response balance types

The "interim balance" is calculated on the basis of booked credit and debit items during the calculation time/period specified.

Potential balance type entries in a response:

Field	Description
Interim_available	Amount available to withdraw at the end of the provided date.
Interim_booked	Amount booked to the account at the end of the provided date.

Limitations and constraints

The following rules apply to requests for data using the Balances resource:

Supported account types	Blockchain Deposit Accounts (BDA)
Historical balances retrieval limit	Up to 45 days for BDA accounts
Date range limit	fromDate and toDate range can not exceed 45 days