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.

Authentication

AuthorizationBearer

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

Path parameters

merchantIdstringRequired
Merchant ID
organizationIdstringRequired
Organization ID

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
The blockchain address for crypto accounts
networkstring
The blockchain network for crypto accounts
merchantIdstring
The merchant ID if this is a merchant account
contactIdstring
The contact ID if this is a contact account

Errors

400
Get Bank Account Balances Request Bad Request Error
401
Get Bank Account Balances Request Unauthorized Error
403
Get Bank Account Balances Request Forbidden Error
404
Get Bank Account Balances Request Not Found Error
422
Get Bank Account Balances Request Unprocessable Entity Error
500
Get Bank Account Balances Request Internal Server Error