Balance

The Balance API returns your available funds across all configured payment providers and currencies. Use it for pre-payment validation, reconciliation, and monitoring.

Endpoint

GET https://{FQDN}/payer/balance

Headers:

Header	Value
`Authorization`	`Bearer {accessToken}`

No request body or query parameters required.

Example Request

curl -X GET https://{FQDN}/payer/balance \
  -H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIs...'

Response (200)

The response is an array of provider balance objects, each containing balances per currency.

[
  {
    "providerId": "provider-us-card",
    "balances": [
      {
        "currencyCode": "USD",
        "balance": 125430.50
      }
    ]
  },
  {
    "providerId": "provider-br-pix",
    "balances": [
      {
        "currencyCode": "BRL",
        "balance": 84200.00
      },
      {
        "currencyCode": "USD",
        "balance": 15000.00
      }
    ]
  }
]

Response Fields

Field	Type	Description
`providerId`	string	Payment provider identifier
`balances`	array	Array of currency balances for this provider
`balances[].currencyCode`	string	ISO 4217 currency code
`balances[].balance`	number	Available balance in the given currency

What's Next

Push Transaction — Send payouts to recipients
Wallets — Manage wallet balances and transactions