Consultar saldo de um Cliente
Endereço de Chamada da API
/api/getCustomerBalance/API_TOKEN/API_KEY(/id_cliente)
Este Ponto de Acesso possibilita a consulta do saldo de um cliente. Ao empregar o Token de Acesso, é possível incluir o ID do cliente como último parâmetro na URL, permitindo a obtenção do saldo de um cliente específico por meio dessa identificação.
Para nosso exemplo, iremos deduzir que o endereço do servidor será sip.nextbilling.com.br. Nesse caso, o endereço da API seria:
Endereço da API exemplo
https://sip.nextbilling.com.br/api/getCustomerBalance/API_TOKEN/API_KEY(/id_cliente)
A chamada para obter os dados da consulta, é realizado utilizando um HTTP GET para o endereço de consumo da API. Um exemplo de chamada a essa API seria:
$ curl -X GET 'https://sip.nextbilling.com.br/api/getCustomerBalance/API_TOKEN/API_KEY/3'
Utilizando essa chamada, você obteria o retorno em JSON semelhante a saída a seguir:
Retorno JSON
{
"error":0,
"reason":"OK",
"usable_balance": "177,90",
"tipo_tar": 0,
"customer_balance": "77,90",
"customer_limit": "100,00",
}