Pular para o conteúdo principal

Consulta de dívida por Credit Operation Key

Request​

ENDPOINT
/v2/credit_operation/CREDIT-OPERATION-KEY
MÉTODO
GET

Path params​

CampoTipoDescriçãoCaracteres
credit_operation_key *stringChave da operação de crédito.UUID

Query params​

CampoTipoDescriçãoDefault
eval_present_valuebooleanQuando true, calcula o valor presente de cada parcela e retorna o campo present_amount em cada item de installments, além de um present_amount na raiz com a soma das parcelas. Não pode ser usado para operações nos status: waiting_signature, signed, issued, canceled, canceled_permanently ou amended.false
calculate_delaybooleanConsidera juros de mora no cálculo do valor presente. Só tem efeito quando eval_present_value=true.false
calculate_spreadbooleanConsidera o spread no cálculo do valor presente. Só tem efeito quando eval_present_value=true.true
present_value_reference_datestring (date)Data de referência (YYYY-MM-DD) usada como base para o cálculo do valor presente. Só tem efeito quando eval_present_value=true.hoje

Response​

STATUS
200

Como o retorno varia por tipo de operação​

A estrutura do corpo é sempre a mesma, qualquer que seja o tipo da operação: os campos que não se aplicam vêm null ou como lista vazia, nunca ausentes. Os únicos campos que aparecem condicionalmente são os do cálculo de valor presente (present_amount, remaining_principal_disbursement_amount e remaining_principal_iof_amount), e quem os liga é o query param eval_present_value, não o tipo da operação.

O que muda entre os cenários é o conteúdo:

Cenáriooperation_type_enumeratorrefinanced_credit_operationsdisbursement_accountsfinal_disbursement_amount
Portabilidadeportability[][]0
Refinanciamentorefinancingum ou mais itens: os contratos quitadosconta do clientetroco liberado
Port + Refin, perna de portabilidadeportability_for_refinancing[][]0
Port + Refin, perna de refinanciamentorefinancing_from_portability1 item: a perna de portabilidadeconta do clientetroco liberado

Trate refinanced_credit_operations como lista: um refinanciamento pode consolidar vários contratos num só, e nesse caso a lista traz um item por contrato quitado. Só na perna de refinanciamento de um port + refin ela tem sempre exatamente um item, que é a perna de portabilidade.

final_disbursement_amount é o valor que efetivamente chega ao cliente: é o disbursement_issue_amount menos o que foi usado para liquidar dívida — o saldo devedor do contrato portado, na portabilidade, ou a soma dos due_balance de refinanced_credit_operations, no refinanciamento. Numa portabilidade pura ele é 0, porque todo o valor vai liquidar o contrato de origem.

Port + Refin são duas operações, não uma

Uma operação de portabilidade com refinanciamento gera dois credit_operation_key distintos, e cada um responde a uma chamada separada deste endpoint. As duas pernas se reconhecem assim:

  • compartilham o mesmo origin_key;
  • a perna de portabilidade tem operation_type_enumerator: "portability_for_refinancing" e refinanced_credit_operations: [];
  • a perna de refinanciamento tem operation_type_enumerator: "refinancing_from_portability" e um item em refinanced_credit_operations cujo refinanced_credit_operation_key é o credit_operation_key da perna de portabilidade.

Consultar apenas a perna de portabilidade e concluir que não houve refinanciamento é o erro mais comum na integração desse fluxo.

Sobre os exemplos abaixo

O array installments foi truncado nas duas primeiras parcelas para manter os exemplos legíveis — o campo number_of_installments indica o total real de cada operação. Todos os demais campos são exibidos por inteiro, na mesma ordem em que a API os devolve.

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\"}"
}