Homologation Roadmap - Individual Debt Issuance - Precatório Advance
*: mandatory steps for production entry
1 - Registration and LaaS API Authentication
| Code | Step | Description | Documentation Link | Prerequisite |
|---|---|---|---|---|
| CAB0001* | Sandbox environment registration | Register on the QI Tech platform in the Sandbox environment (sandbox.qitech.app) | https://sandbox.qitech.com.br/register | |
| CAB0002* | Sandbox token validation | Validate the QI Token in Sandbox | Download Token Inclusion Manual | CAB0001 |
| CAB0003* | Public key exchange | Exchange public keys within the QI Tech platform in sandbox (sandbox.qitech.app) | Documentation Link | CAB0001 and CAB0002 |
| CAB0004* | API call authentication test | Complete API call authentication test | Step by Step Documentation Link | CAB0003 |
| CAB0005* | Webhook configuration | Configure the URL for webhook delivery from QI Tech through the QI Tech platform in sandbox (sandbox.qitech.app) | Documentation Link | CAB0001 and CAB0002 |
2- Debt Simulation
| Code | Step | Description | Link | Prerequisite |
|---|---|---|---|---|
| SID0001* | Debt simulation | Simulation of debt conditions, using previously determined variables | Documentation Link | Item 1 |
3 - Debt Issuance (Individual)
| Code | Step | Description | Link | Prerequisite |
|---|---|---|---|---|
| EMD0001* | Individual debt issuance | Individual CCB issuance. Composed of four main objects: borrower registration data (borrower object), operation financial data (financial object), banking data for payment (disbursement_bank_account) and assignee indication (purchaser_document_number) | Documentation Link | Items 1 and 2 |
| EMD0002* | Additional data implementation | Data for filling out the generated CCB | Payload aligned in parallel | Mandatory, if usage is defined. |
4 - Debt Formalization
| Code | Step | Description | Link | Prerequisite |
|---|---|---|---|---|
| FOR0001 | Debt formalization | CCB signature will be automatically triggered from QI SCD via QI Sign, after debt issuance | -- | Item 3 |
| FOR0002* | Signature completion webhook reading | Reading the asynchronous response of operation formalization. Webhook status signature_finished | Documentation Link | FOR0001 |
5 - Debt Disbursement
| Code | Step | Description | Link | Prerequisite |
|---|---|---|---|---|
| DES0001* | Disbursement date selection | After fulfilling all requirements for operation payment (document submission, signature and registration), a disbursement date must be chosen for the operation to be paid, within the disbursement range. | Documentation Link | Item 4 |
| DES0002* | Disbursement authorization | Payment release flag, prevents an operation from being disbursed without prior authorization | Documentation Link | DES0001 |
| DES0003* | Operation disbursement webhook reading | Reading the asynchronous response indicating successful operation payment. Webhook status: disbursed. Here we have the payment receipt in PDF. In addition to returning the identifying keys of installments and their respective bank slips | Documentation Link | DES0001 and DES0002 |
6 - Debt Installments
| Code | Step | Description | Link | Prerequisite |
|---|---|---|---|---|
| INS0001* | Installment webhook reading | Reading the asynchronous response indicating debt installment status updates. Here we have webhook_type: installment.status_change. Webhook status: opened, paid, waiting_payment, paid_early, paid_partial, overdue, paid_partial_overdue and paid_overdue. | Documentation Link | DES0002 |
7 - Debt Resubmission
| Code | Step | Description | Link | Prerequisite |
|---|---|---|---|---|
| PAG0001* | Disbursement date change/update | When an operation is canceled, updating the disbursement date makes the operation return to the status prior to cancellation. | Documentation Link | Item 5 |
| PAG0002 | Banking data change | Change of operation payment data, requiring an account with the same ownership as the borrower | Documentation Link | PAG0001. Mandatory, if retry exists |
8 - Operation Cancellation
| Code | Step | Description | Link | Prerequisite |
|---|---|---|---|---|
| CAN0002* | Permanent debt cancellation before disbursement | Allows definitive cancellation (final status) of debt before payment | Documentation Link | EMD0001 |
| CAN0003* | Cancellation webhook reading | Reading the asynchronous response of operation cancellation. Webhook status: canceled | Documentation Link | CAN0002 |
| CAN0004 | Debt cancellation within seven days after disbursement | Considering that the credit recipient can cancel the debt within 7 days of disbursement, it's possible for them to perform a chargeback on the received PIX or pay a return QR Code | Documentation Link | DES0002 |
9 - Debt Bank Slips
| Code | Step | Description | Link | Prerequisite |
|---|---|---|---|---|
| BKS0001 | Request duplicate bank slip | Duplicate bank slip issuance, through the bank slip identifier key (bank_slip_key), returned in the disbursement webhook | Documentation Link | DES0002 |
10 - Debt Renegotiation
| Code | Step | Description | Link | Prerequisite |
|---|---|---|---|---|
| REN0001 | Renegotiation simulation | Allows partial or total renegotiation simulation | Documentation Link | DES0002 |
| REN0002 | Create a renegotiation | Allows creation of partial or total renegotiation (generation of an advance bank slip for installment payments) | Documentation Link | DES0002 |
| REN0003 | Query a renegotiation | Check renegotiation conditions, affected installments, financial data, due date and payment type | Documentation Link | REN0002 |
| REN0004 | List Renegotiations | Check a listing of conditions for more than one renegotiation | Documentation Link | REN0002 |
| REN0005 | Cancel a renegotiation | Cancel a renegotiation | Documentation Link | REN0002 |
| REN0006 | Renegotiation payment | Renegotiation status update webhooks. Webhook_type: renegotiation.proposal | Documentation Link | REN0002 |
11 - Payments and Transfers
| Code | Step | Description | Link | Prerequisite |
|---|---|---|---|---|
| PGT0001 | Decode QR Code | Obtain payment data from the return QR Code, through the Pix Copy and Paste URI | Documentation Link | CAN0004 |
| PGT0002 | PIX QR Code Transfer | QR Code payment, through information obtained by QR Code decoding for debt cancellation | Documentation Link | PGT0001 |
| PGT0003 | PIX Transfer | Perform a PIX to the recipient from the escrow account | Documentation Link | DES0003 |
| PGT0004 | Account limit increase | Request PIX limit increase for escrow | Documentation Link | DES0003 |
| PGT0005 | TED Transfer | Perform a TED to the recipient from the escrow account | Documentation Link | DES0003 |