Consultar saldos

Retorna os saldos disponíveis para saque por tipo de transação

Operação em subconta: Para buscar os saldos disponíveis de uma subconta, inclua o header x-subaccount-id com o ID da subconta. Quando este header é fornecido, a operação será realizada no contexto da subconta especificada, em vez da conta principal autenticada.

GET /withdrawals/balance

cURL

cURL

curl --request GET \
  --url https://sandbox-api.superpagamentos.com/withdrawals/balance \
  --header 'Authorization: Bearer <token>'

200

{
  "data": {
    "disponiblePixBalance": 123,
    "disponibleCardBalance": 123,
    "disponibleBilletBalance": 123,
    "withdrawalsInProcessingBalance": 123
  },
  "message": "Saldos bancários"
}

Authorizations

Authorization · string · header · required

Token JWT gerado na rota de autenticação (/auth). Deve ser enviado no formato: Bearer

Headers

x-subaccount-id · string<uuid>

ID da subconta onde a operação será realizada. Quando fornecido, a operação será executada no contexto desta subconta específica.

Response

200 - application/json

Saldos consultados com sucesso

data · object

Show child attributes

message · string

Example:

"Saldos bancários"