1. Balance
GatewayV4-API
  • Gateway - API
    • Contacts
      • List
    • Routes
      • Routes
    • Reports
      • Received Messages Report
      • Sent Messages Report
      • Messages Requests Report
      • Cancel Messages Request
    • RCS
      • Send RCS (File) Message
      • Send RCS (Carrossel) Message
      • Send RCS (Card) Message
      • Send RCS (Basic) Message
    • SMS
      • Send SMS Message
    • Balance
      • GetBalance
        GET
    • Schemas
      • Core
        • CoreResult
      • Contacts
        • Contact
      • Routes
        • Routes
      • Reports
        • Received
        • Sent
        • MessageRequestsReportResult
        • CancelMessagesRequestInput
      • RCS
        • Send RCS File
        • Send RCS Basic
        • Send RCS carousel
        • Send RCS card
      • SMS
        • Send Sms
      • Balance
        • BalanceResult
  • Default module
    • Raiz
  1. Balance

GetBalance

GET
/balance

📘 Endpoint: Consultar saldo da conta#

Método: GET
URL: /balance
Autenticação: Chave de API (via header x-api-key)
Permissões: Disponível para clientes com chave de API válida e IP autorizado
Este endpoint permite consultar o saldo atual da conta vinculada à chave de API utilizada na requisição. Ele é indicado para integrações que precisam validar disponibilidade de créditos antes de realizar envios de mensagens, disparar alertas internos ou exibir informações financeiras em painéis e sistemas próprios.
A resposta considera o contexto da conta autenticada e retorna o valor de saldo disponível no momento da consulta.

Request

Authorization
Add parameter in header
x-api-key
Example:
x-api-key: ********************
Header Params

Responses

🟢200Success
application/json
Body

🟠401
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request GET 'https://api.comtele.com.br/balance' \
--header 'x-api-key: <api-key>' \
--header 'Content-Type: application/json'
Response Response Example
200 - Example 1
{
    "hasError": true,
    "message": "string",
    "totalRecords": 0,
    "errors": [
        "string"
    ],
    "object": {
        "balance": 0
    }
}
Modified at 2026-03-16 19:06:54
Previous
Send SMS Message
Next
CoreResult
Built with