Payments API ReferenceMerchant

Get balances for all merchant accounts

Retrieves account balances for all bank accounts associated with a merchant, with optional filtering by currency and date.

Path parameters

merchantIdstringRequired
Merchant ID
organizationIdstringRequired
Organization ID

Headers

AuthorizationstringRequired

Bearer authentication of the form Bearer <token>, where token is your auth token.

Query parameters

currencyenumOptional

Filter balances by currency symbol (e.g. USD, ARS, CLP)

datedatetimeOptional
Date to get balances for. If not provided, returns the latest balances

Response

Get balances for all merchant accounts
idstring
accountNumberstring
The account number of the bank account
currencystring
The currency symbol of the account
balancestring
The current balance of the account
balanceDatedatetime
The date when the balance was requested. This could be the current date or a historical date if requesting past balances.
addressstring or null
The blockchain address for crypto accounts
networkstring or null
The blockchain network for crypto accounts
merchantIdstring or null
The merchant ID if this is a merchant account
contactIdstring or null
The contact ID if this is a contact account

Errors