API de Parcelamento

Consultar Comprovante de Pagamento

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

Estrutura

Para consultar os comprovantes de um pagamento na sua conta é utilizada a estrutura, conforme Tabela 01:

Tabela 01 - Confirmar Recarga
Método GET
URL https://app.parcelamentodemultas.com.br
Recurso /api/v1/documents
Endpoint https://app.parcelamentodemultas.com.br/api/v1/documents?{params}

Request URL

Para consultar os comprovantes de 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/documents?payment_code=46d009f4-704f-4f30-8593-71da741f247f
                    
curl --location 'https://app.parcelamentodemultas.com.br/api/v1/documents?payment_code=46d009f4-704f-4f30-8593-71da741f247f' \
--header 'asteroide-key: asteroide' \
--header 'asteroide-pass: asteroide-secret-@2024'

Parâmetros

Tabela 02 - Parâmetros Consulta de Comprovante de Pagamento
Parâmetro Padrão Descrição
payment_code:String not null Identificador do Pagamento realizado no endpoint de Realizar Pagamento

Retorno JSON quando existir comprovante

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

{
    "message": "Comprovante recuperado",
    "http_status": 200,
    "body": {
        "arquivos": [
            "https://ast-comprovantes.s3.amazonaws.com/2023/08/05/46d009f4-704f-4f30-71da741f247f-1.pdf",
            "https://ast-comprovantes.s3.amazonaws.com/2023/08/07/46d009f4-704f-4f30-8593-82.pdf"
        ],
        "message": "Comprovante recuperado"
    }
}

Retorno JSON quando não existir comprovante

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

{
    "message": "Comprovante indisponível",
    "http_status": 200,
    "body": {
        "arquivos": [],
        "message": "Comprovante indisponível"
    }
}