Documentação

Consultar o saldo

Devolve o saldo disponível para novos envios.

GET
/balance

Autenticação

apiKey
headerAuthorizationBearer <chave de API>

Chave de API no cabeçalho Authorization: Bearer cf_live_.... Crie e revogue chaves no painel, em Desenvolvedores > Chaves de API.

Corpo da resposta

O saldo.

application/json
  1. response

O saldo pré-pago da conta. Cada correspondência e cada verificação são debitadas do saldo quando criadas. A mensalidade do plano é cobrada à parte e não sai do saldo.

object*string

Tipo do objeto. Sempre balance.

currency*string

Moeda dos valores. Sempre BRL (real brasileiro).

available*integer

Valor disponível para novos envios agora. Em centavos: 1590 são R$ 15,90.

pending*integer

Reservado para recargas que dependem da confirmação de um pagamento; entram em available quando o pagamento é confirmado. Hoje o saldo é adicionado na hora, então é sempre 0. Em centavos: 1590 são R$ 15,90.

curl "https://api.cartaflow.com.br/v1/balance" \  -H "Authorization: Bearer $CARTAFLOW_API_KEY"
{  "object": "balance",  "currency": "BRL",  "available": 48865,  "pending": 0}