Skip to main content

Debt Query by Credit Operation Key

Request​

ENDPOINT
/v2/credit_operation/CREDIT-OPERATION-KEY
METHOD
GET

Path params​

FieldTypeDescriptionCharacters
credit_operation_key *stringCredit operation key.UUID

Query params​

FieldTypeDescriptionDefault
eval_present_valuebooleanWhen true, calculates the present value of each installment and returns the present_amount field in each installments item, plus a root-level present_amount with the sum of all installments. Cannot be used for operations in status: waiting_signature, signed, issued, canceled, canceled_permanently or amended.false
calculate_delaybooleanIncludes delay interest in the present value calculation. Only takes effect when eval_present_value=true.false
calculate_spreadbooleanIncludes spread in the present value calculation. Only takes effect when eval_present_value=true.true
present_value_reference_datestring (date)Reference date (YYYY-MM-DD) used as the basis for the present value calculation. Only takes effect when eval_present_value=true.today

Response​

STATUS
200

How the response varies by operation type​

The structure of the response body is always the same, whatever the operation type: fields that do not apply come back as null or as an empty list, never absent. The only conditional fields are the present-value ones (present_amount, remaining_principal_disbursement_amount and remaining_principal_iof_amount), and what turns them on is the eval_present_value query param, not the operation type.

What changes between scenarios is the content:

Scenariooperation_type_enumeratorrefinanced_credit_operationsdisbursement_accountsfinal_disbursement_amount
Portabilityportability[][]0
Refinancingrefinancingone or more items: the settled contractscustomer accountreleased change
Port + Refin, portability legportability_for_refinancing[][]0
Port + Refin, refinancing legrefinancing_from_portability1 item: the portability legcustomer accountreleased change

Treat refinanced_credit_operations as a list: a refinancing may consolidate several contracts into one, and in that case the list carries one item per settled contract. Only on the refinancing leg of a port + refin does it always hold exactly one item — the portability leg.

final_disbursement_amount is the amount that actually reaches the customer: it is disbursement_issue_amount minus whatever was used to settle debt — the outstanding balance of the ported contract, in a portability, or the sum of the due_balance values in refinanced_credit_operations, in a refinancing. In a pure portability it is 0, because the whole amount goes to settling the original contract.

Port + Refin is two operations, not one

A portability with refinancing produces two distinct credit_operation_key values, and each one answers a separate call to this endpoint. The two legs are tied together like this:

  • they share the same origin_key;
  • the portability leg has operation_type_enumerator: "portability_for_refinancing" and refinanced_credit_operations: [];
  • the refinancing leg has operation_type_enumerator: "refinancing_from_portability" and one item in refinanced_credit_operations whose refinanced_credit_operation_key is the credit_operation_key of the portability leg.

Querying only the portability leg and concluding that no refinancing took place is the most common mistake when integrating this flow.

About the examples below

The installments array was truncated to the first two installments to keep the examples readable — the number_of_installments field carries the real total for each operation. All other fields are shown in full, in the same order the API returns them.

Response Body
{
  "credit_operation_key": "a1e60001-0000-4000-8000-000000000001",
  "issue_amount": 13752.54,
  "origin_key": "a1e60002-0000-4000-8000-000000000002",
  "total_iof": 0.0,
  "assigned_at": null,
  "disbursement_start_date": "2026-08-28",
  "disbursement_end_date": "2026-08-28",
  "issue_date": "2026-08-28",
  "requester_identifier_key": null,
  "installments": [
    {
      "business_due_date": "2026-10-13",
      "due_date": "2026-10-10",
      "calendar_days": 43,
      "due_interest": 0,
      "due_principal": 13752.54,
      "fine_amount": 0,
      "has_interest": true,
      "post_fixed_amount": 0,
      "pre_fixed_amount": 299.25,
      "principal_amortization_amount": 0.0,
      "tax_amount": 0,
      "total_amount": 299.25,
      "workdays": 29,
      "accrual_reference_date": "2026-09-10",
      "advanced_paid_amount": 0.0,
      "bank_slip_key": null,
      "digitable_line": null,
      "installment_key": "a1e60003-0000-4000-8000-000000000003",
      "installment_status": "unmonitored",
      "installment_type": "principal",
      "original_due_principal": 13752.54,
      "original_pre_fixed_amount": 299.25,
      "original_principal_amortization_amount": 0.0,
      "paid_amount": 0.0,
      "original_total_amount": 299.25,
      "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-08-28T10:00:47",
      "principal_amortization_payment_amount": 0,
      "prefixed_interest_payment_amount": 0
    },
    {
      "business_due_date": "2026-11-10",
      "due_date": "2026-11-10",
      "calendar_days": 31,
      "due_interest": 35,
      "due_principal": 13752.54,
      "fine_amount": 0,
      "has_interest": true,
      "post_fixed_amount": 0,
      "pre_fixed_amount": 276.68,
      "principal_amortization_amount": 22.57,
      "tax_amount": 0,
      "total_amount": 299.25,
      "workdays": 20,
      "accrual_reference_date": "2026-09-10",
      "advanced_paid_amount": 0.0,
      "bank_slip_key": null,
      "digitable_line": null,
      "installment_key": "a1e60004-0000-4000-8000-000000000004",
      "installment_status": "unmonitored",
      "installment_type": "principal",
      "original_due_principal": 13752.54,
      "original_pre_fixed_amount": 276.68,
      "original_principal_amortization_amount": 22.57,
      "paid_amount": 0.0,
      "original_total_amount": 299.25,
      "qr_code_key": null,
      "qr_code_url": null,
      "renegotiation_proposal_key": null,
      "total_accrual_amount": 22.73,
      "total_paid_amount": 0,
      "installment_number": 2,
      "paid_at": null,
      "updated_at": "2026-08-28T10:00:47",
      "principal_amortization_payment_amount": 0,
      "prefixed_interest_payment_amount": 0
    }
  ],
  "first_due_date": "2026-10-10",
  "requester_key": "a1e60060-0000-4000-8000-000000000096",
  "original_total_iof": null,
  "contract_number": "0000004521/AB",
  "credit_operation_status_enumerator": "opened",
  "operation_type_enumerator": "portability",
  "disbursement_date": "2026-08-28",
  "issuer_name": "Maria Aparecida Ferreira",
  "issuer_document_number": "12345678909",
  "external_contract_fees": [],
  "cet": 1.72,
  "annual_cet": 22.65,
  "final_disbursement_amount": 0.0,
  "number_of_installments": 93,
  "disbursement_issue_amount": 13752.54,
  "prefixed_interest_rate": {
    "annual_rate": 0.2230627564,
    "daily_rate": 0.0005594847,
    "interest_base": {
      "enumerator": "calendar_days",
      "year_days": 360
    },
    "monthly_rate": 0.0169214198
  },
  "fine_configuration": {
    "contract_fine_rate": 0.02,
    "fine_delay_rate": {
      "annual_rate": 0.0,
      "daily_rate": 0.0,
      "interest_base": {
        "enumerator": "calendar_days",
        "year_days": 360
      },
      "monthly_rate": 0.0
    }
  },
  "attached_documents": [
    {
      "document_key": "a1e60061-0000-4000-8000-000000000097",
      "document_url": "https://storage.googleapis.com/qi-documents-example/documento-99.jpeg",
      "signature_url": null,
      "document_type": "selfie",
      "signature_required": false,
      "signed": false
    },
    {
      "document_key": "a1e60062-0000-4000-8000-000000000098",
      "document_url": "https://storage.googleapis.com/qi-documents-example/documento-101.jpeg",
      "signature_url": null,
      "document_type": "document_identification_back",
      "signature_required": false,
      "signed": false
    },
    {
      "document_key": "a1e60063-0000-4000-8000-000000000099",
      "document_url": "https://storage.googleapis.com/qi-documents-example/documento-103.jpeg",
      "signature_url": null,
      "document_type": "document_identification",
      "signature_required": false,
      "signed": false
    },
    {
      "document_key": "a1e60064-0000-4000-8000-000000000100",
      "document_url": "https://storage.googleapis.com/qi-documents-example/documento-105.pdf",
      "signature_url": "https://storage.googleapis.com/qi-documents-example/signature-106.pdf",
      "document_type": "ccb_pre_price_days",
      "signature_required": true,
      "signed": true
    },
    {
      "document_key": "a1e60065-0000-4000-8000-000000000101",
      "document_url": "https://storage.googleapis.com/qi-documents-example/documento-108.pdf",
      "signature_url": null,
      "document_type": "issuer_informative",
      "signature_required": false,
      "signed": false
    }
  ],
  "related_parties": [
    {
      "related_party_key": "a1e60066-0000-4000-8000-000000000102",
      "role_type": "issuer",
      "person_type": "natural",
      "name": "Maria Aparecida Ferreira",
      "email": "maria.ferreira@example.com",
      "individual_document_number": "12345678909"
    },
    {
      "related_party_key": "a1e60067-0000-4000-8000-000000000103",
      "role_type": "credit_agent",
      "person_type": "natural",
      "name": "Maria Aparecida Ferreira",
      "email": null,
      "individual_document_number": "12345678909"
    }
  ],
  "disbursement_accounts": [],
  "base_iof": null,
  "additional_iof": null,
  "assignment_amount": 14919.97,
  "created_at": "2026-08-28T09:15:01Z",
  "total_prefixed_amount": 14077.71,
  "refinanced_credit_operations": []
}
STATUS
400
Response Body
{
  "data": "{\"title\": \"Bad Request\", \"description\": \"Invalid request body.\", \"translation\": \"Corpo da requisição inválido.\", \"extra_fields\": {}, \"code\": \"LEG000069\"}"
}