Balance

La API de Balance devuelve sus fondos disponibles en todos los proveedores de pago y monedas configurados. Úsela para validación previa al pago, conciliación y monitoreo.

Endpoint

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

Headers:

Header	Valor
`Authorization`	`Bearer {accessToken}`

No se requiere cuerpo de solicitud ni parámetros de consulta.

Ejemplo de Solicitud

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

Respuesta (200)

La respuesta es un arreglo de objetos de saldo por proveedor, cada uno con los saldos por moneda.

[
  {
    "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
      }
    ]
  }
]

Campos de la Respuesta

Campo	Tipo	Descripción
`providerId`	string	Identificador del proveedor de pago
`balances`	array	Arreglo de saldos por moneda para este proveedor
`balances[].currencyCode`	string	Código de moneda ISO 4217
`balances[].balance`	number	Saldo disponible en la moneda indicada

Qué Sigue

Transacción Push — Envíe payouts a destinatarios
Wallets — Administre saldos y transacciones de billeteras