Saldo da carteira: referência da API

Saldo da carteira

Consulte o saldo da carteira no ambiente da sua chave, de teste ou de produção, e o valor reservado em envios em andamento, para alarmar antes de faltar.

1 operação

URL basehttps://api.messages.ccxcompany.co

AutenticaçãoBearer com a sua chave de API

O texto técnico abaixo vem do contrato público, o openapi.json, no idioma em que o contrato foi escrito.

Saldo da carteira de coins

GET/wallet

Saldo da carteira no ambiente da credencial. Uma chave ccx_test_* lê a carteira de sandbox; ccx_live_* lê a de produção.

balanceCoins é o saldo bruto e reservedCoins é o que está preso em envios em voo. O que paga o próximo envio é a diferença — é balanceCoins - reservedCoins que você deve alarmar, não balanceCoins.

1 coin = R$ 0,0001. lowBalanceThresholdCoins é o piso configurado na organização: abaixo dele a CCX dispara o alerta de saldo baixo (wallet.low_balance).

Permissão: billing:read.

Respostas

200Default Response

Campos e exemplo da resposta

Campo	Tipo	Descrição
`env`obrigatório	`string`	Valores:`livetest`
`balanceCoins`obrigatório	`integer`	Saldo bruto, em coins (1 coin = R$ 0,0001). NEGATIVO quando o crédito contratado está em uso.
`reservedCoins`obrigatório	`integer`	Preso em envios em voo.
`usableCoins`obrigatório	`integer`	`balanceCoins - reservedCoins`. O saldo próprio, sem contar crédito.
`currency`obrigatório	`string`
`lowBalanceThresholdCoins`obrigatório	`integer`	Piso que dispara `wallet.low_balance`. `0` ⇒ a CCX usa o default da plataforma.
`overdraftLimitCoins`obrigatório	`integer`	Crédito contratado que o envio pode consumir abaixo de zero. `0` ⇒ sem crédito.
`sendableCoins`obrigatório	`integer`	`usableCoins + overdraftLimitCoins`. É o que de fato paga o próximo envio — alarme neste.

JSON

{  "env": "live",  "balanceCoins": 0,  "reservedCoins": 0,  "usableCoins": 0,  "currency": "string",  "lowBalanceThresholdCoins": 0,  "overdraftLimitCoins": 0,  "sendableCoins": 0}

401RFC 7807 problem details for UNAUTHORIZED (401).
403RFC 7807 problem details for FORBIDDEN (403).

As respostas de erro seguem o formato RFC 7807 (application/problem+json), com um código estável no campo code. Ver os códigos de erro

Exemplo em curl

cURL

curl 'https://api.messages.ccxcompany.co/wallet' \  -H "Authorization: Bearer $CCX_API_KEY"

Só os campos obrigatórios. Troque os valores de exemplo pelos seus.

Saldo da carteira

Saldo da carteira de coins

Respostas

Exemplo em curl

Outras áreas da API

Travou em alguma rota? Fale com quem mantém a API.