跳到主要内容

Consulta - Emissão BNPL

Resumo

Você pode consultar a dívida a qualquer momento para obter informações ou acompanhar o status atual da operação.

Consultar Operação de Crédito

Existem duas formas de consultar uma operação:

  • Por credit_operation_key (DEBT-KEY)
  • Por requester_identifier_key (chave identificadora enviada na emissão)

Por Credit Operation Key

ENDPOINT
/v2/credit_operation/CREDIT-OPERATION-KEY
MÉTODO
GET
Testar no Playground
CampoTipoDescriçãoCaracteres
credit_operation_key*stringChave da operação de crédito (DEBT-KEY)UUID

Por Requester Identifier Key

ENDPOINT
/v2/credit_operation/requester_identifier_key/REQUESTER-IDENTIFIER-KEY
MÉTODO
GET
CampoTipoDescriçãoCaracteres
requester_identifier_key*stringChave identificadora enviada na emissãoUUID

Response

STATUS
200
Response Body
{
"credit_operation_key": "72760166-4ddf-41fb-8a8c-605f8f4fc35c",
"issue_amount": 1007.62,
"origin_key": "72760166-4ddf-41fb-8a8c-605f8f4fc35c",
"total_iof": 7.62,
"assigned_at": null,
"disbursement_start_date": "2026-04-07",
"disbursement_end_date": "2026-04-07",
"issue_date": "2026-04-07",
"requester_identifier_key": "d1905ef5-19df-4183-bf0e-802b8229933c",
"installments": [
{
"business_due_date": "2026-05-07",
"due_date": "2026-05-07",
"calendar_days": 30,
"due_interest": 0,
"due_principal": 1007.62,
"fine_amount": 0,
"has_interest": true,
"post_fixed_amount": 0,
"pre_fixed_amount": 52.4,
"principal_amortization_amount": 491.49,
"tax_amount": 1.21,
"total_amount": 543.89,
"workdays": 20,
"accrual_reference_date": null,
"advanced_paid_amount": 0,
"bank_slip_key": null,
"digitable_line": null,
"installment_key": "1dea396f-beb1-4df3-9822-35800b4c095a",
"installment_status": "opened",
"installment_type": "principal",
"original_due_principal": 1007.62,
"original_pre_fixed_amount": 52.4,
"original_principal_amortization_amount": 491.49,
"paid_amount": 0,
"original_total_amount": 543.89,
"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-07T23:59:27",
"principal_amortization_payment_amount": 0,
"prefixed_interest_payment_amount": 0
},
{
"business_due_date": "2026-06-08",
"due_date": "2026-06-07",
"calendar_days": 31,
"due_interest": 0,
"due_principal": 516.1296159,
"fine_amount": 0,
"has_interest": true,
"post_fixed_amount": 0,
"pre_fixed_amount": 27.76,
"principal_amortization_amount": 516.13,
"tax_amount": 2.58,
"total_amount": 543.89,
"workdays": 20,
"accrual_reference_date": null,
"advanced_paid_amount": 0,
"bank_slip_key": null,
"digitable_line": null,
"installment_key": "370e73d1-55d8-431e-9b22-d08fb8297999",
"installment_status": "opened",
"installment_type": "principal",
"original_due_principal": 516.13,
"original_pre_fixed_amount": 27.76,
"original_principal_amortization_amount": 516.13,
"paid_amount": 0,
"original_total_amount": 543.89,
"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-07T23:59:27",
"principal_amortization_payment_amount": 0,
"prefixed_interest_payment_amount": 0
}
],
"first_due_date": "2026-05-07",
"requester_key": "78287247-947d-4730-9bd1-7efb068175b6",
"contract_number": "DWF1761222116",
"credit_operation_status_enumerator": "opened",
"operation_type_enumerator": "structured_operation",
"disbursement_date": "2026-04-07",
"issuer_name": "Dante Ferrarini",
"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": 5.82,
"annual_cet": 97.05,
"final_disbursement_amount": 1000,
"number_of_installments": 2,
"disbursement_issue_amount": 1000,
"prefixed_interest_rate": {
"annual_rate": 0.8373372409,
"daily_rate": 0.0016911989,
"interest_base": {
"enumerator": "calendar_days",
"year_days": 360
},
"monthly_rate": 0.052
},
"fine_configuration": {
"contract_fine_rate": 0.02,
"fine_delay_rate": {
"annual_rate": 0.12682503,
"daily_rate": 0.00033173,
"interest_base": {
"enumerator": "calendar_days",
"year_days": 360
},
"monthly_rate": 0.01
}
},
"attached_documents": [
{
"document_key": "d6705fc4-80e0-4c8e-9aff-f3875024e6a4",
"document_url": "https://storage.googleapis.com/sandbox-doc-api/documents/...",
"signature_url": "https://storage.googleapis.com/sandbox-doc-api/documents/..._signed.pdf",
"document_type": "ccb_pre_price_days",
"signature_required": true,
"signed": true
}
],
"related_parties": [
{
"related_party_key": "24fac77e-7782-4f72-b31a-daee288e34ed",
"role_type": "issuer",
"person_type": "natural",
"name": "Dante Ferrarini",
"email": "",
"individual_document_number": "31057466093"
}
],
"base_iof": 3.79,
"additional_iof": 3.83,
"assignment_amount": 1010.64,
"created_at": "2026-04-07T23:59:22Z",
"total_prefixed_amount": 80.16
}
STATUS
400
Response Body
{
"data": "{\"title\": \"Bad Request\", \"description\": \"Invalid request body.\", \"translation\": \"Corpo da requisição inválido.\", \"extra_fields\": {}, \"code\": \"LEG000069\"}"
}

Consultar Eventos da Operação

Você também pode consultar o histórico de eventos (log de status) da operação:

ENDPOINT
/v2/credit_operation/CREDIT-OPERATION-KEY/events
MÉTODO
GET
Testar no Playground

Path Params

CampoTipoDescriçãoCaracteres
credit_operation_key*stringChave da operação de créditoUUID

Response

STATUS
200
Response Body
{
"data": [
{
"status": "waiting_signature",
"reason": null,
"cancel_reason": null,
"event_date": "2026-03-13T17:19:59Z"
},
{
"status": "issued",
"reason": null,
"cancel_reason": null,
"event_date": "2026-03-13T17:19:59Z"
},
{
"status": "waiting_disbursement",
"reason": null,
"cancel_reason": null,
"event_date": "2026-03-13T17:19:59Z"
},
{
"status": "opened",
"reason": null,
"cancel_reason": null,
"event_date": "2026-03-13T17:19:59Z"
}
],
"pagination": {
"current_page": 1,
"next_page": null,
"rows_per_page": 10
}
}

Enumeradores de Status da Operação

StatusDescrição
waiting_signatureAguardando assinatura do contrato
issuedOperação emitida
waiting_disbursementAguardando desembolso
openedOperação aberta (desembolso realizado)
canceledOperação cancelada
settledOperação liquidada (todas as parcelas pagas)