Financeiro

Consultar saldo

GET/v1/balancebalance:read

Cabeçalhos

Authorizationstringobrigatório

Bearer seguido da sua chave: gw_test_ em teste, gw_live_ em produção.

Resposta 200

Saldo derivado do livro-caixa

currency"BRL"

pending_centsinteger

Valor inteiro assinado em centavos.

blocked_centsinteger

Valor inteiro assinado em centavos.

exemplo 4990 = R$ 49,90

reserved_centsinteger

Valor inteiro assinado em centavos.

exemplo 150150 = R$ 1.501,50

med_reserved_centsinteger

Valor inteiro assinado em centavos.

withdrawal_reserved_centsinteger

Valor inteiro assinado em centavos.

exemplo 150150 = R$ 1.501,50

scheduled_med_reserve_centsinteger

Valor inteiro assinado em centavos.

unclassified_centsinteger

Valor inteiro assinado em centavos.

available_centsinteger

Valor inteiro assinado em centavos.

exemplo 1284100 = R$ 12.841,00

available_hold_centsinteger

Valor inteiro assinado em centavos.

withdrawable_centsinteger

Valor inteiro assinado em centavos.

exemplo 1284100 = R$ 12.841,00

availability_status"ACTIVE"

Códigos de resposta

HTTP	Quando acontece
200	Saldo derivado do livro-caixa
401	Chave ausente, inválida ou sem o escopo exigido
429	Limite de requisições excedido

Cada código de erro está explicado em Erros.

Requisição

curl -X GET "https://api.mainumpay.com/v1/balance" \
  -H "Authorization: Bearer $MAINUM_API_KEY"

Resposta

{
  "currency": "BRL",
  "pending_cents": 0,
  "blocked_cents": 4990,
  "reserved_cents": 150150,
  "med_reserved_cents": 0,
  "withdrawal_reserved_cents": 150150,
  "scheduled_med_reserve_cents": 0,
  "unclassified_cents": 0,
  "available_cents": 1284100,
  "available_hold_cents": 0,
  "withdrawable_cents": 1284100,
  "availability_status": "ACTIVE",
  "request_id": "req_0192a7c4-5b20-7c11-8e4f-2b9d0c6a3e58"
}

Saldo derivado do livro-caixa