Pular para o conteúdo
Pagamentos

Consultar saldo

v1.0.0
GEThttps://api.staging.growthaisystem.com/api/v1/balance
  • ExigeAuthorization: Bearer gos_…— Chave de API (gos_…)· escopospayments.read

Lê o saldo disponível e o pendente do recebedor deste workspace. Não movimenta dinheiro.

Respostas

5 respostas documentadas — o código, o que ele significa nesta rota e a forma do corpo.

200Deu certoapplication/json

Saldo do recebedor no provedor, em centavos. Provedor indisponível (ou recebedor sem conta ativa): unavailable: true e valores null — nunca zero inventado.

V1Balance

  • availableinteger | null
  • pendinginteger | null
  • currency"BRL"
    • sempre "BRL"
  • fetchedAtstring
  • unavailableboolean