Homologation Roadmap - Credit Pay
Summary
1. Debt inquiry
You can query the debt later to retrieve information or track its current status:
Path params
| Field | Type | Description | Max. Char. |
|---|---|---|---|
requester_identifier_key * | string | Client tracking key for the request | UUID |
Response
Response Body
{
"credit_operation_key":"0773a1b1-675a-4a10-80a2-a10308c7281e",
"issue_amount":15367.14,
"origin_key":"0773a1b1-675a-4a10-80a2-a10308c7281e",
"total_iof":367.14,
"assigned_at":null,
"disbursement_start_date":"2026-03-23",
"disbursement_end_date":"2026-03-23",
"issue_date":"2026-03-23",
"requester_identifier_key":"494598fd200",
"installments":[
{
"business_due_date":"2026-06-08",
"due_date":"2026-06-06",
"calendar_days":75,
"due_interest":0,
"due_principal":15367.14,
"fine_amount":0,
"has_interest":true,
"post_fixed_amount":0,
"pre_fixed_amount":2432.7,
"principal_amortization_amount":0,
"tax_amount":0,
"total_amount":2432.7,
"workdays":50,
"accrual_reference_date":null,
"advanced_paid_amount":0,
"bank_slip_key":null,
"digitable_line":null,
"installment_key":"c0c716ca-1645-4cf6-bb6b-438a69693d79",
"installment_status":"created",
"installment_type":"principal",
"original_due_principal":15367.14,
"original_pre_fixed_amount":2432.7,
"original_principal_amortization_amount":0,
"paid_amount":0,
"original_total_amount":2432.7,
"qr_code_key":null,
"qr_code_url":null,
"renegotiation_proposal_key":null,
"total_accrual_amount":0,
"total_paid_amount":0,
"installment_number":1,
"paid_at":null,
"updated_at":null,
"principal_amortization_payment_amount":0,
"prefixed_interest_payment_amount":0
},
{
"business_due_date":"2026-07-06",
"due_date":"2026-07-06",
"calendar_days":30,
"due_interest":399,
"due_principal":15367.14,
"fine_amount":0,
"has_interest":true,
"post_fixed_amount":0,
"pre_fixed_amount":1503.02,
"principal_amortization_amount":929.68,
"tax_amount":8,
"total_amount":2432.7,
"workdays":21,
"accrual_reference_date":null,
"advanced_paid_amount":0,
"bank_slip_key":null,
"digitable_line":null,
"installment_key":"46d7a106-004f-4f64-910c-bc9e2c010845",
"installment_status":"created",
"installment_type":"principal",
"original_due_principal":15367.14,
"original_pre_fixed_amount":1503.02,
"original_principal_amortization_amount":929.68,
"paid_amount":0,
"original_total_amount":2432.7,
"qr_code_key":null,
"qr_code_url":null,
"renegotiation_proposal_key":null,
"total_accrual_amount":0,
"total_paid_amount":0,
"installment_number":2,
"paid_at":null,
"updated_at":null,
"principal_amortization_payment_amount":0,
"prefixed_interest_payment_amount":0
},
{
"business_due_date":"2026-08-06",
"due_date":"2026-08-06",
"calendar_days":31,
"due_interest":0,
"due_principal":14437.46134964,
"fine_amount":0,
"has_interest":true,
"post_fixed_amount":0,
"pre_fixed_amount":1045.5,
"principal_amortization_amount":1387.2,
"tax_amount":15.47,
"total_amount":2432.7,
"workdays":23,
"accrual_reference_date":null,
"advanced_paid_amount":0,
"bank_slip_key":null,
"digitable_line":null,
"installment_key":"af84c132-7311-412f-a5e4-a827047fda52",
"installment_status":"created",
"installment_type":"principal",
"original_due_principal":14437.46,
"original_pre_fixed_amount":1045.5,
"original_principal_amortization_amount":1387.2,
"paid_amount":0,
"original_total_amount":2432.7,
"qr_code_key":null,
"qr_code_url":null,
"renegotiation_proposal_key":null,
"total_accrual_amount":0,
"total_paid_amount":0,
"installment_number":3,
"paid_at":null,
"updated_at":null,
"principal_amortization_payment_amount":0,
"prefixed_interest_payment_amount":0
},
{
"business_due_date":"2026-09-08",
"due_date":"2026-09-06",
"calendar_days":31,
"due_interest":0,
"due_principal":13050.26167997,
"fine_amount":0,
"has_interest":true,
"post_fixed_amount":0,
"pre_fixed_amount":945.05,
"principal_amortization_amount":1487.65,
"tax_amount":20.37,
"total_amount":2432.7,
"workdays":21,
"accrual_reference_date":null,
"advanced_paid_amount":0,
"bank_slip_key":null,
"digitable_line":null,
"installment_key":"8517161a-408a-400d-9a27-e4e54c87d9ec",
"installment_status":"created",
"installment_type":"principal",
"original_due_principal":13050.26,
"original_pre_fixed_amount":945.05,
"original_principal_amortization_amount":1487.65,
"paid_amount":0,
"original_total_amount":2432.7,
"qr_code_key":null,
"qr_code_url":null,
"renegotiation_proposal_key":null,
"total_accrual_amount":0,
"total_paid_amount":0,
"installment_number":4,
"paid_at":null,
"updated_at":null,
"principal_amortization_payment_amount":0,
"prefixed_interest_payment_amount":0
},
{
"business_due_date":"2026-10-06",
"due_date":"2026-10-06",
"calendar_days":30,
"due_interest":0,
"due_principal":11562.6067212,
"fine_amount":0,
"has_interest":true,
"post_fixed_amount":0,
"pre_fixed_amount":809.38,
"principal_amortization_amount":1623.32,
"tax_amount":26.22,
"total_amount":2432.7,
"workdays":21,
"accrual_reference_date":null,
"advanced_paid_amount":0,
"bank_slip_key":null,
"digitable_line":null,
"installment_key":"8c14e19c-a70e-4b0b-b0b5-d655f6136537",
"installment_status":"created",
"installment_type":"principal",
"original_due_principal":11562.61,
"original_pre_fixed_amount":809.38,
"original_principal_amortization_amount":1623.32,
"paid_amount":0,
"original_total_amount":2432.7,
"qr_code_key":null,
"qr_code_url":null,
"renegotiation_proposal_key":null,
"total_accrual_amount":0,
"total_paid_amount":0,
"installment_number":5,
"paid_at":null,
"updated_at":null,
"principal_amortization_payment_amount":0,
"prefixed_interest_payment_amount":0
},
{
"business_due_date":"2026-11-06",
"due_date":"2026-11-06",
"calendar_days":31,
"due_interest":0,
"due_principal":9939.28802441,
"fine_amount":0,
"has_interest":true,
"post_fixed_amount":0,
"pre_fixed_amount":719.76,
"principal_amortization_amount":1712.94,
"tax_amount":32.03,
"total_amount":2432.7,
"workdays":21,
"accrual_reference_date":null,
"advanced_paid_amount":0,
"bank_slip_key":null,
"digitable_line":null,
"installment_key":"4a880580-5873-4c12-8d32-3cf95b416417",
"installment_status":"created",
"installment_type":"principal",
"original_due_principal":9939.29,
"original_pre_fixed_amount":719.76,
"original_principal_amortization_amount":1712.94,
"paid_amount":0,
"original_total_amount":2432.7,
"qr_code_key":null,
"qr_code_url":null,
"renegotiation_proposal_key":null,
"total_accrual_amount":0,
"total_paid_amount":0,
"installment_number":6,
"paid_at":null,
"updated_at":null,
"principal_amortization_payment_amount":0,
"prefixed_interest_payment_amount":0
},
{
"business_due_date":"2026-12-07",
"due_date":"2026-12-06",
"calendar_days":30,
"due_interest":0,
"due_principal":8226.34916112,
"fine_amount":0,
"has_interest":true,
"post_fixed_amount":0,
"pre_fixed_amount":575.84,
"principal_amortization_amount":1856.86,
"tax_amount":39.28,
"total_amount":2432.7,
"workdays":19,
"accrual_reference_date":null,
"advanced_paid_amount":0,
"bank_slip_key":null,
"digitable_line":null,
"installment_key":"94db881b-0054-4c73-b969-89c37c082f39",
"installment_status":"created",
"installment_type":"principal",
"original_due_principal":8226.35,
"original_pre_fixed_amount":575.84,
"original_principal_amortization_amount":1856.86,
"paid_amount":0,
"original_total_amount":2432.7,
"qr_code_key":null,
"qr_code_url":null,
"renegotiation_proposal_key":null,
"total_accrual_amount":0,
"total_paid_amount":0,
"installment_number":7,
"paid_at":null,
"updated_at":null,
"principal_amortization_payment_amount":0,
"prefixed_interest_payment_amount":0
},
{
"business_due_date":"2027-01-06",
"due_date":"2027-01-06",
"calendar_days":31,
"due_interest":0,
"due_principal":6369.49243064,
"fine_amount":0,
"has_interest":true,
"post_fixed_amount":0,
"pre_fixed_amount":461.25,
"principal_amortization_amount":1971.45,
"tax_amount":46.72,
"total_amount":2432.7,
"workdays":21,
"accrual_reference_date":null,
"advanced_paid_amount":0,
"bank_slip_key":null,
"digitable_line":null,
"installment_key":"d32e9f02-426d-4861-ad5c-fe541d2a4b94",
"installment_status":"created",
"installment_type":"principal",
"original_due_principal":6369.49,
"original_pre_fixed_amount":461.25,
"original_principal_amortization_amount":1971.45,
"paid_amount":0,
"original_total_amount":2432.7,
"qr_code_key":null,
"qr_code_url":null,
"renegotiation_proposal_key":null,
"total_accrual_amount":0,
"total_paid_amount":0,
"installment_number":8,
"paid_at":null,
"updated_at":null,
"principal_amortization_payment_amount":0,
"prefixed_interest_payment_amount":0
},
{
"business_due_date":"2027-02-10",
"due_date":"2027-02-06",
"calendar_days":31,
"due_interest":0,
"due_principal":4398.04366699,
"fine_amount":0,
"has_interest":true,
"post_fixed_amount":0,
"pre_fixed_amount":318.49,
"principal_amortization_amount":2114.21,
"tax_amount":55.48,
"total_amount":2432.7,
"workdays":22,
"accrual_reference_date":null,
"advanced_paid_amount":0,
"bank_slip_key":null,
"digitable_line":null,
"installment_key":"0c6ef3ba-6d82-45e4-9f3f-9f9a89207f68",
"installment_status":"created",
"installment_type":"principal",
"original_due_principal":4398.04,
"original_pre_fixed_amount":318.49,
"original_principal_amortization_amount":2114.21,
"paid_amount":0,
"original_total_amount":2432.7,
"qr_code_key":null,
"qr_code_url":null,
"renegotiation_proposal_key":null,
"total_accrual_amount":0,
"total_paid_amount":0,
"installment_number":9,
"paid_at":null,
"updated_at":null,
"principal_amortization_payment_amount":0,
"prefixed_interest_payment_amount":0
},
{
"business_due_date":"2027-03-08",
"due_date":"2027-03-06",
"calendar_days":28,
"due_interest":0,
"due_principal":2283.83070016,
"fine_amount":0,
"has_interest":true,
"post_fixed_amount":0,
"pre_fixed_amount":148.87,
"principal_amortization_amount":2283.83,
"tax_amount":65.17,
"total_amount":2432.7,
"workdays":18,
"accrual_reference_date":null,
"advanced_paid_amount":0,
"bank_slip_key":null,
"digitable_line":null,
"installment_key":"470dd63a-89eb-4c6c-8cd6-f570d469aa35",
"installment_status":"created",
"installment_type":"principal",
"original_due_principal":2283.83,
"original_pre_fixed_amount":148.87,
"original_principal_amortization_amount":2283.83,
"paid_amount":0,
"original_total_amount":2432.7,
"qr_code_key":null,
"qr_code_url":null,
"renegotiation_proposal_key":null,
"total_accrual_amount":0,
"total_paid_amount":0,
"installment_number":10,
"paid_at":null,
"updated_at":null,
"principal_amortization_payment_amount":0,
"prefixed_interest_payment_amount":0
}
],
"first_due_date":"2026-06-06",
"requester_key":"3e69b448-9afb-4aef-9c0d-0a3059350d80",
"original_total_iof":null,
"contract_number":"ANT000000787",
"credit_operation_status_enumerator":"waiting_signature",
"operation_type_enumerator":"settlement_refinancing",
"disbursement_date":"2026-03-23",
"issuer_name":"Alan Mathison Turing",
"issuer_document_number":"47003534819",
"external_contract_fees":[
{
"amount_type":"absolute",
"fee_amount":0,
"tax_amount":0,
"irrf_amount":0,
"amount":0,
"pis_amount":0,
"amount_released":0,
"fee_type":"tac",
"cofins_amount":0,
"csll_amount":0,
"description":null,
"net_fee_amount":0,
"rebate_account":null
}
],
"cet":7.51,
"annual_cet":138.34,
"final_disbursement_amount":4885.12,
"number_of_installments":10,
"disbursement_issue_amount":15000,
"prefixed_interest_rate":{
"annual_rate":1.252191589,
"daily_rate":0.0022578334,
"interest_base":{
"enumerator":"calendar_days",
"year_days":360
},
"monthly_rate":0.07
},
"fine_configuration":{
"contract_fine_rate":0.02,
"fine_delay_rate":{
"annual_rate":4.35025011,
"daily_rate":0.0046696,
"interest_base":{
"enumerator":"calendar_days",
"year_days":360
},
"monthly_rate":0.15
}
},
"attached_documents":[
{
"document_key":"494598fd-c226-4332-a500-591ae3884673",
"document_url":"https://storage.googleapis.com/sandbox-doc-api/documents/494598fd-c226-4332-a500-591ae3884673/3d684e68e7df4e557d0480d98e26be92.jpg",
"signature_url":null,
"document_type":"document_identification",
"signature_required":false,
"signed":false
},
{
"document_key":"494598fd-c226-4332-a500-591ae3884673",
"document_url":"https://storage.googleapis.com/sandbox-doc-api/documents/494598fd-c226-4332-a500-591ae3884673/3d684e68e7df4e557d0480d98e26be92.jpg",
"signature_url":null,
"document_type":"document_identification_back",
"signature_required":false,
"signed":false
},
{
"document_key":"cb97f9f5-9b58-4a55-826f-8698f2b97230",
"document_url":"https://storage.googleapis.com/sandbox-doc-api-private/documents/cb97f9f5-9b58-4a55-826f-8698f2b97230/CASTELLOBNPL-ALAN_MATHISON_TURING-CCB-ANT000000787-20260408055239.pdf",
"signature_url":null,
"document_type":"ccb_pre_price_days",
"signature_required":true,
"signed":false
}
],
"related_parties":[
{
"related_party_key":"70f0bc84-98e0-4d4c-9ea7-ed783746ba5c",
"role_type":"issuer",
"person_type":"natural",
"name":"Alan Mathison Turing",
"email":"",
"individual_document_number":"47003534819"
}
],
"base_iof":308.75,
"additional_iof":58.39,
"assignment_amount":15444.19,
"created_at":"2026-04-08T05:52:38Z",
"total_prefixed_amount":8959.86
}
business_due_date (installments)In each object under installments[], pay attention to business_due_date: it is the installment due date on the business-day calendar (working / banking days). It may match due_date or differ when the natural calendar date falls on a non-business day—use both fields together when reconciling schedules and cut-offs.
operation_type_enumeratorWhen operation_type_enumerator is settlement_refinancing, the credit operation is a refinancing debt—that is, it is issued under the refinancing flow (settling prior credit operations). Use this field to distinguish refinancing debts from other operation types.
2. Renegotiation — Batch simulation
Overview
Before creating a proposal, you can simulate batch renegotiation values for operations. The simulation shows affected installments, discounts, and the total amount due across multiple operations.
When amortization_type is present_amount, send paid_amount, discount_amount, and installment_key on each installment in operations[].installments[], as in the batch proposal.
Batch renegotiation can only include operations from the same issuer and the same integration key. There is a limit of 50 operations per batch renegotiation.
Request
The discount_amount and discount_percentage fields must not be sent together in the same payload (root level).
At the root, discount_amount and discount_percentage are mutually exclusive global discount options. paid_amount and discount_amount in operations[].installments[] are used with present_amount per installment and do not replace the root-level rule.
Request Body
{
"amortization_type": "present_amount",
"reference_date": "2026-04-08",
"discount_percentage": 0.0,
"operations": [
{
"debt_key": "1baea8a0-0fca-4f7c-8857-a227d4da72f8",
"installments": [
{
"installment_key": "ca5741c7-99a2-42e7-92a1-9328a36e4e88",
"paid_amount": 500,
"discount_amount": 50
}
]
},
{
"debt_key": "2cbfb9b1-1fdb-5f8d-9967-b338e5eb83f9",
"installments": [
{
"installment_key": "2ef25ed8-7124-44f5-9e3d-1d1a7196166e",
"paid_amount": 150,
"discount_amount": 10
}
]
}
]
}
Body parameters
| Field | Type | Description | Max length |
|---|---|---|---|
amortization_type* | string | Amortization type | Amortization type values |
reference_date* | string | Reference date for present value (must be D+1) | 10 |
discount_percentage | float | Discount percentage on present value ((1 − percentage) × present value) | 10 |
discount_amount | float | Discount amount on present value | 10 |
operations* | array | Operations to renegotiate | Operations object |
Operations object
| Field | Type | Description | Max length |
|---|---|---|---|
debt_key* | string | Unique credit operation key (DEBT-KEY) | UUID |
installments* | array | Installments to renegotiate | Installments object |
Installments object
| Field | Type | Description | Max length |
|---|---|---|---|
installment_key* | string | Installment key | UUID |
paid_amount | float | Amount paid or allocated on the installment (BRL). Required when amortization_type is present_amount. | 15,2 |
discount_amount | float | Discount in BRL on the installment. Required when amortization_type is present_amount (use 0 if none). Optional for other types. | 15,2 |
Amortization type values
| Value | Description |
|---|---|
| present_amount | Simulation with present value per installment. Each installments[] entry must include installment_key, paid_amount, and discount_amount. |
| installment_payment | Payment for specific installments in the payload. Requires each installment’s installment_key. |
3. Renegotiation — Batch proposal
Overview
After simulating values, you can create a batch renegotiation proposal for multiple operations. The proposal generates a single payment method (bank slip and/or Pix) covering all operations in the batch.
For amortization type present_amount, each installment listed under operations[].installments[] must include paid_amount (amount paid or allocated for that installment), discount_amount (discount in BRL applied to the installment), and installment_key.
Batch renegotiation can only include operations from the same issuer and the same integration key. There is a limit of 50 operations per batch renegotiation.
Request
The discount_amount and discount_percentage fields must not be sent together in the same payload (root level).
At the root of the body, discount_amount and discount_percentage are mutually exclusive options for a global discount on the present value. The paid_amount and discount_amount fields inside each object in operations[].installments[] define the per-installment composition when amortization_type is present_amount (they are required in this mode and do not conflict with the root-level rule).
Request Body
{
"amortization_type": "present_amount",
"reference_date": "2026-04-08",
"proposal_due_date": "2026-04-15",
"discount_percentage": 0.0,
"payment_type": "pix",
"request_control_key": "94b31045-c8e7-45be-a88d-2ae25c5df5db",
"operations": [
{
"debt_key": "1baea8a0-0fca-4f7c-8857-a227d4da72f8",
"installments": [
{
"installment_key": "ca5741c7-99a2-42e7-92a1-9328a36e4e88",
"paid_amount": 500,
"discount_amount": 50
}
]
},
{
"debt_key": "2cbfb9b1-1fdb-5f8d-9967-b338e5eb83f9",
"installments": [
{
"installment_key": "2ef25ed8-7124-44f5-9e3d-1d1a7196166e",
"paid_amount": 150,
"discount_amount": 10
}
]
}
]
}
Body parameters
| Field | Type | Description | Max length |
|---|---|---|---|
amortization_type* | string | Amortization type | Amortization type values |
reference_date* | string | Reference date for present value calculation (D+1) | 10 |
proposal_due_date* | string | Renegotiation proposal due date | 10 |
payment_type* | string | Payment type | Payment type values |
request_control_key | string | Optional control key for tracking and unique identification | UUID |
discount_percentage | float | Discount percentage on present value | 10 |
discount_amount | float | Discount amount on present value | 10 |
operations* | array | Operations to renegotiate | Operations object |
Operations object
| Field | Type | Description | Max length |
|---|---|---|---|
debt_key* | string | Unique credit operation key (DEBT-KEY) | UUID |
installments* | array | Installments to renegotiate | Installments object |
Installments object
| Field | Type | Description | Max length |
|---|---|---|---|
installment_key* | string | Installment key | UUID |
paid_amount | float | Amount paid or allocated on the installment (BRL). Required when amortization_type is present_amount. | 15,2 |
discount_amount | float | Discount amount in BRL on the installment. Required when amortization_type is present_amount (use 0 if none). Optional per installment for other amortization types. | 15,2 |
Payment type values
| Value | Description |
|---|---|
bank_slip | Bank slip (generates slip and Pix) |
pix | Pix only |
internal | Internal transfer (automatic processing) |
manual | Manual payment (no payment method generated) |
Amortization type values
| Value | Description |
|---|---|
| present_amount | Present value per installment. Each installments[] item must include installment_key, paid_amount, and discount_amount. |
| installment_payment | Payment for specific installments. Requires each installment’s installment_key. |
4. Refinancing simulation
Request
Request Body
{
"borrower": {
"person_type": "natural"
},
"refinanced_credit_operations": [
{
"operation_key": "0207544f-2e9c-4eac-993e-7590e4dc14ae"
}
],
"financial": {
"disbursed_amount": 200000,
"interest_type": "pre_price_days",
"credit_operation_type": "ccb",
"annual_interest_rate": 2.32,
"disbursement_date": "2023-04-01",
"interest_grace_period": 0,
"principal_grace_period": 0,
"number_of_installments": 2,
"fine_configuration": {
"contract_fine_rate": 0.02,
"interest_base": "calendar_days",
"monthly_rate": 0.01
}
}
}
Send borrower, financial, and refinanced_credit_operations with operation_key for each operation to refinance. See Definitions (refinancing simulation).
Response
Response Body
{
"type":"debt",
"key":"a61f8266-5a59-40ea-a87d-a3f907516fac",
"status":"finished",
"event_datetime":"2026-04-08 06:07:41",
"data":{
"interest_type":"pre_price_days",
"credit_operation_type":"ccb",
"interest_grace_period":0,
"interest_payment_month_period":1,
"principal_grace_period":0,
"principal_amortization_month_period":1,
"operation_type":"settlement_refinancing",
"post_fixed_interest_base":"workdays",
"post_fixed_interest_rate":null,
"prefixed_interest_rate":{
"interest_base":"calendar_days_365",
"annual_rate":2.32,
"monthly_rate":0.1051676747,
"daily_rate":0.0032929847
},
"issue_date":"2023-04-01",
"number_of_installments":2,
"requester_key":"3e69b448-9afb-4aef-9c0d-0a3059350d80",
"final_disbursement_amount":179510.48,
"refinanced_credit_operations":[
{
"refinanced_credit_operation_key":"0207544f-2e9c-4eac-993e-7590e4dc14ae",
"refinanced_credit_operation_status":"pending_payment",
"due_balance":20489.52,
"due_balance_reference_date":"2023-04-01",
"original_deadline":348
}
],
"total_pre_fixed_amount":32213.66,
"iof_amount":1529.88,
"cet":0.1109,
"annual_cet":2.5332,
"disbursement_date":"2023-04-01",
"installments":[
{
"calendar_days":30,
"workdays":18,
"business_due_date":"2023-05-02",
"due_date":"2023-05-01",
"due_principal":201529.88,
"has_interest":true,
"post_fixed_amount":0,
"pre_fixed_amount":20889.54357681,
"tax_amount":236.116277,
"total_amount":116871.77,
"principal_amortization_amount":95982.22642319,
"installment_number":1
},
{
"calendar_days":31,
"workdays":23,
"business_due_date":"2023-06-01",
"due_date":"2023-06-01",
"due_principal":105547.65357681,
"has_interest":true,
"post_fixed_amount":0,
"pre_fixed_amount":11324.11642319,
"tax_amount":527.94936319,
"total_amount":116871.77,
"principal_amortization_amount":105547.65357681,
"installment_number":2
}
],
"external_contract_fees":[
{
"fee_type":"tac",
"amount_type":"absolute",
"amount":0,
"fee_amount":0,
"tax_amount":0,
"net_fee_amount":0,
"csll_amount":0,
"irrf_amount":0,
"pis_amount":0,
"cofins_amount":0,
"amount_released":0,
"description":null
}
],
"contract_fee_amount":604.59,
"external_contract_fee_amount":0,
"net_external_contract_fee_amount":0,
"contract_fees":[
{
"fee_type":"spread",
"amount_type":"percentage",
"amount":0.3,
"fee_amount":604.59
}
],
"issue_amount":201529.88,
"disbursed_issue_amount":200000,
"assignment_amount":202134.47,
"disbursement_options":[
{
"iof_amount":1529.88,
"total_pre_fixed_amount":32213.66,
"cet":0.1109,
"annual_cet":2.5332,
"contract_fees":[
{
"fee_type":"spread",
"amount_type":"percentage",
"amount":0.3,
"fee_amount":604.59
}
],
"external_contract_fees":[
{
"fee_type":"tac",
"amount_type":"absolute",
"amount":0,
"fee_amount":0,
"tax_amount":0,
"net_fee_amount":0,
"csll_amount":0,
"irrf_amount":0,
"pis_amount":0,
"cofins_amount":0,
"amount_released":0,
"description":null
}
],
"contract_fee_amount":604.59,
"external_contract_fee_amount":0,
"net_external_contract_fee_amount":0,
"disbursement_date":"2023-04-01",
"first_due_date":"2023-05-01",
"installments":[
{
"calendar_days":30,
"workdays":18,
"business_due_date":"2023-05-02",
"due_date":"2023-05-01",
"due_principal":201529.88,
"has_interest":true,
"post_fixed_amount":0,
"pre_fixed_amount":20889.54357681,
"tax_amount":236.116277,
"total_amount":116871.77,
"principal_amortization_amount":95982.22642319,
"installment_number":1
},
{
"calendar_days":31,
"workdays":23,
"business_due_date":"2023-06-01",
"due_date":"2023-06-01",
"due_principal":105547.65357681,
"has_interest":true,
"post_fixed_amount":0,
"pre_fixed_amount":11324.11642319,
"tax_amount":527.94936319,
"total_amount":116871.77,
"principal_amortization_amount":105547.65357681,
"installment_number":2
}
],
"issue_amount":201529.88,
"disbursed_issue_amount":200000,
"assignment_amount":202134.47,
"final_disbursement_amount":179510.48,
"prefixed_interest_rate":{
"interest_base":"calendar_days_365",
"annual_rate":2.32,
"monthly_rate":0.1051676747,
"daily_rate":0.0032929847
},
"refinanced_credit_operations":[
{
"refinanced_credit_operation_key":"0207544f-2e9c-4eac-993e-7590e4dc14ae",
"refinanced_credit_operation_status":"pending_payment",
"due_balance":20489.52,
"due_balance_reference_date":"2023-04-01",
"original_deadline":348
}
]
}
]
}
}
Definitions (refinancing simulation)
Request body
| Field | Type | Description |
|---|---|---|
| borrower * | object | Borrower object — Borrower of the simulated operation |
| refinanced_credit_operations * | array | Refinanced credit operations — Operations to refinance |
| financial * | object | Financial object — Terms of the new operation |
Borrower object
| Field | Type | Description |
|---|---|---|
| person_type | string | Person type — natural or legal |
Financial object
| Field | Type | Description |
|---|---|---|
| disbursed_amount | float | Disbursed / nominal amount of the new operation |
| interest_type | enum | Interest type — Amortization and interest calculation |
| credit_operation_type | enum | Credit operation type — Agreement type (e.g. CCB) |
| annual_interest_rate | float | Annual prefixed interest rate (decimal) |
| disbursement_date | date | Disbursement date (YYYY-MM-DD) |
| interest_grace_period | int | Interest grace period (months) |
| principal_grace_period | int | Principal grace period (months) |
| number_of_installments | int | Number of installments |
| fine_configuration | object | Fine configuration object — Late interest and penalty |
Refinanced credit operations object
| Field | Type | Description |
|---|---|---|
| operation_key | string (UUID) | Credit operation key to settle with this refinancing |
Fine configuration object
| Field | Type | Description |
|---|---|---|
| contract_fine_rate | float | Late penalty rate as a decimal |
| interest_base | enum | Interest base — Interest calculation basis |
| monthly_rate | float | Monthly late interest rate as a decimal |
5. Creating a refinancing
Request
Request Body
{
"additional_data": {
"contract": {
"contract_number": "ANT000000787",
"signed": true,
"signatures": [
{
"signer": {
"name": "Alan Mathison Turing",
"phone": {
"number": "912345678",
"area_code": "11",
"country_code": "055"
},
"email": "alan.turing@email.com",
"document_number": "96969879003"
},
"signature": {
"ip_address": "168.211.22.84",
"timestamp": "27-10-2025 11:07:15",
"signature_file": {
"file_url": "http://qitech.com.br/signature.pdf",
"file_type": "pdf"
},
"geolocation": {
"long": "-46.63611",
"lat": "-23.5475"
},
"fingerprint_device": null
}
}
]
}
},
"financial": {
"number_of_installments": 10,
"credit_operation_type": "ccb",
"interest_type": "pre_price_days",
"monthly_interest_rate": 0.07,
"disbursed_amount": 15000,
"fine_configuration": {
"contract_fine_rate": 0.02,
"monthly_rate": 0.15,
"interest_base": "calendar_days"
},
"interest_grace_period": 0,
"disbursement_date": "2026-03-23",
"first_due_date": "2026-06-06",
"principal_grace_period": 0
},
"disbursement_bank_accounts": [
{
"account_digit": "5",
"document_number": "32402502000135",
"bank_code": "341",
"account_number": "00002",
"percentage_receivable": 100,
"branch_number": "0001",
"name": "Accout Name"
}
],
"purchaser_document_number": "32402502000135",
"requester_identifier_key": "494598fd200",
"refinanced_credit_operations": [
{
"operation_key": "9a8ec38d-8821-4043-8fcb-bfeb4c21c17e"
}
],
"borrower": {
"email": "",
"document_identification": "494598fd-c226-4332-a500-591ae3884673",
"document_identification_back": "494598fd-c226-4332-a500-591ae3884673",
"birth_date": "1998-06-03",
"person_type": "natural",
"is_pep": false,
"mother_name": "Mother's full name",
"profession": "Public server",
"individual_document_number": "47003534819",
"address": {
"city": "São Paulo",
"neighborhood": "CENTRO",
"street": "Avenida Feliz",
"complement": "",
"postal_code": "49026100",
"state": "SP",
"number": ""
},
"phone": {
"country_code": "055",
"number": "912345678",
"area_code": "11"
},
"document_identification_number": "47003534819",
"name": "Alan Mathison Turing"
}
}
Refinancing creation uses the same POST /signed_debt flow as standard issuance, with refinanced_credit_operations listing operations to settle. The example below also includes additional_data.contract (opt-in signatures) and disbursement_bank_accounts.
Body parameters
| Field | Type | Description | Max. chars |
|---|---|---|---|
| additional_data * | object | Contract metadata and signature evidence under additional_data.contract (contract number, signed flag, signatures[] with signer and evidence). | - |
| borrower * | object | Borrower object — Borrower of the credit operation. | - |
| disbursement_bank_accounts * | array | Disbursement bank account — Account for disbursement | - |
| financial * | object | Financial object — Financial terms; use "natural" for person_type when applicable. | - |
| purchaser_document_number * | string | Assignee (purchaser) CNPJ (digits only, no formatting). | - |
| requester_identifier_key | string | Client tracking key for the request. | - |
| refinanced_credit_operations * | array of objects | Refinanced credit operations — Operations to settle with this refinancing. | - |
Borrower object
| Field | Type | Description | Max. chars |
|---|---|---|---|
| name * | string | Borrower full name | 100 |
| string | Borrower email | 254 | |
| phone | object | Phone object — Contact phone | - |
| is_pep * | boolean | PEP indicator (http://www.portaldatransparencia.gov.br/download-de-dados/pep) | - |
| address * | object | Address object — Borrower address | - |
| role_type * | enum | Default: issuer | - |
| birth_date * | date | Borrower birth date (YYYY-MM-DD) | - |
| mother_name * | string | Mother’s full name | 100 |
| nationality | string | Nationality | 50 |
| person_type * | string | Person type — natural or legal (default: natural for individuals) | - |
| individual_document_number * | string | Borrower CPF (digits only) | 11 |
| document_identification * | string | DOCUMENT_KEY of the borrower’s photo ID PDF (RG or CNH) | - |
| document_identification_back | string | DOCUMENT_KEY of the back of the photo ID (uploaded beforehand). | 11 |
Address object
| Field | Type | Description | Max. chars |
|---|---|---|---|
| city * | string | City | 100 |
| state * | string | State (two uppercase letters) | 2 |
| number * | string | Street number | 10 |
| street * | string | Street name | 100 |
| complement * | string | Address complement (free text) | 100 |
| postal_code * | string | Postal code (https://www.buscacep.correios.com.br/) | 8 |
| neighborhood * | string | Neighborhood | 100 |
Phone object
| Field | Description | Example | Max. chars |
|---|---|---|---|
| number * | string | Phone number | 10 |
| area_code * | string | Area code (https://ddd.guiamais.com.br/) | 2 |
| country_code * | string | Country code (https://ddi.guiamais.com.br/) | 3 |
Disbursement bank account
Debt issuance must include bank details for disbursement; by default this is an account in the borrower’s name.
| Field | Type | Description | Max. chars |
|---|---|---|---|
| name | string | Account holder name | 50 |
| document_number | string | Account holder CPF | 11 |
| bank_code * | string | COMPE bank code (https://www.bcb.gov.br/pom/spb/estatistica/port/ASTR003.pdf) | 3 |
| branch_number * | string | Branch number (do not include branch check digit) | 4 |
| account_number * | string | Account number (without account check digit) | 10 |
| account_digit * | string | Account check digit (use zero instead of letters) | 1 |
| account_type | enum | Account type | 1 |
Financial object
The financial object describes the credit operation’s financial terms.
| Field | Type | Description | Max. chars |
|---|---|---|---|
| disbursed_amount * | float | Disbursed / nominal amount of the credit operation | - |
| interest_type | enum | Interest type — Amortization and interest calculation | - |
| credit_operation_type | enum | Credit operation type — Agreement type | - |
| annual_interest_rate | float | Annual prefixed interest rate as a decimal | - |
| disbursement_date | date | Disbursement date | - |
| interest_grace_period | int | Interest grace period (months) | - |
| principal_grace_period | int | Principal grace period | - |
| number_of_installments | int | Number of installments | - |
| fine_configuration | object | Fine configuration — Late interest and penalty | - |
Fine configuration object
Fine configuration defines late penalty and interest for the credit operation.
| Field | Type | Description | Max. chars |
|---|---|---|---|
| contract_fine_rate | float | Late penalty rate | - |
| interest_base | enum | Interest base — Interest calculation basis | - |
| monthly_rate | float | Monthly late interest rate | - |
Refinanced credit operations
| Field | Type | Description | Max. chars |
|---|---|---|---|
operation_key | string | Key of the operation to refinance | UUID |
Enumerators
Person type
| Value | Description |
|---|---|
| legal | Legal entity |
| natural | Natural person |
Account type
| Value | Description |
|---|---|
| checking_account | Checking account |
| deposit_account | Deposit account |
| guaranteed_account | Guaranteed account |
| investment_account | Investment account |
| payment_account | Payment account |
| saving_account | Savings account |
| salary_account | Salary account |
Interest type
| Value | Description |
|---|---|
| pre_price_days | Price method (equal installments) with daily prefixed interest |
| pre_price | Price method (equal installments) with prefixed interest in fixed 30-day periods |
| pre_sac | SAC (constant amortization) with daily prefixed interest |
| post_sac | SAC with prefixed rate plus post-fixed index (CDI, IPCA, or IGP-M), daily |
| post_price | Price method with prefixed rate plus post-fixed index in fixed 30-day periods |
| post_price_days | Price method with prefixed rate plus post-fixed index, daily |
Credit operation type
| Value | Description |
|---|---|
| ccb | Bank credit note (Cédula de Crédito Bancário) |
| cce | Export credit note |
| cci | Real estate credit note |
| nce | Export credit note (alternative) |
Interest base
| Value | Description |
|---|---|
| workdays | Business days, 252-day year |
| calendar_days | Calendar days, 360-day year |
| calendar_days_365 | Calendar days, 365-day year |
Fee type
Each fee type must be enabled and configured by QI Tech in advance.
| Value | Description |
|---|---|
| tac | Account opening fee |
| spread | Premium on the credit operation acquisition amount |
| warranty_analysis | Collateral analysis fee |
| ted_fee | TED transfer fee |
| spread_ted_fee | Premium on TED fee in the acquisition amount |
Response
Response Body
{
"data":{
"total_pre_fixed_amount":8959.86,
"contract_fee_amount":77.05,
"requester_identifier_key":"494598fd200",
"ipoc_code":"324025020203147003534819ANT000000787",
"contract_fees":[
{
"fee_type":"spread",
"fee_amount":46.1
},
{
"fee_amount":30.34,
"fee_type":"spread_refinancing"
},
{
"fee_type":"spread_refinancing",
"fee_amount":0.61
}
],
"iof_charge_method":"financed",
"contract":{
"document_key":"cb97f9f5-9b58-4a55-826f-8698f2b97230",
"number":"ANT000000787",
"signature_information":[
{
"signature_url":null,
"signer_role":"issuer",
"signer_external_key":null,
"signer_name":"Alan Mathison Turing",
"signer_document_number":"47003534819",
"signer_email":null
}
],
"urls":[
"https://storage.googleapis.com/sandbox-doc-api-private/documents/cb97f9f5-9b58-4a55-826f-8698f2b97230/CASTELLOBNPL-ALAN_MATHISON_TURING-CCB-ANT000000787-20260408055239.pdf"
]
},
"external_contract_fee_amount":0,
"cet":"7,5100%",
"total_iof":367.14,
"borrower":{
"document_number":"47003534819",
"related_party_key":"70f0bc84-98e0-4d4c-9ea7-ed783746ba5c",
"name":"Alan Mathison Turing"
},
"collaterals":[
],
"prefixed_interest_rate":{
"daily_rate":0.0022578334,
"annual_rate":1.252191589,
"monthly_rate":0.07,
"created_at":"2026-04-08T05:52:38",
"interest_base":"calendar_days"
},
"annual_cet":"138,3385%",
"assignment_amount":15444.19,
"base_iof":308.75,
"external_contract_fees":[
{
"net_fee_amount":0,
"fee_type":"tac",
"fee_amount":0,
"tax_amount":0
}
],
"issue_amount":15367.14,
"additional_iof":58.39,
"installments":[
{
"business_due_date":"2026-06-08",
"workdays":50,
"has_interest":true,
"original_due_principal":15367.14,
"total_paid_amount":0,
"total_amount":2432.7,
"digitable_line":null,
"qr_code_url":null,
"original_pre_fixed_amount":2432.7,
"installment_payment":[
],
"due_principal":15367.14,
"paid_at":null,
"tax_amount":0,
"installment_status":"created",
"original_principal_amortization_amount":0,
"post_fixed_amount":0,
"additional_costs":[
],
"installment_number":1,
"fine_amount":null,
"renegotiation_proposal_key":null,
"calendar_days":75,
"principal_amortization_amount":0,
"installment_history":[
],
"installment_key":"c0c716ca-1645-4cf6-bb6b-438a69693d79",
"advanced_paid_amount":0,
"qr_code_key":null,
"bank_slip_key":null,
"due_interest":0,
"original_total_amount":2432.7,
"paid_amount":0,
"pre_fixed_amount":2432.7,
"due_date":"2026-06-06",
"accrual_reference_date":null,
"installment_type":"principal",
"total_accrual_amount":null
},
{
"installment_type":"principal",
"accrual_reference_date":null,
"total_accrual_amount":null,
"original_total_amount":2432.7,
"pre_fixed_amount":1503.02134964,
"paid_amount":0,
"due_date":"2026-07-06",
"bank_slip_key":null,
"due_interest":399.36701987,
"calendar_days":30,
"installment_history":[
],
"principal_amortization_amount":929.67865036,
"advanced_paid_amount":0,
"installment_key":"46d7a106-004f-4f64-910c-bc9e2c010845",
"qr_code_key":null,
"installment_number":2,
"post_fixed_amount":0,
"additional_costs":[
],
"fine_amount":null,
"renegotiation_proposal_key":null,
"installment_status":"created",
"original_principal_amortization_amount":929.67865036,
"tax_amount":8.00453318,
"digitable_line":null,
"original_pre_fixed_amount":1503.02134964,
"qr_code_url":null,
"paid_at":null,
"due_principal":15367.14,
"installment_payment":[
],
"business_due_date":"2026-07-06",
"has_interest":true,
"workdays":21,
"original_due_principal":15367.14,
"total_amount":2432.7,
"total_paid_amount":0
},
{
"original_total_amount":2432.7,
"pre_fixed_amount":1045.50033033,
"paid_amount":0,
"due_date":"2026-08-06",
"installment_type":"principal",
"accrual_reference_date":null,
"total_accrual_amount":null,
"calendar_days":31,
"installment_history":[
],
"principal_amortization_amount":1387.19966967,
"advanced_paid_amount":0,
"installment_key":"af84c132-7311-412f-a5e4-a827047fda52",
"qr_code_key":null,
"bank_slip_key":null,
"due_interest":0,
"original_principal_amortization_amount":1387.19966967,
"installment_status":"created",
"tax_amount":15.47005072,
"installment_number":3,
"additional_costs":[
],
"post_fixed_amount":0,
"fine_amount":null,
"renegotiation_proposal_key":null,
"business_due_date":"2026-08-06",
"original_due_principal":14437.46134964,
"workdays":23,
"has_interest":true,
"total_amount":2432.7,
"total_paid_amount":0,
"digitable_line":null,
"original_pre_fixed_amount":1045.50033033,
"qr_code_url":null,
"paid_at":null,
"due_principal":14437.46134964,
"installment_payment":[
]
},
{
"installment_number":4,
"additional_costs":[
],
"post_fixed_amount":0,
"fine_amount":null,
"renegotiation_proposal_key":null,
"original_principal_amortization_amount":1487.65495877,
"installment_status":"created",
"tax_amount":20.37194701,
"digitable_line":null,
"original_pre_fixed_amount":945.04504123,
"qr_code_url":null,
"paid_at":null,
"installment_payment":[
],
"due_principal":13050.26167997,
"business_due_date":"2026-09-08",
"original_due_principal":13050.26167997,
"has_interest":true,
"workdays":21,
"total_paid_amount":0,
"total_amount":2432.7,
"installment_type":"principal",
"accrual_reference_date":null,
"total_accrual_amount":null,
"original_total_amount":2432.7,
"pre_fixed_amount":945.04504123,
"paid_amount":0,
"due_date":"2026-09-06",
"bank_slip_key":null,
"due_interest":0,
"calendar_days":31,
"installment_history":[
],
"principal_amortization_amount":1487.65495877,
"advanced_paid_amount":0,
"installment_key":"8517161a-408a-400d-9a27-e4e54c87d9ec",
"qr_code_key":null
},
{
"renegotiation_proposal_key":null,
"post_fixed_amount":0,
"additional_costs":[
],
"installment_number":5,
"fine_amount":null,
"tax_amount":26.22309023,
"installment_status":"created",
"original_principal_amortization_amount":1623.31869679,
"installment_payment":[
],
"due_principal":11562.6067212,
"paid_at":null,
"digitable_line":null,
"qr_code_url":null,
"original_pre_fixed_amount":809.38130321,
"workdays":21,
"has_interest":true,
"original_due_principal":11562.6067212,
"total_paid_amount":0,
"total_amount":2432.7,
"business_due_date":"2026-10-06",
"total_accrual_amount":null,
"accrual_reference_date":null,
"installment_type":"principal",
"due_date":"2026-10-06",
"original_total_amount":2432.7,
"paid_amount":0,
"pre_fixed_amount":809.38130321,
"due_interest":0,
"bank_slip_key":null,
"installment_key":"8c14e19c-a70e-4b0b-b0b5-d655f6136537",
"advanced_paid_amount":0,
"qr_code_key":null,
"calendar_days":30,
"principal_amortization_amount":1623.31869679,
"installment_history":[
]
},
{
"business_due_date":"2026-11-06",
"has_interest":true,
"workdays":21,
"original_due_principal":9939.28802441,
"total_amount":2432.7,
"total_paid_amount":0,
"digitable_line":null,
"original_pre_fixed_amount":719.76113671,
"qr_code_url":null,
"paid_at":null,
"due_principal":9939.28802441,
"installment_payment":[
],
"installment_status":"created",
"original_principal_amortization_amount":1712.93886329,
"tax_amount":32.02510499,
"installment_number":6,
"post_fixed_amount":0,
"additional_costs":[
],
"fine_amount":null,
"renegotiation_proposal_key":null,
"calendar_days":31,
"installment_history":[
],
"principal_amortization_amount":1712.93886329,
"advanced_paid_amount":0,
"installment_key":"4a880580-5873-4c12-8d32-3cf95b416417",
"qr_code_key":null,
"bank_slip_key":null,
"due_interest":0,
"original_total_amount":2432.7,
"pre_fixed_amount":719.76113671,
"paid_amount":0,
"due_date":"2026-11-06",
"installment_type":"principal",
"accrual_reference_date":null,
"total_accrual_amount":null
},
{
"original_principal_amortization_amount":1856.85673048,
"installment_status":"created",
"tax_amount":39.28366099,
"fine_amount":null,
"installment_number":7,
"additional_costs":[
],
"post_fixed_amount":0,
"renegotiation_proposal_key":null,
"business_due_date":"2026-12-07",
"total_amount":2432.7,
"total_paid_amount":0,
"original_due_principal":8226.34916112,
"workdays":19,
"has_interest":true,
"original_pre_fixed_amount":575.84326952,
"qr_code_url":null,
"digitable_line":null,
"paid_at":null,
"due_principal":8226.34916112,
"installment_payment":[
],
"pre_fixed_amount":575.84326952,
"paid_amount":0,
"original_total_amount":2432.7,
"due_date":"2026-12-06",
"installment_type":"principal",
"accrual_reference_date":null,
"total_accrual_amount":null,
"installment_history":[
],
"principal_amortization_amount":1856.85673048,
"calendar_days":30,
"qr_code_key":null,
"advanced_paid_amount":0,
"installment_key":"94db881b-0054-4c73-b969-89c37c082f39",
"bank_slip_key":null,
"due_interest":0
},
{
"original_pre_fixed_amount":461.25123635,
"qr_code_url":null,
"digitable_line":null,
"paid_at":null,
"due_principal":6369.49243064,
"installment_payment":[
],
"business_due_date":"2027-01-06",
"total_amount":2432.7,
"total_paid_amount":0,
"workdays":21,
"has_interest":true,
"original_due_principal":6369.49243064,
"fine_amount":null,
"installment_number":8,
"post_fixed_amount":0,
"additional_costs":[
],
"renegotiation_proposal_key":null,
"installment_status":"created",
"original_principal_amortization_amount":1971.44876365,
"tax_amount":46.7193928,
"bank_slip_key":null,
"due_interest":0,
"installment_history":[
],
"principal_amortization_amount":1971.44876365,
"calendar_days":31,
"qr_code_key":null,
"advanced_paid_amount":0,
"installment_key":"d32e9f02-426d-4861-ad5c-fe541d2a4b94",
"installment_type":"principal",
"accrual_reference_date":null,
"total_accrual_amount":null,
"pre_fixed_amount":461.25123635,
"paid_amount":0,
"original_total_amount":2432.7,
"due_date":"2027-01-06"
},
{
"due_date":"2027-02-06",
"paid_amount":0,
"pre_fixed_amount":318.48703317,
"original_total_amount":2432.7,
"total_accrual_amount":null,
"accrual_reference_date":null,
"installment_type":"principal",
"qr_code_key":null,
"installment_key":"0c6ef3ba-6d82-45e4-9f3f-9f9a89207f68",
"advanced_paid_amount":0,
"principal_amortization_amount":2114.21296683,
"installment_history":[
],
"calendar_days":31,
"due_interest":0,
"bank_slip_key":null,
"tax_amount":55.47694825,
"installment_status":"created",
"original_principal_amortization_amount":2114.21296683,
"renegotiation_proposal_key":null,
"fine_amount":null,
"post_fixed_amount":0,
"additional_costs":[
],
"installment_number":9,
"total_paid_amount":0,
"total_amount":2432.7,
"workdays":22,
"has_interest":true,
"original_due_principal":4398.04366699,
"business_due_date":"2027-02-10",
"installment_payment":[
],
"due_principal":4398.04366699,
"paid_at":null,
"qr_code_url":null,
"original_pre_fixed_amount":318.48703317,
"digitable_line":null
},
{
"installment_payment":[
],
"due_principal":2283.83070016,
"paid_at":null,
"qr_code_url":null,
"original_pre_fixed_amount":148.86929984,
"digitable_line":null,
"total_paid_amount":0,
"total_amount":2432.7,
"workdays":18,
"has_interest":true,
"original_due_principal":2283.83070016,
"business_due_date":"2027-03-08",
"renegotiation_proposal_key":null,
"fine_amount":null,
"post_fixed_amount":0,
"additional_costs":[
],
"installment_number":10,
"tax_amount":65.17139286,
"installment_status":"created",
"original_principal_amortization_amount":2283.83070016,
"due_interest":0,
"bank_slip_key":null,
"qr_code_key":null,
"installment_key":"470dd63a-89eb-4c6c-8cd6-f570d469aa35",
"advanced_paid_amount":0,
"principal_amortization_amount":2283.83070016,
"installment_history":[
],
"calendar_days":28,
"total_accrual_amount":null,
"accrual_reference_date":null,
"installment_type":"principal",
"due_date":"2027-03-06",
"paid_amount":0,
"pre_fixed_amount":148.86929984,
"original_total_amount":2432.7
}
],
"net_external_contract_fee_amount":0,
"number_of_installments":10
},
"status":"waiting_signature",
"event_datetime":"2026-04-08 05:52:52",
"key":"0773a1b1-675a-4a10-80a2-a10308c7281e",
"webhook_type":"debt"
}
Response Body
{
"data": "{\"title\": \"Bad Request\", \"description\": \"Invalid request body.\", \"translation\": \"Corpo da requisição inválido.\", \"extra_fields\": {}, \"code\": \"LEG000069\"}"
}
6. Technical Specifications and Enums
Fees Object
| Field | Type | Description |
|---|---|---|
| amount | float | Fee amount (in percentage or absolute value, depending on the value provided in the amount_type field) |
| amount_type | enum | Fee value unit |
| fee_amount | float | Absolute value of the fee charged in the operation |
| fee_type | string | Type of fee charged in the operation |
| type | string | Source of the fee charged in the operation |
Installments Object
| Field | Type | Description |
|---|---|---|
| calendar_days | integer | Number of calendar days between installments |
| due_date | string | Installment due date in calendar days |
| due_principal | float | Remaining principal on the installment due date before its payment |
| has_interest | boolean | true - If true, interest applies to the installment |
| installment_number | integer | Installment number |
| prefixed_amount | float | Fixed interest amount paid on the installment |
| principal_amortization_amount | float | Principal amount paid on the installment |
| tax_amount | float | Base IOF amount of installment |
| amount | float | Installment total value |
| due_interest | float | Remaining interest after the installment due date before its payment |
| period | float | Installment period |
| period_workdays | float | Installment period in business days |
| period_to_disbursement | float | Period until disbursement |
| period_workdays_to_disbursement | float | Business days until disbursement |
| calendar_days_to_disbursement | integer | Calendar days to disbursement |
| workdays | integer | Business days between installments |
| workdays_to_disbursement | integer | Business days until disbursement |
Interest Rate Object
| Field | Description |
|---|---|
| annual_rate | Annual fixed/floating interest rate expressed as a decimal |
| daily_rate | Daily fixed/floating interest rate expressed as a decimal |
| interest_base | Interest Base Enumerator - Interest calculation basis |
| monthly_rate | Monthly fixed/floating interest rate expressed as a decimal |
Tax Configuration Object
| Field | Description |
|---|---|
| base_rate | Base IOF rate value |
| additional_rate | Additional IOF rate value |
Enumeratores
Person Type Enumerator
| Enumerator | Description |
|---|---|
| legal | Legal person |
| natural | Natural person |
Account Type Enumerator
| Enumerator | Description |
|---|---|
| checking_account | Checking account |
Amount Type Enumerator
| Enumerator | Description |
|---|---|
| absolute | Absolute value |
| percentage | Percentage value |
Interest Type Enumerator
| Enumerator | Description |
|---|---|
| pre_price_days | Price amortization method (equal installments) with daily fixed-rate interest calculation |
| pre_price | Price amortization method (equal installments) with fixed-rate interest calculation over 30-day periods |
Credit Operation Type Enumerator
| Enumerator | Description |
|---|---|
| ccb | Bank Credit Note |
Interest Base Enumerator
| Enumerator | Description |
|---|---|
| workdays | Interest calculation basis in business days, assuming a 252-day year |
| calendar_days | Interest calculation basis in calendar days, assuming a 360-day year |
| calendar_days_365 | Interest calculation basis in calendar days, assuming a 365-day year |
Fee Type Enumerator
Each fee type must be previously enabled and configured by QI Tech
| Enumerator | Description |
|---|---|
| spread | Premium included in the credit operation's acquisition value |
| spread_ted_fee | Premium on the TED transfer fee |
Origin Type Enumerator
Each fee type must be previously enabled and configured by QI Tech
| Enumerator | Description |
|---|---|
| internal | Internal fee |
| external | External fee |