Consulta saldo

Serviço destinado a consulta do saldo atual da conta

A partir deste serviço você terá acesso a detalhes sobre o saldo atual da conta, tipo de contrato, entre outros dados.

Fique atento quanto ao rate-limit de requisições para o correto funcionamento da API.

Para que evite-se requisições desnecessárias recomendamos o registro de um ou mais e-mails nas notificações de saldo no Portal Web. Dessa forma, logo que o saldo atingir o limite especificado por você, nós enviaremos um e-mail notificando sobre o evento.

Verificamos de hora em hora se o saldo atingiu o limite configurado e quando sim, enviaremos e-mails notificando até que o alerta seja desligado ou o saldo restabelecido acima do limite.

Minha conta > Configurações > Notificações

Adicionar o e-mail [email protected] e/ou domínio smsfire.com.br na lista de remetentes confiáveis em seu provedor de e-mail para evitar que as notificações caiam na caixa de spam.

Consulta simplificada

GET https://api-v2.smsfire.com.br/account/balance

Retorna um objeto JSON com os dados de saldo, limite, entre outros dados da conta

Headers

Name	Type	Description
Authorization	string	Basic <Token>

200 Objeto JSON

{
  "balance": 2.95554,
  "limit": 0,
  "currency": "BRL",
  "contract": "prepaid"
}

Exemplo de requisição

• Consulta única

GET - https://api-v2.smsfire.com.br/account/balance

Campos JSON do resultado

Campos	Tipo	Descrição
balance	float	Saldo atual disponível do usuário
limit	float	Limite de saldo negativo que a conta possuí
currency	string	Moeda referência dos valores demonstrados
contract	string	prepaid - Conta em regime pré-pago postpaid - Conta em regime pós-pago