v1

latestOpenAPI 3.1.0Proprietary2026-07-24462215.9 KB
Balance

Get Balance

Retrieves balance details for the specified MID (merchant or sub-merchant). If MID is not provided, returns aggregated balances across all supported currencies and entities.

get/v3/balance

Query parameters

currencystring
Example:USD

Filter balance by specific currency code (optional)

datestring date
Example:2026-03-06

Balance date in YYYY-MM-DD (defaults to current date, cannot be future)

limitinteger
Example:5

Number of balance records per page

pageinteger
Example:1

Page number

Headers

MIDstring
Example:SABCDEF_SCT8YW_NA

Merchant ID (scopes balance to that org/sub-org)

Response

Balance information retrieved successfully

statusstring