Consulte o saldo, a moeda e o valor das condições de pagamento da conta representada pelas suas credenciais da API. Esta operação é uma consulta de saldo; não adiciona fundos nem efetua um pedido.
Requisição
Use credenciais da API no lado do servidor através de HTTPS. Os exemplos leem as credenciais a partir de variáveis de ambiente; não contêm credenciais válidas para utilização. Verifique status.code no corpo JSON, bem como o código de estado HTTP. Estes processadores legados nem sempre definem um código de estado HTTP de erro quando ocorre um erro da aplicação.
curl --user "$MULTITEL_API_USER:$MULTITEL_API_PASSWORD" \
"https://api.multitel.net/v3/getbalance"Não são necessários parâmetros de caminho, de consulta ou do corpo da requisição.
Resposta
Esta estrutura de resposta é ilustrativa e não representa dados de uma conta nem uma cotação de preço atual.
{
"status": {
"code": 200,
"msg": ""
},
"response": {
"balance": "125.50",
"currency": "USD",
"terms": "prepaid"
}
}| Campo | Significado |
|---|---|
balance | O saldo armazenado da conta. Preserve a precisão decimal ao processar valores monetários. |
currency | O valor da moeda armazenado para esta conta. |
terms | O valor das condições de pagamento armazenado para a conta. O processador não o enumera nem normaliza; não presuma que o exemplo abrange todos os valores possíveis. |
Erros e utilização
Uma falha de autenticação utiliza a resposta de autenticação comum da API. Este processador não define um erro específico para saldo ausente nem paginação. Um saldo devolvido não constitui uma reserva de fundos e não garante que um pedido posterior seja bem-sucedido.