Estorno BNPL

Resumo

O estorno de uma operação BNPL permite reverter o desembolso realizado. Existem dois cenários de cancelamento/estorno:

1. Cancelamento antes do desembolso: Cancela a operação antes que os recursos sejam transferidos
2. Estorno após o desembolso (até 7 dias): Gera um Pix de devolução para que o tomador retorne os recursos

---

1. Cancelamento Antes do Desembolso

Cancela uma operação de crédito que ainda não foi desembolsada.

Request

ENDPOINT

/debt/DEBT-KEY/cancel

MÉTODO

PATCH

Testar no Playground

Path Params

Campo	Tipo	Descrição	Caracteres
debt_key*	string	Chave única da dívida retornada no momento da criação da operação de crédito	UUID

Response

STATUS

200

Response Body

{
    "data": [
        {
            "borrower": {
                "document_number": "68394265057",
                "name": "Xuxa Meneguel"
            },
            "contract_fee_amount": 5.56,
            "installments": [
                {
                    "bank_slip_key": null,
                    "calendar_days": 57,
                    "due_date": "2020-09-30",
                    "due_principal": -0.00217819,
                    "fine_amount": null,
                    "has_interest": true,
                    "installment_key": "28eb5907-ed25-4a86-bb9d-b6dc944f13df",
                    "installment_number": 1,
                    "installment_status": "opened",
                    "installment_type": "principal",
                    "paid_amount": 0,
                    "post_fixed_amount": 0,
                    "pre_fixed_amount": 268.75782181,
                    "principal_amortization_amount": 1111.9,
                    "tax_amount": 0,
                    "total_amount": 1380.66,
                    "workdays": 40
                }
            ],
            "operation_key": "7986dcc7-4331-478f-af47-adfbdf7f4a36",
            "status": "opened"
        }
    ],
    "pagination": {
        "current_page": 1,
        "next_page": null,
        "rows_per_page": 100,
        "total_pages": 1,
        "total_rows": 55
    }
}

Atenção

Este endpoint só pode ser utilizado para operações que ainda não foram desembolsadas. Para operações já desembolsadas, utilize o endpoint de estorno abaixo.

---

2. Estorno Após o Desembolso (Até 7 Dias)

Realiza o estorno de uma operação BNPL já desembolsada, dentro do prazo de 7 dias corridos após o desembolso. O sistema gera um Pix copia-e-cola para que o tomador devolva os recursos.

Request

ENDPOINT

/debt/reversal

MÉTODO

POST

Testar no Playground

Request Body

{
    "contract_number": "0000049343/TW"
}

Body Params

Campo	Tipo	Descrição	Caracteres
contract_number*	string	Número do contrato da CCB	-

Response

STATUS

200

Response Body

{
    "amount": "2026.93",
    "copy_paste_pix": "00020126930014br.gov.bcb.pix2571qrcode-h.dev.qitech.app/bacen/cobv/dece8d3e-32ce-439e-8204000053039865802BR5925Joao61080150400062070503***63046ECD",
    "expiration_date": "2022-09-28",
    "payer_document_number": "000000000008",
    "payer_name": "Teste",
    "reversal_key": "f98a1b7c-5e3c-4e6f-8887-c7fedfa0d5b5",
    "status": "waiting_payment"
}

Detalhes do Response

Campo	Tipo	Descrição
amount	string	Valor total a ser devolvido
copy_paste_pix	string	Código Pix copia-e-cola para devolução dos recursos
expiration_date	string	Data de expiração do Pix de devolução
payer_document_number	string	CPF/CNPJ do tomador
payer_name	string	Nome do tomador
reversal_key	string	Chave única do estorno
status	string	Status do estorno: waiting_payment

Importante

• O estorno só pode ser realizado dentro de 7 dias corridos após o desembolso
• O copy_paste_pix gerado possui uma data de expiração. Após essa data, o Pix não poderá mais ser utilizado
• Após o pagamento do Pix pelo tomador, a operação será cancelada automaticamente e você receberá um webhook de cancelamento