API de Parcelamento
Consultar Status de Pagamento
Antes de prosseguir, certifique-se que leu todos os tópicos seção Primeiros Passos.
Estrutura
Para consultar o status de um pagamento na sua conta é utilizada a estrutura, conforme Tabela 01:
Método |
GET |
---|---|
URL |
https://app.parcelamentodemultas.com.br
|
Recurso |
/api/v1/status |
Endpoint |
https://app.parcelamentodemultas.com.br/api/v1/status?{params}
|
Request URL
Para consultar o status de um pagamento na 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/status?payment_code=46d009f4-704f-4f30-8593-71da741f247f
curl --location 'https://app.parcelamentodemultas.com.br/api/v1/status?payment_code=46d009f4-704f-4f30-8593-71da741f247f' \ --header 'asteroide-key: asteroide' \ --header 'asteroide-pass: asteroide-secret-@2024'
Parâmetros
Parâmetro | Padrão | Descrição |
---|---|---|
payment_code:String |
not null | Identificador do Pagamento realizado no endpoint de Realizar Pagamento |
Retorno JSON
No caso de sucesso você deverá ver algo como:
{ "message": "Confira o status do pagamento", "http_status": 200, "body": { "message": "Confira o status do pagamento", "status": "em processo de pagamento" } }