Saldo de la cartera: referencia de la API

Saldo de la cartera

Consulta el saldo de la cartera en el entorno de tu clave, de prueba o de producción, y lo reservado en envíos en curso, para avisar antes de quedarte sin él.

1 operación

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

AutenticaciónBearer con tu clave de API

El texto técnico de abajo viene del contrato público, openapi.json, en el idioma en que se escribió el contrato.

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.

Respuestas

200Default Response

Campos y ejemplo de la respuesta

Campo	Tipo	Descripción
`env`obligatorio	`string`	Valores:`livetest`
`balanceCoins`obligatorio	`integer`	Saldo bruto, em coins (1 coin = R$ 0,0001). NEGATIVO quando o crédito contratado está em uso.
`reservedCoins`obligatorio	`integer`	Preso em envios em voo.
`usableCoins`obligatorio	`integer`	`balanceCoins - reservedCoins`. O saldo próprio, sem contar crédito.
`currency`obligatorio	`string`
`lowBalanceThresholdCoins`obligatorio	`integer`	Piso que dispara `wallet.low_balance`. `0` ⇒ a CCX usa o default da plataforma.
`overdraftLimitCoins`obligatorio	`integer`	Crédito contratado que o envio pode consumir abaixo de zero. `0` ⇒ sem crédito.
`sendableCoins`obligatorio	`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).

Las respuestas de error siguen el formato RFC 7807 (application/problem+json), con un código estable en el campo code. Ver los códigos de error

Ejemplo en curl

cURL

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

Solo los campos obligatorios. Cambia los valores de ejemplo por los tuyos.

Saldo de la cartera

Saldo da carteira de coins

Respuestas

Ejemplo en curl

Otras áreas de la API

¿Atascado en una ruta? Habla con quienes mantienen la API.