API de Parcelamento

Consultar Saldo

Antes de prosseguir, certifique-se que leu todos os tópicos seção Primeiros Passos.

Estrutura

Para consultar o saldo da sua conta é utilizada a estrutura, conforme Tabela 01:

Tabela 01 - Consultar Saldo
Método GET
URL https://app.parcelamentodemultas.com.br
Recurso /api/v1/balance
Endpoint https://app.parcelamentodemultas.com.br/api/v1/balance

Request URL

Para consultar o saldo da sua conta é preciso enviar o Request com a seguinte URL, conforme exemplo:
(em seguida veja o que cada parâmetro significa).

https://app.parcelamentodemultas.com.br/api/v1/balance
                    
curl --location 'https://app.parcelamentodemultas.com.br/api/v1/balance' \
            --header 'asteroide-key: asteroide' \
            --header 'asteroide-pass: asteroide-secret-@2024'
                    

Retorno JSON

No caso de sucesso você deverá ver algo como:

{
    "message": "Consulta retornada com sucesso",
    "http_status": 200,
    "body": {
        "balance": 50000.01
    }
}