Choose the Documentation MX Merchant MX Connect

Retrieve Aggregated Balance

Get a single, unified view of a customer's total available balance across all eligible Passport Accounts. Clearing (FBO) accounts are excluded.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
enum
required

Identifier type for the customer. Use id for the Passport-assigned reference ID or externalId for the program manager-assigned identifier.

Allowed:
string
required

Unique identifier of the customer whose aggregated balance is being retrieved.

Headers
string
enum
required

Controls response timing. Use NEVER for an immediate synchronous response or ALWAYS for asynchronous processing.

Allowed:
Responses

401

Authentication failed. Verify that the Authorization header contains a valid Bearer token.

403

The authenticated user does not have permission to perform this operation.

404

The requested customer was not found.

500

An unexpected error occurred on the server while processing the request.

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