Retrieve merchant outstanding balances

Returns the current outstanding balance for one or more merchants.

Provide exactly one of customer_id or application_id — not both.

Authentication:

Use API Key authentication via the X-API-Key header. Results are always scoped to your own brokerId — a customer or application belonging to a different broker is returned as not_found.

Multiple values:

You can request balances for multiple merchants in a single call by providing comma-separated IDs (e.g. id1,id2,id3).

If an ID is not found, that entry is still returned in the response with an Error field set to not_found — other IDs in the same request are unaffected.


📘

Null fields are omitted from the response. If a field is absent, treat it as null.


Query Params
string

One or more customer IDs. Comma-separated for multiple (e.g. uuid1,uuid2). Mutually exclusive with application_id.

string

One or more application GUIDs. Comma-separated for multiple (e.g. guid1,guid2). Mutually exclusive with customer_id.

Headers
string
required

Your API key for authentication.

Responses

400

Bad request. Exactly one of customer_id or application_id must be provided.

401

Missing or invalid API key.

403

API key does not have access to this resource.

500

Internal server error. Please contact support if the issue persists.

Language
Credentials
Header
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json