API de Parcelamento

Pagar Débitos

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

Estrutura

Para realizar o pagamento dos débitos é utilizada a estrutura, conforme Tabela 01:

Tabela 01 - Pagar Débitos
Método POST
URL https://app.parcelamentodemultas.com.br
Recurso /api/v1/debts/pay
Endpoint https://app.parcelamentodemultas.com.br/api/v1/debts/pay

Request Body - JSON

Para realizar o pagamento dos débitos é preciso enviar o Request Body JSON, conforme exemplo:
(em seguida veja o que cada parâmetro significa). 

{
    "code": "1ed8c126-d00a-412a-9f8f-dd757b826c0b",
    "debts": [
        "15cb78220fb5424d904019722d4560e",
        "1d0305a658c745d899b752b5a91f1cb"
    ],
    "customer": {
        "name": "Paulo Fernandes",
        "document": "12345678909",
        "email": "email@asteroide.tech",
        "phone": "11999999999"
    },
    "url_callback": "https://docs.asteroidetecnologia.com.br/callback-url"
}
curl --location 'https://app.parcelamentodemultas.com.br/api/v1/debts/pay' \
--header 'asteroide-key: asteroide' \
--header 'asteroide-pass: asteroide-secret-@2024' \
--header 'Content-Type: application/json' \
--data-raw '{
    "code": "1ed8c126-d00a-412a-9f8f-dd757b826c0b",
    "debts": [
        "15cb78220fb5424d904019722d4560e",
        "1d0305a658c745d899b752b5a91f1cb"
    ],
    "customer": {
        "name": "Paulo Fernandes",
        "document": "12345678909",
        "email": "email@asteroide.tech",
        "phone": "11999999999"
    },
    "url_callback": "https://docs.asteroidetecnologia.com.br/callback-url"
}'

Parâmetros

Tabela 02 - Parâmetros Pagar Débitos
Parâmetro Padrão Descrição
code:String not null O código da transação da requisição de consulta dos débitos
debts:Array not null Array contendo os UUIDs da listagem dos débitos do request da Consulta Débitos
customer.name:String not null O nome do cliente
customer.document:String not null O documento do cliente (CPF ou CNPJ)
customer.email:String null O e-mail do cliente
customer.phone:String null O número do telefone do cliente
url_callback:String null URL para receber atualizações sobre o pagamento.

Retorno JSON - Sucesso

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

{
    "message": "Consulta retornada com sucesso",
    "http_status": 200,
    "body": {
        "code": "a02d6f1e-f181-4bcf-bfec-858caf23182b",
        "payment_code": "46d009f4-704f-4f30-8593-71da741f247f",
        "status": "pagamento criado",
        "balance": 33736.58
    }
}

Paramêtros do Retorno

Tabela 03 - Parâmetros de Retorno
Parâmetro Descrição
message:String Mensagem descritiva do resultado
http_status:integer Código de retorno da requisição
body.code:String Código da consulta que originou a transação de pagamento
body.payment_code:String Código do pagamento que será retornado e deve ser usado para recuperar o status e o comprovante de pagamento
body.status:String Status do pagamento
body.balance:float Valor do saldo atualizado após o pagamento

Retorno JSON - Erros

Caso a requisição tenha algum erro

{
    "message": "Código inválido",
    "http_status": 400,
    "body": {
        "errors": [
            "Código inválido"
        ]
    }
}