Homologation Roadmap - Credit Pay
Summary
1. Debt inquiry
You can query the debt later to retrieve information or track its current status:
Request
ENDPOINT
/v2/credit_operation/REQUESTER-IDENTIFIER-KEYMETHOD
GETPath params
| Field | Type | Description | Max. Char. |
|---|---|---|---|
requester_identifier_key * | string | Client tracking key for the request | UUID |
Response
STATUS
200Response 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
}
Response example (refinancing — refinanced_credit_operations)
For a refinancing credit operation, the GET response includes operation_type_enumerator: settlement_refinancing and the array refinanced_credit_operations, which lists the prior operation(s) being settled by this new contract. The example below uses final_disbursement_amount: 0 (no cash payout to the borrower—the new operation is sized to settle the prior obligation); see the note on final_disbursement_amount in this section.
Homologation / sample data
The payload below is a sandbox / homologation sample. UUIDs, contract numbers, monetary amounts, calendar dates, and document URLs are illustrative only. In production, rely on the field names and types, not on these literal values.
Response Body (refinancing)
{
"credit_operation_key":"7c106ebb-42b5-4f9d-afdb-d3cc7c7883d1",
"issue_amount":101.81,
"origin_key":"7c106ebb-42b5-4f9d-afdb-d3cc7c7883d1",
"total_iof":0.91,
"assigned_at":null,
"disbursement_start_date":"2026-04-15",
"disbursement_end_date":"2026-04-15",
"issue_date":"2026-04-15",
"requester_identifier_key":"7014211f-0d09-4db3-957a-c916903ec4d3",
"installments":[
{
"business_due_date":"2026-05-15",
"due_date":"2026-05-15",
"calendar_days":30,
"due_interest":0,
"due_principal":101.81,
"fine_amount":0,
"has_interest":true,
"post_fixed_amount":0,
"pre_fixed_amount":8.14,
"principal_amortization_amount":31.43,
"tax_amount":0.08,
"total_amount":39.57,
"workdays":20,
"accrual_reference_date":null,
"advanced_paid_amount":0,
"bank_slip_key":null,
"digitable_line":null,
"installment_key":"ffd81916-ce62-4b32-82b8-3c7cb7afde0a",
"installment_status":"opened",
"installment_type":"principal",
"original_due_principal":101.81,
"original_pre_fixed_amount":8.14,
"original_principal_amortization_amount":31.43,
"paid_amount":0,
"original_total_amount":39.57,
"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":"2026-04-16T01:30:36",
"principal_amortization_payment_amount":0,
"prefixed_interest_payment_amount":0
},
{
"business_due_date":"2026-06-15",
"due_date":"2026-06-15",
"calendar_days":31,
"due_interest":0,
"due_principal":70.38415074,
"fine_amount":0,
"has_interest":true,
"post_fixed_amount":0,
"pre_fixed_amount":5.83,
"principal_amortization_amount":33.74,
"tax_amount":0.17,
"total_amount":39.57,
"workdays":20,
"accrual_reference_date":null,
"advanced_paid_amount":0,
"bank_slip_key":null,
"digitable_line":null,
"installment_key":"4b41315b-d685-4646-b57f-107c00bf36e0",
"installment_status":"opened",
"installment_type":"principal",
"original_due_principal":70.38,
"original_pre_fixed_amount":5.83,
"original_principal_amortization_amount":33.74,
"paid_amount":0,
"original_total_amount":39.57,
"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":"2026-04-16T01:30:36",
"principal_amortization_payment_amount":0,
"prefixed_interest_payment_amount":0
},
{
"business_due_date":"2026-07-15",
"due_date":"2026-07-15",
"calendar_days":30,
"due_interest":0,
"due_principal":36.63949004,
"fine_amount":0,
"has_interest":true,
"post_fixed_amount":0,
"pre_fixed_amount":2.93,
"principal_amortization_amount":36.64,
"tax_amount":0.27,
"total_amount":39.57,
"workdays":22,
"accrual_reference_date":null,
"advanced_paid_amount":0,
"bank_slip_key":null,
"digitable_line":null,
"installment_key":"920af811-9d4c-4886-9095-73cc6f546f02",
"installment_status":"opened",
"installment_type":"principal",
"original_due_principal":36.64,
"original_pre_fixed_amount":2.93,
"original_principal_amortization_amount":36.64,
"paid_amount":0,
"original_total_amount":39.57,
"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":"2026-04-16T01:30:36",
"principal_amortization_payment_amount":0,
"prefixed_interest_payment_amount":0
}
],
"first_due_date":"2026-05-15",
"requester_key":"3e69b448-9afb-4aef-9c0d-0a3059350d80",
"original_total_iof":null,
"contract_number":"0000667215/NDR",
"credit_operation_status_enumerator":"opened",
"operation_type_enumerator":"settlement_refinancing",
"disbursement_date":"2026-04-15",
"issuer_name":"NOME DO REPRESENTANTE",
"issuer_document_number":"31057466093",
"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":8.62,
"annual_cet":169.6,
"final_disbursement_amount":0,
"number_of_installments":3,
"disbursement_issue_amount":100.9,
"prefixed_interest_rate":{
"annual_rate":1.5181701168,
"daily_rate":0.0025686614,
"interest_base":{
"enumerator":"calendar_days",
"year_days":360
},
"monthly_rate":0.08
},
"fine_configuration":{
"contract_fine_rate":0.02,
"fine_delay_rate":{
"annual_rate":0.12682503,
"daily_rate":0.00032719,
"interest_base":{
"enumerator":"calendar_days_365",
"year_days":365
},
"monthly_rate":0.01
}
},
"attached_documents":[
{
"document_key":"a3749ce5-750a-4a1a-a22c-5966e9d13885",
"document_url":"https://storage.googleapis.com/sandbox-doc-api-private/documents/a3749ce5-750a-4a1a-a22c-5966e9d13885/CASTELLOBNPL-NOME_DO_REPRESENTANTE-CCB-0000667215-20260416013033.pdf",
"signature_url":"https://storage.googleapis.com/sandbox-doc-api-private/documents/a3749ce5-750a-4a1a-a22c-5966e9d13885/CASTELLOBNPL-NOME_DO_REPRESENTANTE-CCB-0000667215-20260416013033_signed.pdf",
"document_type":"ccb_pre_price_days",
"signature_required":true,
"signed":true
}
],
"related_parties":[
{
"related_party_key":"bb7ab0e0-04f5-4814-901f-e44a6eb0b243",
"role_type":"issuer",
"person_type":"natural",
"name":"NOME DO REPRESENTANTE",
"email":"2210@test.com",
"individual_document_number":"31057466093"
}
],
"base_iof":0.52,
"additional_iof":0.39,
"assignment_amount":102.42,
"created_at":"2026-04-16T01:30:33Z",
"total_prefixed_amount":16.9,
"refinanced_credit_operations":[
{
"refinanced_credit_operation_key":"a0c66c34-404a-4391-b0d1-7c109329b808",
"refinanced_contract_number":"0000667214/NDR",
"due_balance":100.9,
"due_balance_reference_date":"2026-04-15",
"original_deadline":91,
"refinanced_credit_operation_status_enumerator":"pending_payment",
"updated_at":"2026-04-16T01:30:33",
"created_at":"2026-04-16T01:30:33"
}
]
}
refinanced_credit_operationsEach object describes a prior credit operation included in this refinancing: refinanced_credit_operation_key and refinanced_contract_number identify it; due_balance and due_balance_reference_date are the payoff context used when structuring the new contract; refinanced_credit_operation_status_enumerator is the status of that refinanced operation at the time of the inquiry (not necessarily the new operation’s status). original_deadline refers to the prior operation’s term where applicable.
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.
final_disbursement_amountfinal_disbursement_amount is the effective disbursement of the new credit operation. When there is no net amount paid to the borrower (no cash payout from the new loan), the platform does not rely on a separately informed disbursement: it computes the due balance (payoff) of the refinanced loan(s), and that amount is used as the disbursed amount of the new loan—the new operation is sized to settle the prior obligation.
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 only installment_key on each installment in operations[].installments[] for simulation. Per-installment paid_amount and discount_amount are not used on batch_proposal_simulation—they are required on POST /renegotiation/batch_proposal (see §3).
Attention
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
ENDPOINT
/renegotiation/batch_proposal_simulationMETHOD
POSTWarning
The discount_amount and discount_percentage fields must not be sent together in the same payload (root level).
Note
At the root, discount_amount and discount_percentage are mutually exclusive global discount options for the simulation payload. Per-installment paid_amount and discount_amount are documented under POST /renegotiation/batch_proposal only.
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"
}
]
},
{
"debt_key": "2cbfb9b1-1fdb-5f8d-9967-b338e5eb83f9",
"installments": [
{
"installment_key": "2ef25ed8-7124-44f5-9e3d-1d1a7196166e"
}
]
}
]
}
Response
Example response (batch_proposal_simulation)
batch_proposal_simulation){
"batch_proposal_key": "429fd784-e13e-47a1-ad9f-291209e0e621",
"discount_percentage": 0,
"discount_amount": 20,
"amortization_type": "present_amount",
"payment_amount": 78389.55,
"requester_name": "Castello (BNPL)",
"requester_key": "3e69b448-9afb-4aef-9c0d-0a3059350d80",
"issuer_name": "Alan Mathison Turing",
"reference_date": "2026-04-11",
"issuer_document_number": "82744088021",
"operations": [
{
"requester_key": "3e69b448-9afb-4aef-9c0d-0a3059350d80",
"contract_number": "TEST00790",
"payment_amount": 78389.55,
"discount_amount": 20,
"origin_key": null,
"affected_installments": [
{
"installment_key": "24b5deae-304e-4773-9b25-e42dbd450241",
"due_date": "2026-05-10",
"principal_amount": 73107.75725415,
"interest_amount": 10580.11274585,
"fine_amount": 0,
"total_amount": 83687.87,
"present_amount": 78389.55,
"paid_amount": 78389.55,
"principal_amortization_payment_amount": 78048.3,
"prefixed_interest_payment_amount": 341.25,
"fine_payment_amount": 0,
"discount_amount": 0
}
],
"remaining_installments": [
{
"installment_key": "2b1d9423-4dab-44b3-bf8c-efc8433176dd",
"due_date": "2026-06-10",
"principal_amount": 73096.23,
"interest_amount": 10591.64,
"fine_amount": 0,
"total_amount": 83687.87
}
],
"debt_key": "388c47fa-6c6c-4d2b-8f00-ccc2d571fcb0"
}
]
}
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 |
force_due_date | boolean | Optional. When true, installments whose reference_date falls within the shift window [due_date, business_due_date] (business_due_date > due_date, e.g. weekend/holiday rollover) are priced at face value using the installment's own due_date as reference — no accrued interest, no delay fine. Default false. See Force due date behavior. | — |
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 |
Amortization type values
| Value | Description |
|---|---|
| present_amount | Simulation with present value per installment: each installments[] entry includes installment_key only. paid_amount / discount_amount are not sent on this endpoint—use batch_proposal for those fields. |
Force due date behavior
When force_due_date is true, the API applies a shift-window rule to each installment:
- If
business_due_date > due_date(i.e. there is a weekend/holiday rollover) andreference_datefalls within[due_date, business_due_date], the installment is treated as not yet due and priced at face value using its owndue_dateas reference. Interest does not accrue for the days betweendue_dateandreference_date, and no delay fine is charged. - Otherwise (no shift, or
reference_dateoutside the window) the installment behaves as usual (overdue or not overdue).
Typical use case: the client wants to pay on Sunday installments that fell on Saturday. Without the flag, one day of interest accrues; with the flag, only the face value is charged. The flag is opt-in and defaults to false — omitting it preserves the current behavior.
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.
Attention
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
ENDPOINT
/renegotiation/batch_proposalMETHOD
POSTPaid amount and discount amount (installments)
For POST /renegotiation/batch_proposal only: when amortization_type is present_amount, each object in operations[].installments[] must include these fields (in addition to installment_key):
| Field | Type | Description | Max length |
|---|---|---|---|
paid_amount | float | Amount paid or allocated on that installment (BRL). Required when amortization_type is present_amount. | 15,2 |
discount_amount | float | Discount in BRL applied to that installment. Required when amortization_type is present_amount; use 0 if there is no discount. Optional per installment for other amortization types, when applicable. | 15,2 |
Warning
The discount_amount and discount_percentage fields must not be sent together in the same payload (root level).
Note
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
}
]
}
]
}
Response
STATUS
200Example response body (batch_proposal)
batch_proposal){
"batch_proposal_key": "37879d40-c16e-4d7f-a16f-d79d20c50d42",
"discount_percentage": 0,
"discount_amount": 20,
"amortization_type": "present_amount",
"payment_amount": 78206.27,
"requester_name": "Castello (BNPL)",
"requester_key": "3e69b448-9afb-4aef-9c0d-0a3059350d80",
"issuer_name": "Alan Mathison Turing",
"reference_date": "2026-04-11",
"issuer_document_number": "82744088021",
"batch_proposal_status": "pending_payment",
"proposal_due_date": "2026-04-11",
"payment_type": "pix",
"request_control_key": "37879d40-c16e-4d7f-a16f-d79d20c50d42",
"origin_key": null,
"operations": [
{
"requester_key": "3e69b448-9afb-4aef-9c0d-0a3059350d80",
"contract_number": "TEST1570594223",
"payment_amount": 78206.27,
"discount_amount": 20,
"origin_key": null,
"affected_installments": [
{
"installment_key": "1162e382-8bd6-4c0b-9111-8390d9794102",
"due_date": "2026-05-10",
"principal_amount": 73277.29,
"interest_amount": 10214.91,
"fine_amount": 0,
"total_amount": 83492.2,
"present_amount": 78206.27,
"paid_amount": 78206.27,
"principal_amortization_payment_amount": 78206.27,
"prefixed_interest_payment_amount": 0,
"fine_payment_amount": 0,
"discount_amount": 0
}
],
"remaining_installments": [
{
"installment_key": "58eea645-5682-440d-aa6b-a3b124253684",
"due_date": "2026-06-10",
"principal_amount": 72925.33,
"interest_amount": 10566.87,
"fine_amount": 0,
"total_amount": 83492.2
}
],
"debt_key": "6564493d-75c3-4efe-9f11-82fa5cff9a78"
}
],
"payment": {
"digitable_line": null,
"qr_code_url": "00020126930014br.gov.bcb.pix2571qrcode-h.sandbox.qitech.app/bacen/cobv/426661142f5d4cd9954dcae3725d020d5204000053039865802BR5925QISOCIEDADEDECREDITODIRET6008SaoPaulo61080145200062070503***6304B878",
"qr_code_key": "42666114-2f5d-4cd9-954d-cae3725d020d",
"bank_slip_key": null,
"paid_method_type": "pix",
"source_account_key": null,
"payment_data": {
"creditor_bank_account_key": "6108dd45-580d-48c4-b3bb-74c1e843be49",
"batch_renegotiation_proposal_key": "37879d40-c16e-4d7f-a16f-d79d20c50d42"
}
}
}
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 |
force_due_date | boolean | Optional. When true, installments in the shift window [due_date, business_due_date] (business_due_date > due_date) are charged at face value using their own due_date as reference — no accrued interest, no delay fine. Default false. See Force due date behavior. | — |
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 | Required for present_amount. See Paid amount and discount amount. | 15,2 |
discount_amount | float | Required for present_amount. See Paid amount and discount amount. | 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. |
4. Renegotiation — Delete batch proposal
Overview
DELETE /renegotiation/batch_proposal/{request_control_key} cancels or deletes a batch renegotiation proposal that is not finalized or is still in a cancellable state. The proposal is marked canceled/deleted and any associated payment methods (bank slip, Pix, etc.) are invalidated.
Pass the same request_control_key you used when creating the batch with POST /renegotiation/batch_proposal (optional field on the create payload). If your integration maps this route to another identifier, follow your contract; the path parameter name in the API is request_control_key.
Request
ENDPOINT
/renegotiation/batch_proposal/{request_control_key}METHOD
DELETEResponse
STATUS
200Example response body
{}
5. Refinancing simulation
Request
ENDPOINT
/debt_simulationMETHOD
POSTRequest Body
{
"borrower": {
"person_type": "natural"
},
"refinanced_credit_operations": [
{
"operation_key": "89b5c27e-b291-4414-abb0-f5f15c06c82b"
}
],
"financial": {
"final_disbursement_amount": 0,
"disbursement_amount": 0,
"interest_type": "pre_price_days",
"credit_operation_type": "ccb",
"annual_interest_rate": 2.32,
"disbursement_date": "2023-04-01",
"first_due_date": "2023-05-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
}
}
}
final_disbursement_amount (financial)You may send final_disbursement_amount as 0 when you are not specifying a cash disbursement to the borrower. In that case, the simulation derives the disbursed amount of the new loan from the due balance (payoff) of the refinanced operation(s)—the same rule as in debt inquiry for final_disbursement_amount: the new credit is sized from what is owed on the previous loan(s), not from a user-defined payout amount.
Attention
Send borrower, financial, and refinanced_credit_operations with operation_key for each operation to refinance. See Definitions (refinancing simulation).
Response
STATUS
200Response Body
{
"type":"debt",
"key":"938351f9-511c-4ccb-9e09-35ebc8f1af2f",
"status":"finished",
"event_datetime":"2026-04-09 03:21:09",
"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":0,
"refinanced_credit_operations":[
{
"refinanced_credit_operation_key":"89b5c27e-b291-4414-abb0-f5f15c06c82b",
"refinanced_credit_operation_status":"pending_payment",
"due_balance":15114.45,
"due_balance_reference_date":"2023-04-01",
"original_deadline":61
}
],
"total_pre_fixed_amount":2434.45,
"iof_amount":115.62,
"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":15230.07,
"has_interest":true,
"post_fixed_amount":0,
"pre_fixed_amount":1578.66550979,
"tax_amount":17.84384245,
"total_amount":8832.26,
"principal_amortization_amount":7253.59449021,
"installment_number":1
},
{
"calendar_days":31,
"workdays":23,
"business_due_date":"2023-06-01",
"due_date":"2023-06-01",
"due_principal":7976.47550979,
"has_interest":true,
"post_fixed_amount":0,
"pre_fixed_amount":855.78449021,
"tax_amount":39.8983305,
"total_amount":8832.26,
"principal_amortization_amount":7976.47550979,
"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":45.69,
"external_contract_fee_amount":0,
"net_external_contract_fee_amount":0,
"contract_fees":[
{
"fee_type":"spread",
"amount_type":"percentage",
"amount":0.3,
"fee_amount":45.69
}
],
"issue_amount":15230.07,
"disbursed_issue_amount":15114.45,
"assignment_amount":15275.76,
"disbursement_options":[
{
"iof_amount":115.62,
"total_pre_fixed_amount":2434.45,
"cet":0.1109,
"annual_cet":2.5332,
"contract_fees":[
{
"fee_type":"spread",
"amount_type":"percentage",
"amount":0.3,
"fee_amount":45.69
}
],
"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":45.69,
"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":15230.07,
"has_interest":true,
"post_fixed_amount":0,
"pre_fixed_amount":1578.66550979,
"tax_amount":17.84384245,
"total_amount":8832.26,
"principal_amortization_amount":7253.59449021,
"installment_number":1
},
{
"calendar_days":31,
"workdays":23,
"business_due_date":"2023-06-01",
"due_date":"2023-06-01",
"due_principal":7976.47550979,
"has_interest":true,
"post_fixed_amount":0,
"pre_fixed_amount":855.78449021,
"tax_amount":39.8983305,
"total_amount":8832.26,
"principal_amortization_amount":7976.47550979,
"installment_number":2
}
],
"issue_amount":15230.07,
"disbursed_issue_amount":15114.45,
"assignment_amount":15275.76,
"final_disbursement_amount":0,
"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":"89b5c27e-b291-4414-abb0-f5f15c06c82b",
"refinanced_credit_operation_status":"pending_payment",
"due_balance":15114.45,
"due_balance_reference_date":"2023-04-01",
"original_deadline":61
}
]
}
]
}
}
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 |
|---|---|---|
| final_disbursement_amount | float | Effective disbursement of the new operation (when not a cash payout to the borrower, sizing follows due balance of refinanced loan(s)—see §1 and §5). |
| 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 |
6. Standard loan (normal flow) — POST /signed_debt
Standard issuance uses POST /signed_debt without refinanced_credit_operations. The financial object carries the disbursed principal via disbursed_amount (cash payout to the borrower). Field shapes for borrower, additional_data.contract (opt-in signatures), disbursement_bank_accounts, and other objects follow the same definitions as in §7. Creating a refinancing—omit refinanced_credit_operations and use disbursed_amount instead of sizing from refinanced operations.
Request
ENDPOINT
/signed_debtMETHOD
POSTRequest Body
{
"additional_data": {
"contract": {
"contract_number": null,
"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": 2,
"credit_operation_type": "ccb",
"interest_type": "pre_price_days",
"monthly_interest_rate": 0.07,
"disbursed_amount": 150000,
"fine_configuration": {
"contract_fine_rate": 0.02,
"monthly_rate": 0.15,
"interest_base": "calendar_days"
},
"interest_grace_period": 0,
"disbursement_date": "2026-04-11",
"first_due_date": "2026-05-10",
"principal_grace_period": 0
},
"purchaser_document_number": "32402502000135",
"requester_identifier_key": null,
"document_template_key": "518a0b57-2ce3-4309-94e5-6a95bc056d12",
"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": "82744088021",
"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"
},
"disbursement_bank_accounts": [
{
"name": "NOME DEVEDOR",
"bank_code": "001",
"account_digit": "0",
"branch_number": "2874",
"account_number": "000057555",
"document_number": "82744088021",
"transfer_method": "pix",
"percentage_receivable": 100
}
]
}
Response (HTTP 200)
The synchronous response echoes the request body with fields completed by the platform (for example contract.contract_number and requester_identifier_key).
STATUS
200Response Body
{
"additional_data": {
"contract": {
"contract_number": "TEST7886216399",
"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": 2,
"credit_operation_type": "ccb",
"interest_type": "pre_price_days",
"monthly_interest_rate": 0.07,
"disbursed_amount": 150000,
"fine_configuration": {
"contract_fine_rate": 0.02,
"monthly_rate": 0.15,
"interest_base": "calendar_days"
},
"interest_grace_period": 0,
"disbursement_date": "2026-04-11",
"first_due_date": "2026-05-10",
"principal_grace_period": 0
},
"purchaser_document_number": "32402502000135",
"requester_identifier_key": "2a55c1a76af4",
"document_template_key": "518a0b57-2ce3-4309-94e5-6a95bc056d12",
"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": "82744088021",
"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"
},
"disbursement_bank_accounts": [
{
"name": "NOME DEVEDOR",
"bank_code": "001",
"account_digit": "0",
"branch_number": "2874",
"account_number": "000057555",
"document_number": "82744088021",
"transfer_method": "pix",
"percentage_receivable": 100
}
]
}
Webhook body
{
"webhook_type": "debt",
"key": "4e1ed268-9f29-44ce-9991-3bdf036aeacd",
"status": "waiting_disbursement",
"event_datetime": "2026-04-14 03:38:14",
"data": {
"borrower": {
"name": "Alan Mathison Turing",
"document_number": "82744088021",
"related_party_key": "71b28fde-5d75-48b4-9c3f-ee531dccac66"
},
"contract": {
"document_key": null,
"number": "TEST7886216399",
"urls": [],
"signature_information": [
{
"signer_name": "Alan Mathison Turing",
"signer_document_number": "82744088021",
"signer_role": "issuer",
"signer_email": null,
"signer_external_key": null,
"signature_url": null
}
]
},
"requester_identifier_key": "2a55c1a76af4",
"iof_charge_method": "financed",
"collaterals": [],
"contract_fees": [
{
"fee_type": "spread",
"fee_amount": 453.39
}
],
"external_contract_fees": [
{
"fee_type": "tac",
"fee_amount": 0,
"tax_amount": 0,
"net_fee_amount": 0
}
],
"external_contract_fee_amount": 0,
"net_external_contract_fee_amount": 0,
"contract_fee_amount": 453.39,
"issue_amount": 151131.6,
"assignment_amount": 151584.99,
"cet": "7,6600%",
"annual_cet": "142,4473%",
"number_of_installments": 2,
"base_iof": 557.3,
"additional_iof": 574.3,
"total_iof": 1131.6,
"ipoc_code": "324025020203182744088021TEST7886216399",
"prefixed_interest_rate": {
"annual_rate": 1.252191589,
"created_at": "2026-04-14T03:38:10",
"daily_rate": 0.0022578334,
"interest_base": "calendar_days",
"monthly_rate": 0.07
},
"installments": [
{
"accrual_reference_date": null,
"additional_costs": [],
"advanced_paid_amount": 0,
"bank_slip_key": null,
"business_due_date": "2026-05-11",
"calendar_days": 29,
"digitable_line": null,
"due_date": "2026-05-10",
"due_interest": 0,
"due_principal": 151131.6,
"fine_amount": null,
"has_interest": true,
"installment_history": [],
"installment_key": "c00dbecc-efb9-4384-8db3-dadba82f2d70",
"installment_number": 1,
"installment_payment": [],
"installment_status": "created",
"installment_type": "principal",
"original_due_principal": 151131.6,
"original_pre_fixed_amount": 10214.91484159,
"original_principal_amortization_amount": 73277.28515841,
"original_total_amount": 83492.2,
"paid_amount": 0,
"paid_at": null,
"post_fixed_amount": 0,
"pre_fixed_amount": 10214.91484159,
"principal_amortization_amount": 73277.28515841,
"qr_code_key": null,
"qr_code_url": null,
"renegotiation_proposal_key": null,
"tax_amount": 174.25338411,
"total_accrual_amount": null,
"total_amount": 83492.2,
"total_paid_amount": 0,
"workdays": 18
},
{
"accrual_reference_date": null,
"additional_costs": [],
"advanced_paid_amount": 0,
"bank_slip_key": null,
"business_due_date": "2026-06-10",
"calendar_days": 31,
"digitable_line": null,
"due_date": "2026-06-10",
"due_interest": 0,
"due_principal": 77854.31484159,
"fine_amount": null,
"has_interest": true,
"installment_history": [],
"installment_key": "d3a2f42d-80cb-4891-b2be-ce80ffd383b2",
"installment_number": 2,
"installment_payment": [],
"installment_status": "created",
"installment_type": "principal",
"original_due_principal": 77854.31484159,
"original_pre_fixed_amount": 5637.88515841,
"original_principal_amortization_amount": 77854.31484159,
"original_total_amount": 83492.2,
"paid_amount": 0,
"paid_at": null,
"post_fixed_amount": 0,
"pre_fixed_amount": 5637.88515841,
"principal_amortization_amount": 77854.31484159,
"qr_code_key": null,
"qr_code_url": null,
"renegotiation_proposal_key": null,
"tax_amount": 383.04322902,
"total_accrual_amount": null,
"total_amount": 83492.2,
"total_paid_amount": 0,
"workdays": 22
}
],
"total_pre_fixed_amount": 15852.8
}
}
7. Creating a refinancing
Request
ENDPOINT
/signed_debtMETHOD
POSTRequest Body
{
"additional_data": {
"contract": {
"contract_number": "TEST00007890",
"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": 2,
"credit_operation_type": "ccb",
"interest_type": "pre_price_days",
"monthly_interest_rate": 0.07,
"final_disbursement_amount": 0,
"fine_configuration": {
"contract_fine_rate": 0.02,
"monthly_rate": 0.15,
"interest_base": "calendar_days"
},
"interest_grace_period": 0,
"disbursement_date": "2026-04-08",
"first_due_date": "2026-05-08",
"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": "494598fd2009078709098",
"refinanced_credit_operations": [
{
"operation_key": "067c421d-9ba1-4d4f-bf98-eb39dd12a5a5",
"due_balance": 1000
}
],
"document_template_key": "518a0b57-2ce3-4309-94e5-6a95bc056d12",
"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"
}
}
Attention
Refinancing creation uses the same POST /signed_debt endpoint as §6. Standard loan (normal flow), 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 |
|---|---|---|---|
| final_disbursement_amount * | float | Effective disbursement of the credit operation (when not a cash payout to the borrower, sizing follows due balance of refinanced loan(s)—see §1 and §5). | - |
| 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 |
due_balance | number | Payoff amount of the operation to settle (optional, ≥ 0) | - |
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
STATUS
200Response Body
{
"webhook_type": "debt",
"key": "f6c9c359-217a-475b-b2bc-540402d0c720",
"status": "waiting_signature",
"event_datetime": "2026-04-09 03:14:55",
"data": {
"borrower": {
"name": "Alan Mathison Turing",
"document_number": "47003534819",
"related_party_key": "f606243a-6d6b-4de8-984e-0364fffe50cc"
},
"contract": {
"document_key": "6f8ecbba-c7ed-482e-81f7-717a91b8c5cb",
"number": "TEST00007890",
"urls": [
"https://storage.googleapis.com/sandbox-doc-api-private/documents/6f8ecbba-c7ed-482e-81f7-717a91b8c5cb/CASTELLOBNPL-ALAN_MATHISON_TURING-CCB0260409031449.pdf"
],
"signature_information": [
{
"signer_name": "Alan Mathison Turing",
"signer_document_number": "47003534819",
"signer_role": "issuer",
"signer_email": null,
"signer_external_key": null,
"signature_url": null
}
]
},
"requester_identifier_key": "494598fd2009078709098",
"iof_charge_method": "financed",
"collaterals": [],
"contract_fees": [
{
"fee_type": "spread",
"fee_amount": 30.46
},
{
"fee_type": "spread_refinancing",
"fee_amount": 30.23
}
],
"external_contract_fees": [
{
"fee_type": "tac",
"fee_amount": 0,
"tax_amount": 0,
"net_fee_amount": 0
}
],
"external_contract_fee_amount": 0,
"net_external_contract_fee_amount": 0,
"contract_fee_amount": 60.69,
"issue_amount": 10153.18,
"assignment_amount": 10213.87,
"cet": "7,6500%",
"annual_cet": "142,2787%",
"number_of_installments": 2,
"base_iof": 38.3,
"additional_iof": 38.58,
"total_iof": 76.88,
"ipoc_code": "324025020203147003534819TEST00007890",
"prefixed_interest_rate": {
"annual_rate": 1.252191589,
"created_at": "2026-04-09T03:14:49",
"daily_rate": 0.0022578334,
"interest_base": "calendar_days",
"monthly_rate": 0.07
},
"installments": [
{
"accrual_reference_date": null,
"additional_costs": [],
"advanced_paid_amount": 0,
"bank_slip_key": null,
"business_due_date": "2026-05-08",
"calendar_days": 30,
"digitable_line": null,
"due_date": "2026-05-08",
"due_interest": 0,
"due_principal": 10153.18,
"fine_amount": null,
"has_interest": true,
"installment_history": [],
"installment_key": "5359d7b1-8952-42e4-89bd-7fc57ac304aa",
"installment_number": 1,
"installment_payment": [],
"installment_status": "created",
"installment_type": "principal",
"original_due_principal": 10153.18,
"original_pre_fixed_amount": 710.7240611,
"original_principal_amortization_amount": 4911.0359389,
"original_total_amount": 5621.76,
"paid_amount": 0,
"paid_at": null,
"post_fixed_amount": 0,
"pre_fixed_amount": 710.7240611,
"principal_amortization_amount": 4911.0359389,
"qr_code_key": null,
"qr_code_url": null,
"renegotiation_proposal_key": null,
"tax_amount": 12.08114841,
"total_accrual_amount": null,
"total_amount": 5621.76,
"total_paid_amount": 0,
"workdays": 20
},
{
"accrual_reference_date": null,
"additional_costs": [],
"advanced_paid_amount": 0,
"bank_slip_key": null,
"business_due_date": "2026-06-08",
"calendar_days": 31,
"digitable_line": null,
"due_date": "2026-06-08",
"due_interest": 0,
"due_principal": 5242.1440611,
"fine_amount": null,
"has_interest": true,
"installment_history": [],
"installment_key": "02ad962c-22b7-49ab-bdb3-99f30758a254",
"installment_number": 2,
"installment_payment": [],
"installment_status": "created",
"installment_type": "principal",
"original_due_principal": 5242.1440611,
"original_pre_fixed_amount": 379.6159389,
"original_principal_amortization_amount": 5242.1440611,
"original_total_amount": 5621.76,
"paid_amount": 0,
"paid_at": null,
"post_fixed_amount": 0,
"pre_fixed_amount": 379.6159389,
"principal_amortization_amount": 5242.1440611,
"qr_code_key": null,
"qr_code_url": null,
"renegotiation_proposal_key": null,
"tax_amount": 26.22120459,
"total_accrual_amount": null,
"total_amount": 5621.76,
"total_paid_amount": 0,
"workdays": 20
}
],
"total_pre_fixed_amount": 1090.34
}
}
STATUS
400Response Body
{
"data": "{\"title\": \"Bad Request\", \"description\": \"Invalid request body.\", \"translation\": \"Corpo da requisição inválido.\", \"extra_fields\": {}, \"code\": \"LEG000069\"}"
}
8. 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 |
9. Webhooks — batch renegotiation
These events notify your systems when a batch renegotiation proposal (created via POST /renegotiation/batch_proposal) reaches a relevant lifecycle state—for example after payment (status: paid) or when the proposal is rejected (status: rejected).
webhook_type: renegotiation.batch_proposal
Use this payload to reconcile batch_proposal_status, payment method, and amounts with your internal records for the request_control_key / batch_proposal_key you track from creation.
Attention
A batch renegotiation proposal may move to rejected when the payment window expires without settlement, or when an installment is paid outside the batch renegotiation (invalidating the proposal). Treat status accordingly and use key as batch_proposal_key.
Example payload (status: paid)
paid){
"key": "217bf9ba-65e0-4416-8f5e-ef423d72b23c",
"data": {
"paid_in": {
"ispb": "32402502",
"name": "QI SOCIEDADE DE CRÉDITO DIRETO S.A.",
"code_number": 329
},
"paid_method_type": "pix"
},
"status": "paid",
"webhook_type": "renegotiation.batch_proposal",
"event_datetime": "2025-09-30 13:42:58"
}
Example payload (status: rejected)
rejected){
"key": "217bf9ba-65e0-4416-8f5e-ef423d72b23c",
"data": {},
"status": "rejected",
"webhook_type": "renegotiation.batch_proposal",
"event_datetime": "2025-09-30 13:42:58"
}
10. API error codes — renegotiation (reference)
The following code values may appear in error responses from renegotiation-related endpoints (batch proposal, single proposal, etc.), aligned with the service exception classes below. title and http_status follow each class; description and translation are the English and Portuguese messages returned by the API.
General (QIT*)
| Code | HTTP | Exception class | Description (EN) | Translation (PT) |
|---|---|---|---|---|
QIT000001 | 400 | InvalidSchema | Payload validation message (variable). | Payload Inválido |
QIT000002 | 403 | ForbiddenNotMaster | You are not allowed to perform this action at this endpoint. | Você não está autorizado a performar esta ação neste endpoint. |
QIT000003 | 403 | ForbiddenInexistentRequester | This service cannot process requests without a 'SELECTED-AGENT' | Esse serviço não pode processar requisições sem o Header 'SELECTED-AGENT' |
QIT000004 | 403 | ForbiddenNotInternal | Request must be internal | Requisição precisa ser interna |
QIT000005 | 403 | ForbiddenSelectedAgentNotTheSameAsPersonKey | Selected agent and person key are different. | Agente da operação é diferente da chave do usuário. |
QIT000404 | 404 | NotFoundResource | The requested resource could not be found but may be available in the future. Subsequent requests by the client are permissible. | O resource solicitado não podee ser encontrado, mas pode estar disponível no futuro. Requests subsequentes do cliente são permitidos. |
Renegotiation (RN*)
| Code | HTTP | Exception class | Description (EN) | Translation (PT) |
|---|---|---|---|---|
RN0000001 | 400 | InvalidOperationStatus | Credit operation status is invalid for this request. Status: {status} | O status dessa operação de crédito é invalido para essa requisição. Status: {status} |
RN0000002 | 400 | InvalidInstallmentStatus | Installment status is invalid for this request. Installment key: {installment_key} | O status dessa parcela é invalido para essa requisição. Installment key: {installment_key} |
RN0000003 | 404 | InstallmentNotFound | No installment found for received installment keys. | Nenhuma parcela encontrada para as installment keys recebidas. |
RN0000004 | 400 | PercentageDiscountField | The percentage discount amount must be less than or equal to 1. | O valor do desconto percentual deve ser menor ou igual a 1. |
RN0000005 | 400 | DiscountValue | The discount amount cannot be greater than the the installments values. | O valor do desconto não pode ser maior do que o valor das parcelas. |
RN0000006 | 400 | DuplicateInstallmentKey | The same installment key was informed more than once. Installment Key: {installment_key} | A mesma installment_key foi informada mais de uma vez. Installment Key: {installment_key} |
RN0000007 | 400 | PaidAmount | Installment doesn't have paid_amount field. Installment_key: {installment_key} | Parcela não possui campo paid_amount. Installment_key: {installment_key} |
RN0000008 | 400 | ProposalWithoutPayment | Proposal must have a payment linked to it. | A proposta deve ter um pagamento vinculado a ela. |
RN0000009 | 403 | ForbiddenInvalidRequester | The requester informed is not the same as the credit operation. | O solicitante informado não é o mesmo da operação de crédito. |
RN0000010 | 404 | ProposalNotFound | Proposal not found. | Proposta não encontrada. |
RN0000011 | 400 | ProposalNotCancelable | Proposal cannot be canceled in current status. Status: {status} | Proposta não pode ser cancelada no status atual. Status: {status} |
RN0000012 | 404 | NotFoundCreditOperation | Credit Operation not found for sent contract number. | Operação de credito não encontrada pelo número de contrato enviado. |
RN0000013 | 404 | NotFoundPaymentEngine | The payment engine has not been found. | O mecanismo de pagamento não foi encontrado. |
RN0000014 | 404 | NotFoundRequesterProfile | The requester profile has not been found. | O perfil de solicitante não foi encontrado. |
RN0000015 | 400 | InvalidDate | Proposal due date or reference date cannot be in past. | A data de vencimento da renegociação ou a data de referência não podem estar no passado. |
RN0000016 | 404 | NotFoundRequesterConfiguration | The requester configuration has not been found. | A configuração de solicitante não foi encontrada. |
RN0000017 | 400 | CannotBePaid | The proposal cannot be paid in current status. Proposal Status: {status} | A renegociação não pode ser paga no status atual. Proposal Status: {status} |
RN0000018 | 400 | BankSlipRegistrationRejected | The bank slip registration has been rejected. | O registro do boleto bancário foi rejeitado. |
RN0000019 | 409 | SimilarProposalExists | This contract is already linked to another proposal in progress. | Esse contrato ja está vinculado a outra proposta em andamento. |
RN0000020 | 400 | InvalidRenegotiation | Renegotiation request invalid due to credit operation status. | A requisição de renegociação é inválida devido ao status da operação de crédito. |
RN0000021 | 400 | RenegotiationOperationNumber | Number of operations is greater than the maximum allowed. Maximum operations allowed: {maximum_operations} | Número de operações é maior que o máximo permitido. Máximo de operações permitidas: {maximum_operations} |
RN0000022 | 400 | DifferentIssuersBatchRenegotiation | It is not possible to carry out a batch renegotiation with different issuers. | Não é possível realizar uma renegociação em lote com emissores diferentes. |
RN0000024 | 404 | BatchProposalNotFound | Batch proposal not found. | Batch proposal não encontrada. |
RN0000025 | 400 | BatchProposalNotCancelable | Batch Proposal cannot be canceled in current status. Status: {status} | Proposta em lote não pode ser cancelada no status atual. Status: {status} |
RN0000026 | 400 | DuplicatedBatchProposalRequesterIdentifierKey | Requester identifier key is already been used for another batch proposal. | Requester identifier key ja está sendo utilizada para outra proposta em lote. |
RN0000027 | 400 | DiscountValueBatchProposal | The discount amount cannot be greater than the batch proposal payment amount: {payment_amount}. | O valor do desconto não pode ser maior do que o valor de pagamento da renegociação em lote: {payment_amount}. |
RN0000028 | 400 | InvalidInstallmentsForCollateralRenegotiation | Selected Installments for renegotiation must include the latest due dates. | As parcelas selecionadas para renegociação devem incluir as últimas datas de vencimento. |
RN0000029 | 400 | InvalidAmortizationTypeForCollateralRenegotiation | Amortization Type of collateral renegotiation must be Installment Payment. | O tipo de amortização para a renegociação com colateral deve ser pagamento de parcelas. |
RN0000030 | 400 | InvalidDisbursementAmountPayload | Discount amount field can't be informed for batch proposal and operations in same request. | O campo de valor de desconto não pode ser informado para a batch proposal e para as operações na mesma requisição. |
RN0000031 | 400 | InstallmentAmountZero | Installment payment amount can't be 0. Installment_key: {installment_key} | Valor de pagamento da parcela não pode ser 0. Installment_key: {installment_key} |
RN0000032 | 400 | PaymentAmountGreaterThanDisbursement | Payment amount cannot be greater than the disbursement amount. | O valor do pagamento não pode ser maior que o valor de desembolso. |
RN0000033 | 400 | PaymentAmountNotRequired | Payment amount is not required for present amount amortization type. | O valor do pagamento não é necessário para o tipo de amortização presente. |
RN0000034 | 400 | DuplicatedProposalRequesterIdentifierKey | Requester identifier key is already been used for another proposal. | Requester identifier key ja está sendo utilizada para outra proposta. |
RN0000035 | 400 | InvalidDiscountAmountOnlyInterestDiscount | Invalid discount amount. Discount amount must be only interest discount. | O valor do desconto é invalido. O valor do desconto deve ser apenas desconto de juros. |
RN0000036 | 500 | MaxRetriesTooBig | Max retries set is too big to be executable. | Número máximo de retentativas é muito grande. |
RN0000037 | 400 | InvalidEmployerDocumentForCreditOperation | The payer document number does not match the employer document for the credit operation. | O documento do pagador não corresponde ao documento do empregador para a operação de crédito. |
RN0000038 | 400 | RenegotiationAmortizationErrors | One or more operations failed. | Uma ou mais operacoes falharam. |
Placeholder tokens such as {status} or {installment_key} reflect dynamic segments in the actual description / translation strings returned by the API.