Balance

A API de Balance retorna seus fundos disponíveis em todos os provedores de pagamento e moedas configurados. Use-a para validação pré-pagamento, reconciliação e monitoramento.

Endpoint

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

Headers:

Header	Valor
`Authorization`	`Bearer {accessToken}`

Nenhum corpo de requisição ou parâmetro de query é necessário.

Exemplo de Requisição

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

Resposta (200)

A resposta é um array de objetos de saldo por provedor, cada um contendo saldos por moeda.

[
  {
    "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 da Resposta

Campo	Tipo	Descrição
`providerId`	string	Identificador do provedor de pagamento
`balances`	array	Array de saldos por moeda para este provedor
`balances[].currencyCode`	string	Código de moeda ISO 4217
`balances[].balance`	number	Saldo disponível na moeda indicada

Próximos Passos

Push Transaction — Envie payouts para destinatários
Wallets — Gerencie saldos e transações de carteiras