Consultar Saldo

Consulte o saldo disponivel da sua conta antes de realizar transferencias.

GET/api/v2/accounts/balances

Retorna o saldo atual da conta, incluindo saldo disponivel e saldo bloqueado.

Base URL: https://pagamentos.basspago.com.br

Headers

Header	Valor	Descricao
`Authorization`	Bearer {access_token}	Token de acesso obtido via OAuth2

Parametros de Query

Nome	Tipo	Obrigatorio	Descricao
`event_date_start`	string	Obrigatorio	Data inicial do periodo de consulta (ISO 8601). Ex: 2026-04-01T00:00:00Z
`event_date_end`	string	Obrigatorio	Data final do periodo de consulta (ISO 8601). Ex: 2026-04-08T23:59:59Z
`page_offset`	integer	Opcional	Offset da pagina (minimo 1)
`page_limit`	integer	Opcional	Quantidade de registros por pagina (1-100, padrao 10)
`sort_by`	string	Opcional	Campo de ordenacao. Valor aceito: EVENT_DATE
`sort_type`	string	Opcional	Direcao da ordenacao: ASC ou DESC
`cut_edge_type`	string	Opcional	Tipo de corte de borda: BEGIN_OF_DAY ou END_OF_DAY

Exemplo de Response

{
  "data": [
    {
      "eventDate": "2026-04-08",
      "balanceAmount": {
        "currency": "BRL",
        "available": 150000.00,
        "blocked": 5000.00,
        "overdraft": 0.00
      }
    }
  ]
}

Exemplos de Codigo

curl -X GET \
  'https://pagamentos.basspago.com.br/api/v2/accounts/balances?event_date_start=2026-04-01T00:00:00Z&event_date_end=2026-04-08T23:59:59Z' \
  -H 'Authorization: Bearer {access_token}'