Retrieve the balance
Returns the balance available for new mailings.
apiKeyAuthorizationBearer <token>API key in the Authorization: Bearer cf_live_... header. Create and revoke keys in the dashboard, under Desenvolvedores > Chaves de API (Developers > API keys).
The balance.
application/json- response
The account’s prepaid balance. Each letter and each verification is debited from the balance when created. The plan’s monthly fee is billed separately and does not come out of the balance.
object*stringObject type. Always balance.
currency*stringCurrency of the amounts. Always BRL (Brazilian real).
available*integerAmount available for new mailings right now. In centavos (1/100 of a real): 1590 is R$ 15.90.
pending*integerReserved for top-ups that depend on a payment being confirmed; they move to available once it is. Today balance is added at once, so it is always 0. In centavos (1/100 of a real): 1590 is 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}