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
}
]
}
]
}