Skip to main content

Homologation Roadmap - Individual Debt Issuance - Precatório Advance

*: mandatory steps for production entry

1 - Registration and LaaS API Authentication

CodeStepDescriptionDocumentation LinkPrerequisite
CAB0001*Sandbox environment registrationRegister on the QI Tech platform in the Sandbox environment (sandbox.qitech.app)https://sandbox.qitech.com.br/register
CAB0002*Sandbox token validationValidate the QI Token in SandboxDownload Token Inclusion ManualCAB0001
CAB0003*Public key exchangeExchange public keys within the QI Tech platform in sandbox (sandbox.qitech.app)Documentation LinkCAB0001 and CAB0002
CAB0004*API call authentication testComplete API call authentication testStep by Step

Documentation Link
CAB0003
CAB0005*Webhook configurationConfigure the URL for webhook delivery from QI Tech through the QI Tech platform in sandbox (sandbox.qitech.app)Documentation LinkCAB0001 and CAB0002

2- Debt Simulation

CodeStepDescriptionLinkPrerequisite
SID0001*Debt simulationSimulation of debt conditions, using previously determined variablesDocumentation LinkItem 1

3 - Debt Issuance (Individual)

CodeStepDescriptionLinkPrerequisite
EMD0001*Individual debt issuanceIndividual 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 LinkItems 1 and 2
EMD0002*Additional data implementationData for filling out the generated CCBPayload aligned in parallelMandatory, if usage is defined.

4 - Debt Formalization

CodeStepDescriptionLinkPrerequisite
FOR0001Debt formalizationCCB signature will be automatically triggered from QI SCD via QI Sign, after debt issuance--Item 3
FOR0002*Signature completion webhook readingReading the asynchronous response of operation formalization. Webhook status signature_finishedDocumentation LinkFOR0001

5 - Debt Disbursement

CodeStepDescriptionLinkPrerequisite
DES0001*Disbursement date selectionAfter 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 LinkItem 4
DES0002*Disbursement authorizationPayment release flag, prevents an operation from being disbursed without prior authorizationDocumentation LinkDES0001
DES0003*Operation disbursement webhook readingReading 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 slipsDocumentation LinkDES0001 and DES0002

6 - Debt Installments

CodeStepDescriptionLinkPrerequisite
INS0001*Installment webhook readingReading 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 LinkDES0002

7 - Debt Resubmission

CodeStepDescriptionLinkPrerequisite
PAG0001*Disbursement date change/updateWhen an operation is canceled, updating the disbursement date makes the operation return to the status prior to cancellation.Documentation LinkItem 5
PAG0002Banking data changeChange of operation payment data, requiring an account with the same ownership as the borrowerDocumentation LinkPAG0001. Mandatory, if retry exists

8 - Operation Cancellation

CodeStepDescriptionLinkPrerequisite
CAN0002*Permanent debt cancellation before disbursementAllows definitive cancellation (final status) of debt before paymentDocumentation LinkEMD0001
CAN0003*Cancellation webhook readingReading the asynchronous response of operation cancellation. Webhook status: canceledDocumentation LinkCAN0002
CAN0004Debt cancellation within seven days after disbursementConsidering 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 CodeDocumentation LinkDES0002

9 - Debt Bank Slips

CodeStepDescriptionLinkPrerequisite
BKS0001Request duplicate bank slipDuplicate bank slip issuance, through the bank slip identifier key (bank_slip_key), returned in the disbursement webhookDocumentation LinkDES0002

10 - Debt Renegotiation

CodeStepDescriptionLinkPrerequisite
REN0001Renegotiation simulationAllows partial or total renegotiation simulationDocumentation LinkDES0002
REN0002Create a renegotiationAllows creation of partial or total renegotiation (generation of an advance bank slip for installment payments)Documentation LinkDES0002
REN0003Query a renegotiationCheck renegotiation conditions, affected installments, financial data, due date and payment typeDocumentation LinkREN0002
REN0004List RenegotiationsCheck a listing of conditions for more than one renegotiationDocumentation LinkREN0002
REN0005Cancel a renegotiationCancel a renegotiationDocumentation LinkREN0002
REN0006Renegotiation paymentRenegotiation status update webhooks. Webhook_type: renegotiation.proposalDocumentation LinkREN0002

11 - Payments and Transfers

CodeStepDescriptionLinkPrerequisite
PGT0001Decode QR CodeObtain payment data from the return QR Code, through the Pix Copy and Paste URIDocumentation LinkCAN0004
PGT0002PIX QR Code TransferQR Code payment, through information obtained by QR Code decoding for debt cancellationDocumentation LinkPGT0001
PGT0003PIX TransferPerform a PIX to the recipient from the escrow accountDocumentation LinkDES0003
PGT0004Account limit increaseRequest PIX limit increase for escrowDocumentation LinkDES0003
PGT0005TED TransferPerform a TED to the recipient from the escrow accountDocumentation LinkDES0003