# QI Tech — Lending-as-a-Service › Dívidas Documentação da QI Tech em texto corrido, para colar em um LLM. Fonte: https://docs.qitech.com.br 42 página(s). Índice: - Atualizar cessionário do contrato de crédito (/documentation/emissao_de_divida/atualizar_cessionario_047911bb-d3fb-48fe-88fd-aebdeb7e11ad) - Atualizar informações das partes relacionadas ao contrato de crédito (/documentation/emissao_de_divida/atualizar_dados_da_parte_relacionada) - Autorizar desembolso (/documentation/emissao_de_divida/autorizar_desembolso) - Cancelar dívida antes de desembolsar (/documentation/emissao_de_divida/cancelamento/cancelar_divida_antes_de_desembolsar) - Cancelar permanentemente (/documentation/emissao_de_divida/cancelamento/cancelar_permanentemente) - Emissão de pix qr code de devolução (/documentation/emissao_de_divida/cancelamento/desistencia/cancelamento_de_divida_em_ate_sete_dias_apos_o_desembolso) - Consulta de pix qr code de devolução (/documentation/emissao_de_divida/cancelamento/desistencia/consulta_de_pix_qr_code_de_devolucao) - Introdução (/documentation/emissao_de_divida/cancelamento/desistencia/introducao) - Introdução (/documentation/emissao_de_divida/cancelamento/introducao) - Configurar data de desembolso (/documentation/emissao_de_divida/configurar_data_de_desembolso) - Consulta de dívida (/documentation/emissao_de_divida/consulta_de_divida) - Consulta de dívida por Contract Number (/documentation/emissao_de_divida/consulta_por_contract_number) - Consulta de dívida por Credit Operation Key (/documentation/emissao_de_divida/consulta_por_credit_operation_key) - Consulta de dívida por Requester Identifier Key (/documentation/emissao_de_divida/consulta_por_requester_identifier_key) - Desembolso da operação (/documentation/emissao_de_divida/desembolso_da_operacao) - Emissão de dívida PF (/documentation/emissao_de_divida/emissao/emissao_de_divida_pf) - Emissão de dívida PJ (/documentation/emissao_de_divida/emissao/emissao_de_divida_pj) - Exemplos de payload de desembolso (/documentation/emissao_de_divida/emissao/exemplo_payloads_desembolso) - Assinaturas alternativas (/documentation/emissao_de_divida/formalizacao/assinatura_de_contrato) - Assinatura de contrato com OPT-IN (/documentation/emissao_de_divida/formalizacao/assinatura_opt_in) - Envio do PDF assinado (/documentation/emissao_de_divida/formalizacao/assinatura_pdf) - Assinatura de contrato com selfie (/documentation/emissao_de_divida/formalizacao/assinatura_selfie) - Assinatura de contrato (/documentation/emissao_de_divida/formalizacao/introducao_formalizacao) - Gerar Boleto ou PIX para uma Parcela (/documentation/emissao_de_divida/gerar_boleto_ou_pix_para_uma_parcela) - Introdução (/documentation/emissao_de_divida/introducao) - Metadata (/documentation/emissao_de_divida/metadata) - Introdução (/documentation/emissao_de_divida/reapresentacao_de_conta_bancaria) - Reenviar documentos das partes relacionadas ao contrato de crédito (/documentation/emissao_de_divida/reenviar_documentos_das_partes_relacionadas) - Ações pós-desembolso (/documentation/emissao_de_divida/reprocessar_acao_pos_desembolso) - Alterar Dados de Desembolso (/documentation/emissao_de_divida/reprocessar_multiplas_datas/trocar_conta) - Alterar Data de Desembolso (/documentation/emissao_de_divida/reprocessar_multiplas_datas/trocar_data) - Seguro (/documentation/emissao_de_divida/seguro) - Simulação de dívida antigo (/documentation/emissao_de_divida/simulacao_de_divida_antigo) - Simulação de dívida novo (/documentation/emissao_de_divida/simulacao_de_divida_novo) - Simulando erros em Sandbox (/documentation/emissao_de_divida/simulando_erros) - Possíveis status de uma dívida (/documentation/emissao_de_divida/status_de_uma_divida) - Reenvio de Notificações (/documentation/notificacoes/reenvio_de_notificacoes) - Webhooks de dívida (/documentation/webhooks/dividas) - Webhooks de gestão de risco (/documentation/webhooks/gestao_de_risco) - Webhooks de indevidos (/documentation/webhooks/indevidos) - Webhooks de pagamento de parcelas (/documentation/webhooks/pagamento_de_parcela) - Webhooks de parcelas (/documentation/webhooks/parcelas) --- # Atualizar cessionário do contrato de crédito URL: /documentation/emissao_de_divida/atualizar_cessionario_047911bb-d3fb-48fe-88fd-aebdeb7e11ad ### Importante: Para atualização de cessionário, os seguintes requisitos devem ser atendidos: - a operação de crédito não pode estar cancelada; - a operação de crédito não pode estar no meio de um processo de cessão; - a operação de crédito não pode estar cedida; - deve existir uma configuração de cessão com o novo comprador. ## Request ENDPOINT /debt/ DEBT-KEY /purchaser MÉTODO PATCH **Request Body** ```json { "purchaser_document_number": "01234567890001" } ``` ### Path Params | Campo | Tipo | Descrição | |---|---|---| | `debt_key` * | string | debt_key da operação. | ## Response STATUS 201 **Response Body** ```json {} ``` STATUS 400 **Response Body** ```json { "data": "{\"title\": \"Bad Request\", \"description\": \"Credit Operation is already in assignment process for changing the purchaser.\", \"translation\": \"A opera\u00e7\u00e3o de cr\u00e9dito est\u00e1 em processo de cess\u00e3o e n\u00e3o pode ter seu comprador alterado.\", \"extra_fields\": {}, \"code\": \"COP000376\"}" } ``` --- # Atualizar informações das partes relacionadas ao contrato de crédito URL: /documentation/emissao_de_divida/atualizar_dados_da_parte_relacionada ## Request ENDPOINT /debt/ DEBT-KEY /related_party/ RELATED-PARTY-KEY MÉTODO PATCH ### Pessoa Física **Request Body** ```json { "name": "Teste teste", "email": "teste@teste.com", "address": { "street": "Rua teste", "neighborhood": "Bairro teste", "number": "123", "postal_code": "09725540", "city": "S\u00e3o Caetano do sul", "state": "SP" }, "phone": { "country_code": "55", "area_code": "11", "number": "41234123" }, "mother_name": "M\u00e3e Teste", "document_identification_number": "1234567", "nationality": "Brasileiro", "marital_status": "single", "profession": "Diretor Executivo", "birth_date": "1999-01-01", "document_identification_date": "2015-01-01", "document_identification_type": "cnh", "gender": "female" } ``` ### Pessoa Jurídica **Request Body** ```json { "name": "Teste teste", "email": "teste@teste.com", "address": { "street": "Rua teste", "neighborhood": "Bairro teste", "number": "123", "postal_code": "09725540", "city": "S\u00e3o Caetano do sul", "state": "SP" }, "phone": { "country_code": "55", "area_code": "11", "number": "41234123" }, "trading_name": "Nome fantasia teste", "foundation_date": "2020-01-01", "simples_nacional_participant": false } ``` ### Path Params | Campo | Tipo | Descrição | |---|---|---| | `debt_key` * | string | debt_key da operação. | | `related_party_key` * | string | key da parte relacionada que os documentos serão enviados. | ## Response STATUS 201 **Response Body** ```json { "status": "waiting_signature", "data": { "annual_cet": 26.0802, "cet": 1.95, "installments": [**], "disbursed_issue_amount": 2209.06, "contract_fees": [{ "fee_amount": 22.71, "fee_type": "spread" }], "prefixed_interest_rate": { "created_at": "2023-07-21T16:30:07", "interest_base": "calendar_days_365", "annual_rate": 0.23872053, "monthly_rate": 0.018, "daily_rate": 0.00058669 }, "contract_fee_amount": 22.71, "requester_identifier_key": "af0e8a5d-650e-4348-b955-a424307c44df", "iof_charge_method": "financed", "external_contract_fee_amount": 0, "borrower": { "document_number": "04062377942", "related_party_key": "c3b213ee-897a-4e42-9697-6c0b56fb0020", "name": "TESTE TESTE" }, "additional_iof": 8.629534, "entry": null, "external_contract_fees": [**], "collaterals": [**], "total_pre_fixed_amount": 1088.47822388, "contract": { "urls": [ "https://storage.googleapis.com/live-doc-api/documents/a0e3678a-9d48-47e8-8e00-ed9435713588/teste.pdf" ], "number": "0008938245/TT" }, "net_external_contract_fee_amount": 0, "number_of_installments": 8, "total_iof": 61.87, "base_iof": 53.2421439, "issue_amount": 2270.93, "assignment_amount": 2293.64 }, "event_datetime": "2023-07-21 16:30:11", "webhook_type": "debt", "key": "01d62579-be1e-482f-b766-069786b44344" } ``` STATUS 400 **Response Body** ```json { "data": "{\"title\": \"Bad Request\", \"description\": \"Collateral type social_security is not allowed for update related party.\", \"translation\": \"O tipo de garantia social_security n\u00e3o permite atualizar a parte relacionada.\", \"extra_fields\": {}, \"code\": \"COP000328\"}" } ``` --- # Autorizar desembolso URL: /documentation/emissao_de_divida/autorizar_desembolso ## Request ENDPOINT /debt/ DEBT-KEY /allow_disbursement MÉTODO POST **Request Body** ```json { "allow_disbursement": true } ``` ### Path Params | Campo | Tipo | Descrição | |---|---| ---| | `debt_key` *(obrigatório)* | string | ID da divida emitida. | ### Body Params | Campo | Tipo | Descrição | |---|---| ---| | `allow_disbursement` | string | Indicação de autorização para desembolso. | ## Response STATUS 201 **Request Body** ```json { "additional_iof": 45.65, "credit_operation_key": "1baea8a0-0fca-4f7c-8857-a227d4da72f8", "contract_number": "0000192840/AMT", "annual_cet": 226.17, "assigned": false, "assigned_at": null, "assignment_amount": 6844.51, "issue_amount": 6844.51, "disbursed_issue_amount": 6594, "final_disbursement_amount": 6594, "base_iof": 204.86, "calculus_correction": null, "cet": 10.35, "collateral_constituted": true, "collateral_type": null, "contract_fee_amount": 0, "external_contract_fee_amount": 0, "net_external_contract_fee_amount": 0, "creditor_bank_account_key": null, "disbursement_date": "2026-01-01", "disbursement_start_date": "2026-01-01", "disbursement_end_date": "2026-01-01", "first_due_date": "2026-12-10", "number_of_installments": 4, "interest_grace_period": 0, "interest_payment_month_period": 1, "interest_subsidy_amount": 0, "interest_subsidy_percentage": 0, "iof_charge_method": "financed", "ipoc_code": "3240250202021123456789090000542149/T", "issue_date": "2026-02-02", "issuer_document_number": "12345678909", "issuer_name": "teste", "origin_key": "8bf10bc5-345e-4d4c-b038-650bc7277c6e", "principal_amortization_month_period": 1, "principal_grace_period": 0, "purchaser_document_number": "32402502000135", "requester_key": "783ea550-9e70-4482-bcae-127a913b5b1e", "requester_identifier_key": "8bf10bc5-345e-4d4c-b038-650bc7277c6e", "settlement_bank_account_key": null, "share_quantity": 7, "third_party_account_key": "5d068423-6094-49e4-b15b-7740038295a8", "total_iof": 250.51, "original_total_iof": null, "facial_biometrics_enabled": false, "selfie_enabled": false, "tax_exempt_amount": 0, "is_allowed_to_disburse": true, "is_refinancing": false, "is_portability": false, "credit_rating": null, "first_due_date_delay": null, "operation_extra_fields": {}, "if_code": null, "disbursement_key": "f754470c-e979-45c7-8956-bbd6960823f3", "created_at": "2026-02-02T20:00:12", "is_amendment": false, "all_day_disbursement": true, "disbursement_inelegibility_reason": null, "disbursement_inelegibility_reason_issued": null, "portability_amount": 0, "disburse_before_assign": true, "requester_name": "Requester Teste", "disbursed_at": null, "assignment_key": null, "isin_number": null, "extra_fields": { }, "financial_index": null, "payroll_data": null, "kyc": null, "entry": null, "amendment_credit_operation": null, "disbursement_confirmed_at": null, "portability_origin_contract": null, "credit_operation_status": { "translation_path": "co.CreditOperationStatus.waiting_disbursement", "translation_ptbr": "Aguardando Desembolso", "enumerator": "waiting_disbursement" }, "credit_operation_type": { "translation_path": "co.CreditOperationType.ccb", "enumerator": "ccb" }, "operation_type": { "translation_path": "co.OperationType.structured_operation", "enumerator": "structured_operation" }, "custodian": { "translation_path": "co.Custodian.qi_scd", "enumerator": "qi_scd" }, "payment_and_settlement_agent": { "enumerator": "qi_scd", "translation_path": "co.PaymentAndSettlementAgent.qi_scd" }, "interest_type": { "translation_path": "co.InterestType.pre_price_days", "enumerator": "pre_price_days" }, "document_certifier": { "translation_path": "co.DocumentCertifier.qi_sign", "enumerator": "qi_sign" }, "assignment_status": { "enumerator": "not_assigned" }, "origin_type": { "enumerator": "lego-api", "translation_path": "co.OriginType.lego-api" }, "payment_type": { "translation_path": "co.PaymentType.unmonitored", "enumerator": "unmonitored" }, "signature_method": { "enumerator": "email" }, "central_depository": null, "registration_institution": { "translation_path": "co.RegistrationInstitution.qi_scd", "enumerator": "qi_scd" }, "tax_configuration": { "iof_additional_rate": 0.0038, "iof_rate": 0.000082 }, "prefixed_interest_rate": { "annual_rate": 2.1384283767, "daily_rate": 0.0031383999, "interest_base": { "translation_path": "co.InterestBase.calendar_days_365", "enumerator": "calendar_days_365", "year_days": 365 }, "monthly_rate": 0.1, "created_at": "2026-02-02T20:00:12" }, "post_fixed_interest_rate": null, "original_prefixed_interest_rate": { "annual_rate": 2.13842838, "daily_rate": 0.0031384, "interest_base": { "translation_path": "co.InterestBase.calendar_days_365", "enumerator": "calendar_days_365", "year_days": 365 }, "monthly_rate": 0.1, "created_at": "2026-02-02T20:00:12" }, "fine_configuration": { "contract_fine_rate": 0, "fine_delay_rate": { "annual_rate": 0, "daily_rate": 0, "interest_base": { "translation_path": "co.InterestBase.calendar_days", "enumerator": "calendar_days", "year_days": 360 }, "monthly_rate": 0, "created_at": "2026-02-02T20:00:12" } }, "early_settlement_configuration": { "early_settlement_configuration_type": { "enumerator": "fixed_rate", "translation_path": "co.EarlySettlementConfigurationType.fixed_rate" }, "effective_end_date": null, "fixed_interest_rate": 0 }, "resource_source_account": { "enumerator": "third_party", "translation_path": "co.ResourceSourceAccount.third_party" }, "endorsement": null, "rebate_account": null, "contract_fees": [], "external_contract_fees": [], "disbursement_account": [ { "account_branch": "2874", "account_digit": "0", "account_number": "99581339", "account_type": "checking_account", "amount_receivable": null, "digitable_line": null, "disbursement_account_key": "bfe5dd10-2fb4-41a8-b1e1-02811b2266f6", "disbursement_type": "pix", "document_number": "12345678909", "end_to_end_id": null, "financial_institutions": { "code_number": 1, "is_pix_participant": true, "is_active": true, "name": "BANCO DO BRASIL S.A.", "ispb": 0 }, "financial_institutions_code_number": 1, "is_pix_disbursement": true, "ispb": "0", "name": "Name", "percentage_receivable": 100, "pix_key": null, "pix_transfer_key": "4db1ab83-4305-46fa-8373-0dd5ee4abfe9", "pix_type": "manual", "qr_code_key": null, "qr_code_url": null, "receipt_document_key": null, "receipt_url": null, "retry_counter": 0, "retry_vector": null, "transaction_key": null, "webhook_key": null } ], "disbursement_options": [ { "additional_iof": 45.65, "annual_cet": 226.17, "assignment_amount": 6844.51, "base_iof": 204.86, "calculus_correction": null, "cet": 10.35, "contract_fee_amount": 0, "contract_fees": [], "disbursed_issue_amount": 6594, "disbursement_date": "2026-02-02", "external_contract_fee_amount": 0, "external_contract_fees": [], "final_disbursement_amount": 6594, "first_due_date": "2026-12-10", "installments": [ { "additional_costs": [], "business_due_date": "2026-12-10", "calendar_days": 311, "due_date": "2026-12-10", "due_interest": 0, "due_principal": 6844.51, "fine_amount": null, "has_interest": true, "installment_number": 1, "post_fixed_amount": 0, "pre_fixed_amount": 5204.15, "principal_amortization_amount": 0, "tax_amount": 0, "total_amount": 5204.15, "workdays": 213 }, { "additional_costs": [], "business_due_date": "2027-01-11", "calendar_days": 31, "due_date": "2027-01-10", "due_interest": 6088.45962499, "due_principal": 6844.51, "fine_amount": null, "has_interest": true, "installment_number": 2, "post_fixed_amount": 0, "pre_fixed_amount": 5204.15, "principal_amortization_amount": 0, "tax_amount": 0, "total_amount": 5204.15, "workdays": 19 }, { "additional_costs": [], "business_due_date": "2027-02-10", "calendar_days": 31, "due_date": "2027-02-10", "due_interest": 2203.63074342, "due_principal": 6844.51, "fine_amount": null, "has_interest": true, "installment_number": 3, "post_fixed_amount": 0, "pre_fixed_amount": 3126.65078208, "principal_amortization_amount": 2077.49921792, "tax_amount": 62.17955159, "total_amount": 5204.15, "workdays": 21 }, { "additional_costs": [], "business_due_date": "2027-03-10", "calendar_days": 28, "due_date": "2027-03-10", "due_interest": 0, "due_principal": 4767.01078208, "fine_amount": null, "has_interest": true, "installment_number": 4, "post_fixed_amount": 0, "pre_fixed_amount": 437.13921792, "principal_amortization_amount": 4767.01078208, "tax_amount": 142.67663271, "total_amount": 5204.15, "workdays": 20 } ], "interest_subsidy_amount": 0, "issue_amount": 6844.51, "net_external_contract_fee_amount": 0, "prefixed_interest_rate": { "annual_rate": 2.1384283767, "daily_rate": 0.0031383999, "interest_base": { "translation_path": "co.InterestBase.calendar_days_365", "enumerator": "calendar_days_365", "year_days": 365 }, "monthly_rate": 0.1, "created_at": "2026-02-02T20:00:12" }, "refinanced_credit_operations": [], "share_quantity": 7, "tax_exempt_amount": 0, "total_iof": 250.51 } ], "installments": [ { "additional_costs": [], "business_due_date": "2026-12-10", "calendar_days": 311, "due_date": "2026-12-10", "due_interest": 0, "due_principal": 6844.51, "fine_amount": null, "has_interest": true, "installment_number": 1, "post_fixed_amount": 0, "pre_fixed_amount": 5204.15, "principal_amortization_amount": 0, "tax_amount": 0, "total_amount": 5204.15, "workdays": 213, "accrual_reference_date": null, "advanced_paid_amount": 0, "bank_slip_key": null, "digitable_line": null, "installment_key": "2db9f3af-a8e2-4398-b0d8-5e26f9f8f710", "installment_status": { "enumerator": "created", "translation_path": "co.InstallmentStatus.created" }, "installment_type": { "enumerator": "principal", "translation_path": "co.InstallmentType.principal" }, "payment_type": { "translation_path": "co.PaymentType.unmonitored", "enumerator": "unmonitored" }, "original_due_principal": 6844.51, "original_pre_fixed_amount": 5204.15, "original_principal_amortization_amount": 0, "paid_amount": 0, "paid_at": null, "original_total_amount": 5204.15, "qr_code_key": null, "qr_code_url": null, "renegotiation_proposal_key": null, "total_accrual_amount": null, "total_paid_amount": 0, "updated_at": null, "cetip_settlements": [], "events": [], "installment_history": [], "installment_payment": [] }, { "additional_costs": [], "business_due_date": "2027-01-11", "calendar_days": 31, "due_date": "2027-01-10", "due_interest": 6088.45962499, "due_principal": 6844.51, "fine_amount": null, "has_interest": true, "installment_number": 2, "post_fixed_amount": 0, "pre_fixed_amount": 5204.15, "principal_amortization_amount": 0, "tax_amount": 0, "total_amount": 5204.15, "workdays": 19, "accrual_reference_date": null, "advanced_paid_amount": 0, "bank_slip_key": null, "digitable_line": null, "installment_key": "89d1e77c-c9df-4716-a535-78f1d329ee49", "installment_status": { "enumerator": "created", "translation_path": "co.InstallmentStatus.created" }, "installment_type": { "enumerator": "principal", "translation_path": "co.InstallmentType.principal" }, "payment_type": { "translation_path": "co.PaymentType.unmonitored", "enumerator": "unmonitored" }, "original_due_principal": 6844.51, "original_pre_fixed_amount": 5204.15, "original_principal_amortization_amount": 0, "paid_amount": 0, "paid_at": null, "original_total_amount": 5204.15, "qr_code_key": null, "qr_code_url": null, "renegotiation_proposal_key": null, "total_accrual_amount": null, "total_paid_amount": 0, "updated_at": null, "cetip_settlements": [], "events": [], "installment_history": [], "installment_payment": [] }, { "additional_costs": [], "business_due_date": "2027-02-10", "calendar_days": 31, "due_date": "2027-02-10", "due_interest": 2203.63074342, "due_principal": 6844.51, "fine_amount": null, "has_interest": true, "installment_number": 3, "post_fixed_amount": 0, "pre_fixed_amount": 3126.65078208, "principal_amortization_amount": 2077.49921792, "tax_amount": 62.17955159, "total_amount": 5204.15, "workdays": 21, "accrual_reference_date": null, "advanced_paid_amount": 0, "bank_slip_key": null, "digitable_line": null, "installment_key": "60c36ccb-ee86-4ab2-a8d6-bb84d2a35ad3", "installment_status": { "enumerator": "created", "translation_path": "co.InstallmentStatus.created" }, "installment_type": { "enumerator": "principal", "translation_path": "co.InstallmentType.principal" }, "payment_type": { "translation_path": "co.PaymentType.unmonitored", "enumerator": "unmonitored" }, "original_due_principal": 6844.51, "original_pre_fixed_amount": 3126.65078208, "original_principal_amortization_amount": 2077.49921792, "paid_amount": 0, "paid_at": null, "original_total_amount": 5204.15, "qr_code_key": null, "qr_code_url": null, "renegotiation_proposal_key": null, "total_accrual_amount": null, "total_paid_amount": 0, "updated_at": null, "cetip_settlements": [], "events": [], "installment_history": [], "installment_payment": [] }, { "additional_costs": [], "business_due_date": "2027-03-10", "calendar_days": 28, "due_date": "2027-03-10", "due_interest": 0, "due_principal": 4767.01078208, "fine_amount": null, "has_interest": true, "installment_number": 4, "post_fixed_amount": 0, "pre_fixed_amount": 437.13921792, "principal_amortization_amount": 4767.01078208, "tax_amount": 142.67663271, "total_amount": 5204.15, "workdays": 20, "accrual_reference_date": null, "advanced_paid_amount": 0, "bank_slip_key": null, "digitable_line": null, "installment_key": "8c4c214c-b360-446b-8cf7-8b2cde065491", "installment_status": { "enumerator": "created", "translation_path": "co.InstallmentStatus.created" }, "installment_type": { "enumerator": "principal", "translation_path": "co.InstallmentType.principal" }, "payment_type": { "translation_path": "co.PaymentType.unmonitored", "enumerator": "unmonitored" }, "original_due_principal": 4767.01078208, "original_pre_fixed_amount": 437.13921792, "original_principal_amortization_amount": 4767.01078208, "paid_amount": 0, "paid_at": null, "original_total_amount": 5204.15, "qr_code_key": null, "qr_code_url": null, "renegotiation_proposal_key": null, "total_accrual_amount": null, "total_paid_amount": 0, "updated_at": null, "cetip_settlements": [], "events": [], "installment_history": [], "installment_payment": [] } ], "collaterals": [], "events": [], "cancel_reason": {}, "after_disbursement_actions": [], "cetip_assignments": [], "cetip_settlements": [], "post_fixed_interest_base": { "translation_path": "co.InterestBase.workdays", "enumerator": "workdays", "year_days": 252 }, "disbursement_callback": null, "attached_document_list": [ { "document_key": "7546e337-4bcf-4e36-b4c5-fb67b462ed1c", "document_type": { "enumerator": "ccb_pre_price_days", "translation_path": "co.DocumentType.ccb_pre_price_days" }, "document_url": {URL}, "related_party_key": null, "signature_data": null, "signature_required": true, "signature_url": null, "signed": false } ], "related_party_list": [ { "address": { "street": "Rua Teste", "neighborhood": "", "number": "1", "postal_code": "99999999", "city": "São Paulo", "state": "SP", "complement": "" }, "attached_document_list": [], "birth_date": "1999-01-01", "birth_place": null, "cnae_code": null, "company_document_number": null, "created_at": "2026-02-02T20:00:12", "document_identification_date": null, "document_identification_number": null, "document_identification_type": null, "email": "alan.turing@email.com", "foundation_date": null, "gender": null, "income": null, "individual_document_number": "12345678909", "is_pep": false, "marital_status": null, "mother_name": "Mother Name", "name": "Alan Mathison Turing", "nationality": null, "person_type": "natural", "phone": { "phone_key": "7d03058a-b55f-425b-a71a-d729216c6abe", "country_code": "55", "area_code": "11", "number": "999999999", "phone_type": null }, "profession": null, "property_system": null, "related_party_key": "2d5ebd7f-b094-45c1-a41e-953b474ae6ce", "revenue": null, "role_type": { "enumerator": "issuer", "translation_path": "co.RoleType.issuer" }, "simples_nacional_participant": null, "spouse_document_number": null, "trading_name": null } ], "refinanced_credit_operations": [] } ``` STATUS 400 **Request Body** ```json { "data": "{\"title\": \"Bad Request\", \"description\": \"Invalid request body.\", \"translation\": \"Corpo da requisição inválido.\", \"extra_fields\": {}, \"code\": \"LEG000069\"}" } ``` --- # Cancelar dívida antes de desembolsar URL: /documentation/emissao_de_divida/cancelamento/cancelar_divida_antes_de_desembolsar ## Request ENDPOINT /debt/ DEBT-KEY /cancel MÉTODO PATCH ## Response STATUS 200 Response Body ```json { "data": [ { "borrower": { "document_number": "68394265057", "name": "Xuxa Meneguel" }, "contract_fee_amount": 5.56, "installments": [ { "bank_slip_key": null, "calendar_days": 57, "due_date": "2020-09-30", "due_principal": -0.00217819, "fine_amount": null, "has_interest": true, "installment_key": "28eb5907-ed25-4a86-bb9d-b6dc944f13df", "installment_number": 1, "installment_status": "opened", "installment_type": "principal", "paid_amount": 0, "post_fixed_amount": 0, "pre_fixed_amount": 268.75782181, "principal_amortization_amount": 1111.9, "tax_amount": 0, "total_amount": 1380.66, "workdays": 40 } ], "operation_key": "7986dcc7-4331-478f-af47-adfbdf7f4a36", "status": "opened" } ], "pagination": { "current_page": 1, "next_page": null, "rows_per_page": 100, "total_pages": 1, "total_rows": 55 } } ``` STATUS 400 Response Body ```json { "title": "Bad Request", "description": "Operation cc5075bb-cfc3-4cd3-a9b5-527978de673c actual status does not allow cancel operation. Actual status is canceled", "translation": "Status da operação cc5075bb-cfc3-4cd3-a9b5-527978de673c não permite cancelamento.Status atual: canceled", "code": "LEG000073" } ``` ### Path Params | Campo | Tipo | Descrição | |---|---| ---| | `debt_key` * | string | Chave da divida devolvida no momento da criação da operação de crédito. | --- # Cancelar permanentemente URL: /documentation/emissao_de_divida/cancelamento/cancelar_permanentemente ## Request ENDPOINT /debt/ debt_key /cancel_permanently MÉTODO POST ## Response STATUS 200 Response Body ```json { "data": { "additional_iof": 38000, "annual_cet": "253,2642%", "assignment_amount": 10000000, "base_iof": 69331, "borrower": { "document_number": "89940878025962", "name": "Parmalat" }, "cet": "11,0900%", "collaterals": [], "contract": { "external_contract_key": "2f0b8b6e-0b60-47f0-b27f-e291c028549b", "number": "1907258737/P", "signature_information": [ { "signature_url": "https://sign.qitech.com.br/s/hNrwjda", "signer_document_number": "94632180173", "signer_email": "pedro.alves@yopmail.com", "signer_external_key": "07a1c438-43a4-49a9-85a9-29667507453b", "signer_name": "Pedro Felipe Henrique Alves", "signer_role": "issuer" }, { "signature_url": "https://sign.qitech.com.br/s/EaTajda", "signer_document_number": "34651104630", "signer_email": "patricia.tereza@yopmail.com", "signer_external_key": "61a1ea50-769a-410a-8ef8-09f0ce4611f6", "signer_name": "Patrícia Tereza Bernardes", "signer_role": "guarantor" } ], "urls": [ "https://storage.googleapis.com/sandbox-doc-api/documents/abedfeab-dcf8-4e13-897b-da02c222cef4/SALGADINHO_SALETE_LTDA-PARMALAT-CCB-1907258737-20220512165254.pdf" ] }, "contract_fee_amount": 50000, "contract_fees": [ { "fee_amount": 50000, "fee_type": "tac" } ], "external_contract_fee_amount": 0, "external_contract_fees": [], "installments": [ { "additional_costs": [], "advanced_paid_amount": 0, "bank_slip_key": null, "business_due_date": "2019-08-26", "calendar_days": 32, "digitable_line": null, "due_date": "2019-08-26", "due_interest": null, "due_principal": 10000000, "fine_amount": null, "has_interest": true, "installment_key": "81e4a732-d300-4e39-b6d5-2d9ac8df429b", "installment_number": 1, "installment_payment": [], "installment_status": "created", "installment_type": "principal", "original_due_principal": 10000000, "original_pre_fixed_amount": 1125598.54, "original_principal_amortization_amount": 1000000, "original_total_amount": null, "paid_amount": 0, "paid_at": null, "payments": [], "post_fixed_amount": null, "pre_fixed_amount": 1125598.54, "principal_amortization_amount": 1000000, "tax_amount": 1312, "total_amount": null, "total_paid_amount": 0, "workdays": 22 }, { "additional_costs": [], "advanced_paid_amount": 0, "bank_slip_key": null, "business_due_date": "2019-09-25", "calendar_days": 30, "digitable_line": null, "due_date": "2019-09-25", "due_interest": null, "due_principal": 9000000, "fine_amount": null, "has_interest": true, "installment_key": "bac4fe3e-9559-4380-9f4b-bdda3492738e", "installment_number": 2, "installment_payment": [], "installment_status": "created", "installment_type": "principal", "original_due_principal": 9000000, "original_pre_fixed_amount": 946509.06, "original_principal_amortization_amount": 1000000, "original_total_amount": null, "paid_amount": 0, "paid_at": null, "payments": [], "post_fixed_amount": null, "pre_fixed_amount": 946509.06, "principal_amortization_amount": 1000000, "tax_amount": 2542, "total_amount": null, "total_paid_amount": 0, "workdays": 22 }, { "additional_costs": [], "advanced_paid_amount": 0, "bank_slip_key": null, "business_due_date": "2019-10-25", "calendar_days": 30, "digitable_line": null, "due_date": "2019-10-25", "due_interest": null, "due_principal": 8000000, "fine_amount": null, "has_interest": true, "installment_key": "aaaec4d7-94a0-418d-8a8e-ac7af6787aec", "installment_number": 3, "installment_payment": [], "installment_status": "created", "installment_type": "principal", "original_due_principal": 8000000, "original_pre_fixed_amount": 841341.39, "original_principal_amortization_amount": 1000000, "original_total_amount": null, "paid_amount": 0, "paid_at": null, "payments": [], "post_fixed_amount": null, "pre_fixed_amount": 841341.39, "principal_amortization_amount": 1000000, "tax_amount": 3772, "total_amount": null, "total_paid_amount": 0, "workdays": 22 }, { "additional_costs": [], "advanced_paid_amount": 0, "bank_slip_key": null, "business_due_date": "2019-11-25", "calendar_days": 31, "digitable_line": null, "due_date": "2019-11-25", "due_interest": null, "due_principal": 7000000, "fine_amount": null, "has_interest": true, "installment_key": "bead5a38-c56e-4cfc-98f9-af6d71ec7d65", "installment_number": 4, "installment_payment": [], "installment_status": "created", "installment_type": "principal", "original_due_principal": 7000000, "original_pre_fixed_amount": 762003.23, "original_principal_amortization_amount": 1000000, "original_total_amount": null, "paid_amount": 0, "paid_at": null, "payments": [], "post_fixed_amount": null, "pre_fixed_amount": 762003.23, "principal_amortization_amount": 1000000, "tax_amount": 5043, "total_amount": null, "total_paid_amount": 0, "workdays": 20 }, { "additional_costs": [], "advanced_paid_amount": 0, "bank_slip_key": null, "business_due_date": "2019-12-26", "calendar_days": 31, "digitable_line": null, "due_date": "2019-12-26", "due_interest": null, "due_principal": 6000000, "fine_amount": null, "has_interest": true, "installment_key": "350a89e3-58a7-4879-b7ff-5fa0391da39c", "installment_number": 5, "installment_payment": [], "installment_status": "created", "installment_type": "principal", "original_due_principal": 6000000, "original_pre_fixed_amount": 653145.63, "original_principal_amortization_amount": 1000000, "original_total_amount": null, "paid_amount": 0, "paid_at": null, "payments": [], "post_fixed_amount": null, "pre_fixed_amount": 653145.63, "principal_amortization_amount": 1000000, "tax_amount": 6314, "total_amount": null, "total_paid_amount": 0, "workdays": 22 }, { "additional_costs": [], "advanced_paid_amount": 0, "bank_slip_key": null, "business_due_date": "2020-01-27", "calendar_days": 32, "digitable_line": null, "due_date": "2020-01-27", "due_interest": null, "due_principal": 5000000, "fine_amount": null, "has_interest": true, "installment_key": "bf935dc2-3151-4f66-91c6-35e446b57f2e", "installment_number": 6, "installment_payment": [], "installment_status": "created", "installment_type": "principal", "original_due_principal": 5000000, "original_pre_fixed_amount": 562799.27, "original_principal_amortization_amount": 1000000, "original_total_amount": null, "paid_amount": 0, "paid_at": null, "payments": [], "post_fixed_amount": null, "pre_fixed_amount": 562799.27, "principal_amortization_amount": 1000000, "tax_amount": 7626, "total_amount": null, "total_paid_amount": 0, "workdays": 20 }, { "additional_costs": [], "advanced_paid_amount": 0, "bank_slip_key": null, "business_due_date": "2020-02-26", "calendar_days": 30, "digitable_line": null, "due_date": "2020-02-26", "due_interest": null, "due_principal": 4000000, "fine_amount": null, "has_interest": true, "installment_key": "76aad8ce-3ee1-464c-90db-d72a2729560e", "installment_number": 7, "installment_payment": [], "installment_status": "created", "installment_type": "principal", "original_due_principal": 4000000, "original_pre_fixed_amount": 420670.69, "original_principal_amortization_amount": 1000000, "original_total_amount": null, "paid_amount": 0, "paid_at": null, "payments": [], "post_fixed_amount": null, "pre_fixed_amount": 420670.69, "principal_amortization_amount": 1000000, "tax_amount": 8856, "total_amount": null, "total_paid_amount": 0, "workdays": 20 }, { "additional_costs": [], "advanced_paid_amount": 0, "bank_slip_key": null, "business_due_date": "2020-03-25", "calendar_days": 28, "digitable_line": null, "due_date": "2020-03-25", "due_interest": null, "due_principal": 3000000, "fine_amount": null, "has_interest": true, "installment_key": "fc190222-5baf-4023-9e93-95b25774a37e", "installment_number": 8, "installment_payment": [], "installment_status": "created", "installment_type": "principal", "original_due_principal": 3000000, "original_pre_fixed_amount": 293473.82, "original_principal_amortization_amount": 1000000, "original_total_amount": null, "paid_amount": 0, "paid_at": null, "payments": [], "post_fixed_amount": null, "pre_fixed_amount": 293473.82, "principal_amortization_amount": 1000000, "tax_amount": 10004, "total_amount": null, "total_paid_amount": 0, "workdays": 20 }, { "additional_costs": [], "advanced_paid_amount": 0, "bank_slip_key": null, "business_due_date": "2020-04-27", "calendar_days": 33, "digitable_line": null, "due_date": "2020-04-27", "due_interest": null, "due_principal": 2000000, "fine_amount": null, "has_interest": true, "installment_key": "7c2972a8-def7-4b76-b215-0ade0a5bca13", "installment_number": 9, "installment_payment": [], "installment_status": "created", "installment_type": "principal", "original_due_principal": 2000000, "original_pre_fixed_amount": 232548.93, "original_principal_amortization_amount": 1000000, "original_total_amount": null, "paid_amount": 0, "paid_at": null, "payments": [], "post_fixed_amount": null, "pre_fixed_amount": 232548.93, "principal_amortization_amount": 1000000, "tax_amount": 11357, "total_amount": null, "total_paid_amount": 0, "workdays": 21 }, { "additional_costs": [], "advanced_paid_amount": 0, "bank_slip_key": null, "business_due_date": "2020-05-25", "calendar_days": 28, "digitable_line": null, "due_date": "2020-05-25", "due_interest": null, "due_principal": 1000000, "fine_amount": null, "has_interest": true, "installment_key": "d848c880-f489-4bc1-a9e4-101f8d664317", "installment_number": 10, "installment_payment": [], "installment_status": "created", "installment_type": "principal", "original_due_principal": 1000000, "original_pre_fixed_amount": 97824.6, "original_principal_amortization_amount": 1000000, "original_total_amount": null, "paid_amount": 0, "paid_at": null, "payments": [], "post_fixed_amount": null, "pre_fixed_amount": 97824.6, "principal_amortization_amount": 1000000, "tax_amount": 12505, "total_amount": null, "total_paid_amount": 0, "workdays": 19 } ], "iof_charge_method": "financed", "issue_amount": 10000000, "net_external_contract_fee_amount": 0, "number_of_installments": 10, "post_fixed_interest_base": "workdays", "post_fixed_interest_rate": 1, "prefixed_interest_rate": { "annual_rate": 2.32, "created_at": null, "daily_rate": 0.0033388, "interest_base": "calendar_days", "monthly_rate": 0.10516767 }, "requester_identifier_key": "b7ddbcfb-3de0-49d8-8014-07972d8b27f2", "total_iof": 107331, "total_pre_fixed_amount": 5935915.16 }, "event_datetime": "2022-05-12 16:53:10", "key": "b7ddbcfb-3de0-49d8-8014-07972d8b27f2", "status": "waiting_signature", "webhook_type": "debt" } ``` STATUS 400 Response Body ```json { "data": "{\"title\": \"Bad Request\", \"description\": \"Invalid request body.\", \"translation\": \"Corpo da requisição inválido.\", \"extra_fields\": {}, \"code\": \"LEG000069\"}" } ``` --- # Emissão de pix qr code de devolução URL: /documentation/emissao_de_divida/cancelamento/desistencia/cancelamento_de_divida_em_ate_sete_dias_apos_o_desembolso ## Request ENDPOINT /debt/reversal MÉTODO POST Request Body **Sem informar dias de expiração** ```json { "contract_number": "0000049343/TW" } ``` **Informando dias corridos de expiração** ```json { "contract_number": "0000049343/TW", "days_to_expire":8 } ``` **Informando dias úteis de expiração** ```json { "contract_number": "0000049343/TW", "workdays_to_expire":8 } ``` :::warning Expiração do pix_qr_code A data de expiração do pix qr code é definida por uma quantidade de dias a partir da data de desembolso da dívida, caso não seja definido no payload, serão 14 dias úteis. ::: ## Response STATUS 200 Response Body ```json { "amount": "2026.93", "copy_paste_pix": "00020126930014br.gov.bcb.pix2571qrcode-h.dev.qitech.app/bacen/cobv/dece8d3e-32ce-439e-8204000053039865802BR5925Joao61080150400062070503***63046ECD", "expiration_date": "2022-09-28", "payer_document_number": "000000000008", "payer_name": "Teste", "reversal_key": "f98a1b7c-5e3c-4e6f-8887-c7fedfa0d5b5", "status": "waiting_payment" } ``` STATUS 400 Response Body ```json { "data": "{\"title\": \"Bad Request\", \"description\": \"Invalid request body.\", \"translation\": \"Corpo da requisição inválido.\", \"extra_fields\": {}, \"code\": \"LEG000069\"}" } ``` ## Definições | Campo | Tipo | Descrição | |-------------------|--------|--------------------------------| | `contract_number` * | string | Número do contrato de crédito. | | `days_to_expire` * | integer | Número de dias corridos de expiração do pix qr code desde o desembolso. | | `workdays_to_expire` * | integer | Número de dias úteis de expiração do pix qr code desde o desembolso. | --- # Consulta de pix qr code de devolução URL: /documentation/emissao_de_divida/cancelamento/desistencia/consulta_de_pix_qr_code_de_devolucao Retorna o pix qr code de devolução previamente gerado para uma operação de crédito em processo de desistência. Utilize este endpoint após criar o estorno em `/debt/reversal` para reobter os dados do qr code (por exemplo, para reexibi-los ao pagador). ## Request ENDPOINT /credit_operation/{credit_operation_key}/pix_qrcode MÉTODO GET :::info Esta requisição não possui corpo. A `credit_operation_key` deve ser informada como parâmetro de caminho na URL. ::: ## Response STATUS 200 Response Body ```json { "amount": "2026.93", "copy_paste_pix": "00020126930014br.gov.bcb.pix2571qrcode-h.dev.qitech.app/bacen/cobv/dece8d3e-32ce-439e-8204000053039865802BR5925Joao61080150400062070503***63046ECD", "debt_key": "a1f3d9c0-8b7e-4c9f-9d1a-1234567890ab", "expiration_date": "2022-09-28", "payer_document_number": "000000000008", "payer_name": "Teste", "qr_code_key": "7c3e5b22-4d8e-4a6b-9f11-abcdef123456", "reversal_key": "f98a1b7c-5e3c-4e6f-8887-c7fedfa0d5b5", "status": "waiting_payment" } ``` STATUS 404 Response Body — Operação não encontrada ```json { "data": "{\"title\": \"Not Found\", \"description\": \"Credit Operation not found\", \"translation\": \"Operação não encontrada\", \"extra_fields\": {}, \"code\": \"COP000027\"}" } ``` Response Body — Estorno não encontrado ```json { "data": "{\"title\": \"Not Found\", \"description\": \"Reversal not found.\", \"translation\": \"Estorno não encontrado.\", \"extra_fields\": {}, \"code\": \"COP000205\"}" } ``` ## Definições ### Parâmetros de caminho | Campo | Tipo | Descrição | |-------|------|-----------| | `credit_operation_key` * | string (uuid) | Chave única da operação de crédito para a qual o pix qr code de devolução foi gerado. | ### Campos da resposta | Campo | Tipo | Descrição | |-------|------|-----------| | `amount` | string | Valor do pix qr code de devolução, em reais. | | `copy_paste_pix` | string | Código pix copia-e-cola gerado para o pagamento. | | `debt_key` | string (uuid) | Chave da operação de crédito (dívida) associada ao estorno. | | `expiration_date` | string (date) | Data de expiração do pix qr code, no formato `YYYY-MM-DD`. | | `payer_document_number` | string | CPF/CNPJ do pagador. | | `payer_name` | string | Nome do pagador. | | `qr_code_key` | string (uuid) | Chave única do pix qr code emitido. | | `reversal_key` | string (uuid) | Chave única do estorno associado ao pix qr code. | | `status` | string | Status atual do pix qr code (por exemplo, `waiting_payment`). | --- # Introdução URL: /documentation/emissao_de_divida/cancelamento/desistencia/introducao Tendo em vista atender a Código de Proteção e Defesa do Consumidor que permite ao tomador do crédito através de meios digitais realizar o cancelamento da dívida em até 7 dias, a QI Tech viabilizou uma funcionalidade específica para atender a estes casos. ## Funcionamento Nos sistemas QI Tech existem duas formas de realizar o cancelamento de uma divida por desistencia em 7 dias: ### 1 - Através de devolução do valor recebido no desembolso Caso seja identificada a devolução do valor total desembolsado de uma operação dentro dos 7 dias após a data de desembolso, seja através do estorno do pix ou uma nova transferência para a conta de origem do desembolso, será realizado o cancelamento automático da operação com o motivo: 'disbursed_amount_refunded'. ### 2 - Através da API de cancelamento Através do endpoint [POST /debt/reversal](cancelamento_de_divida_em_ate_sete_dias_apos_o_desembolso) é possível realizar a geração de um QR code que, uma vez pago pelo tomador, realiza o cancelamnto da operação. Em ambos os casos, uma vez que o dinheiro chega a QI Tech, a operação é cancelada e, caso a cessão do contrato já tenha ocorrido, o montante e estornado para o cessionário. É possivel ultilizar este endpoint até 7 dias após o desembolso e a expiração do QR Code é parametrizada para 14 dias após a sua geração - Após este perioso não é mais possivel realizar o cancelamento do contrato. ## Requisitos Para o funcionamento correto deste endpoint é necessário entrar em contato com o time de suporte QI Tech para liberação do endpoint e a configuração da conta do cessionário para estorno dos recursos. --- # Introdução URL: /documentation/emissao_de_divida/cancelamento/introducao Existem dois tipos de cancelamento de dívidas que podem ser realizados através dos sistemas QI Tech. ## Cancelamento de dívida antes de desembolsar A utilização do serviço de cancelamento de operações de crédito da QI Tech, para antes do desembolso, consiste apenas em uma única solicitação em nossa API. ## Cancelamento de dívida em até sete dias após o desembolso A utilização do serviço de cancelamento de operações de crédito da QI Tech, em até sete dias após o desembolso, consiste apenas em uma única solicitação em nossa API. Após a solicitação, será devolvido o Pix QR Code. Ao ser pago, a operação será cancelada e todos os estornos são executados automaticamente. ## Webhook Quando o pagamento é confirmado, nosso serviço executa todas as reversões e envia um webhook para o cliente, conforme exemplo a seguir: ```json { "reversal":{ "date":"2022-09-06", "incoming_pix_transfer_key":null, "status":"pending_fund", "amount_to_send":2026.93, "third_party_account_key":"17e5120f-14f7-4802-8676-b63011154edf", "reversal_key":"eb0bbd1d-111d-4a61-bb65-c1f66a005ea2", "amount":2026.93, "is_total":true, "created_at":"2022-09-06T01:14:01", "is_operation_canceled":true, "transaction_key":null }, "assigned_at":"None", "credit_operation_key":"2893b8bd-8f4e-4e45-9325-fc7003beb869", "assigned":true, "contract_number":"0000049333/TW" } ``` :::info **Principais pontos a serem considerados nesta operação de cancelamento após sete dias:** - A solicitação de estorno deve ser feita em até 8 dias úteis a partir da data de desembolso. - O pagamento por QR Code deve ser feito em até 15 dias úteis a partir da data de desembolso. - O status atual da operação de crédito não pode ser diferente de aberto. - Nenhuma parcela pode ter sido paga. - Quando todas as reversões são executadas com sucesso, uma rotina é executada uma vez por dia, coletando o valor adequado e enviando para o fundo. ::: --- # Configurar data de desembolso URL: /documentation/emissao_de_divida/configurar_data_de_desembolso ## Request ENDPOINT /debt/ DEBT-KEY /set_disbursement_date MÉTODO POST **body.json** ```json { "disbursement_date": "2021-09-01", "disbursement_bank_account": { "name": "Pedro Felipe Henrique Alves", "bank_code": "329", "account_digit": "1", "branch_number": "001", "account_number": "94632180173", "document_number": "026.923.850-63" } } ``` :::caution **Atenção!** Caso seja optado pela emissão de dívida com múltiplas datas, após a assinatura do contrato a data de desembolso deve ser definida através deste endpoint. ::: ### Path Params | Campo | tipo | Descrição | |---|---| ---| | `debt_key` * | string | Chave da divida devolvida no momento da criação da operação de crédito. | ### Body Params | Campo | Tipo | Descrição |Caracteres | |---|---|---|---| | `disbursement_date` * | date | Data de desembolso da operação. | 10 | | `disbursement_bank_account` | object | **[Objeto Disbursement Bank Account](#objeto-disbursement_bank_accounts)** - Dados da conta bancária para desembolso da operação. | | ### Objeto Disbursement Bank Account As informações bancárias para desembolso podem ser alteradas juntamente com a data de desembolso, por padrão, o desembolso é realizado em uma conta de titularidade do devedor. | Campo | Tipo | Descrição | Máx. Caract. | |-----------------------|--------|----------------------------------------------------------------------------------------------------|--------------| | name | string | Nome do titular da conta | 50 | | document_number | string | CPF do titular da conta | 11 | | bank_code * | string | Código COMPE da instituição financeira (https://www.bcb.gov.br/pom/spb/estatistica/port/ASTR003.pdf) | 3 | | branch_number * | string | Número da agência (não informar o dígito verificador da agência!) | 4 | | account_number * | string | Número da conta (sem o dígito verificador da conta!) | 10 | | account_digit * | string | Dígito verificador da conta (informar zero no lugar de letras) | 1 | | account_type | enum | [Enumerador Account Type](#enumerador-account-type) Tipo da conta | 1 | ## Response STATUS 400 **body.json** ```json { "key": "25dd0a85-dbd7-453f-9076-d776a9ef7c3a", "event_datetime": "2022-03-29 15:30:20", "data": {}, "webhook_type": "debt", "status": "disbursement_date_set" } ``` STATUS 400 **body.json** ```json { "data": "{\"title\": \"Bad Request\", \"description\": \"Invalid request body.\", \"translation\": \"Corpo da requisição inválido.\", \"extra_fields\": {}, \"code\": \"LEG000069\"}" } ``` --- # Consulta de dívida URL: /documentation/emissao_de_divida/consulta_de_divida ## Request ENDPOINT /debt MÉTODO GET ## Query Params | Campo | Tipo | Descrição | Caracteres | |---|---|-------------------------------------------------------------------------| ---| | `key` | string | Chave da divida devolvida no momento da criação da operação de crédito. | - | | `requester_identifier_key` | string | Chave da UUID4 enviada na criação da dívida. | - | | `contract_number` | string | Número da CCB retornado na emissão de dívida. | - | | `issuer_document_number` | string | Número de documento do emitente. | - | | `issuer_name` | string | Nome do emitente da dívida. | - | | `status` | string | Status da operação. | - | | `page` | string | Página atual que está sendo consultada. | - | | `page_size` | string | Quantidade de resultados que cabem na página. | - | | `total_due_balance` | boolean | Quando enviado como `true`, inclui o campo `balance_due` (saldo devedor total da operação) na resposta. Por padrão (`false` ou ausente), o `balance_due` **não** é retornado. | - | :::tip Saldo devedor (`balance_due`) O campo `balance_due` representa o saldo devedor total da operação e **só é retornado quando a consulta é feita com o parâmetro `total_due_balance=true`**. Sem esse parâmetro, a resposta não traz o saldo devedor. Exemplo de requisição: ```bash GET /debt?contract_number=ABC1234&total_due_balance=true ``` Compare os exemplos de resposta abaixo: **"Consulta sem `total_due_balance`"** (sem o campo) e **"Consulta com `total_due_balance=true`"** (com o campo `balance_due`). ::: :::caution Não combine `total_due_balance` com `key` O `total_due_balance` só funciona na **consulta por filtros** (sem a `key`). Quando você envia o parâmetro `key`, o endpoint usa a rota de consulta individual por chave, que **ignora** o `total_due_balance` (e os demais filtros) — por isso o `balance_due` não é retornado. Para obter o `balance_due`, consulte **sem** a `key`, usando os demais filtros. Exemplo: ```bash GET /debt?total_due_balance=true&contract_number=0369255657%2FMGG&issuer_document_number=05739967929&page_size=10&page=1 ``` A resposta vem como uma **lista** (`data: [...]`) e cada item traz o `balance_due`. ::: ## Response STATUS 200 Response Body: Consulta sem total_due_balance (sem balance_due ) ```json { "data": [ { "borrower": { "document_number": "68394265057", "name": "Xuxa Meneguel" }, "contract_fee_amount": 5.56, "installments": [ { "bank_slip_key": null, "calendar_days": 57, "due_date": "2020-09-30", "due_principal": -0.00217819, "fine_amount": null, "has_interest": true, "installment_key": "28eb5907-ed25-4a86-bb9d-b6dc944f13df", "installment_number": 1, "installment_status": "opened", "installment_type": "principal", "paid_amount": 0, "post_fixed_amount": 0, "pre_fixed_amount": 268.75782181, "principal_amortization_amount": 1111.9, "tax_amount": 0, "total_amount": 1380.66, "workdays": 40 } ], "operation_key": "7986dcc7-4331-478f-af47-adfbdf7f4a36", "status": "opened" } ], "pagination": { "current_page": 1, "next_page": null, "rows_per_page": 100, "total_pages": 1, "total_rows": 55 } } ``` Response Body: Consulta com total_due_balance=true (com balance_due ) ```json { "data": { "additional_iof": 11.547136, "after_disbursement_actions": [], "all_day_disbursement": true, "annual_cet": 41.0883, "assigned": false, "assigned_at": null, "assignment_amount": 3038.72, "attached_document_list": [ { "created_at": "2022-10-19T11:53:01", "document_key": "5df59dca-b8d1-4dca-8358-8b4bd944f3dc", "document_type": { "enumerator": "document_identification", "translation_path": "co.DocumentType.document_identification" }, "document_url": "https://storage.googleapis.com/sandbox-doc-api/documents/5df59dca-b8d1-4dca-8358-8b4bd944f3dc/image_1666180300436.jpg", "related_party_key": null, "signature_required": false, "signature_url": null, "signed": false } ], "balance_due": 3150.62, "base_iof": 27.17569413, "calculus_correction": null, "central_depository": null, "cet": 2.91, "cetip_assignments": [], "cetip_settlements": [], "collateral_constituted": true, "collateral_type": null, "collaterals": [], "contract_fee_amount": 0, "contract_fees": [], "contract_number": "TESTE118261", "created_at": "2022-10-19T11:53:00", "credit_operation_key": "438ceaa3-2906-4ee3-85f9-0dcacd5f2581", "credit_operation_status": { "enumerator": "opened", "translation_path": "co.CreditOperationStatus.opened", "translation_ptbr": "Desembolsada" }, "credit_operation_type": { "enumerator": "ccb", "translation_path": "co.CreditOperationType.ccb" }, "credit_rating": null, "creditor_bank_account_key": "5d068423-6094-49e4-b15b-7740038295a8", "custodian": { "enumerator": "qi_scd", "translation_path": "co.Custodian.qi_scd" }, "decimal_annual_cet": 0.43241941956989105, "decimal_cet": 0.0304, "disburse_before_assign": true, "disbursed_at": "2022-10-19T11:54:47", "disbursed_issue_amount": 3000, "disbursement_account": [ { "account_branch": "1234", "account_digit": "1", "account_number": "2345678601", "account_type": "checking_account", "amount_receivable": null, "created_at": "2022-10-19T11:53:01", "digitable_line": null, "disbursement_type": "pix", "document_number": "92147661180", "financial_institutions": { "code_number": 104, "is_active": true, "is_pix_participant": true, "ispb": "00360305", "name": "CAIXA ECONOMICA FEDERAL" }, "financial_institutions_code_number": 104, "is_pix_disbursement": true, "ispb": "00360305", "name": "104 CAIXA ECONOMICA FEDERAL", "percentage_receivable": 100, "pix_key": null, "pix_transfer_key": "da80477f-412e-40a5-81b0-c830b238081e", "pix_type": "manual", "qr_code_key": null, "retry_counter": 0, "retry_vector": null, "transaction_key": null, "webhook_key": null } ], "disbursement_callback": { "installments": [ { "bank_slip_key": "9d8c566a-c865-495e-8764-db8351e7ac41", "digitable_line": "32990001031000699925348000000207991730000055231", "due_date": "2022-11-18", "qr_code_key": "bdd41d56-8588-4468-9705-5233994cdc39", "qr_code_url": "00020126970014br.gov.bcb.pix2575qrcode-h.sandbox.qitech.app/bacen/cobv/bdd41d56-8588-4468-9705-5233994cdc395204000053039865802BR5925QI SOCIEDADE DE CREDITO D6009Sao Paulo61080145200062070503***63044F44" } ], "key": "438ceaa3-2906-4ee3-85f9-0dcacd5f2581", "origin_type": "lego-api", "status": "opened", "transaction_receipts": [ { "amount": 3000, "description": "00360305 1234 2345678601-1 92147661180 - 104 CAIXA ECONOMICA FEDERAL", "destination": { "account_digit": "1", "account_number": "2345678601", "bank_ispb": "00360305", "branch": "1234", "branch_digit": null, "document": "92147661180", "name": "104 CAIXA ECONOMICA FEDERAL", "purpose": "Crédito PIX em Conta", "type": "checking_account" }, "fee": 0, "origin": { "account_branch": "0001", "account_digit": "5", "account_key": "5d068423-6094-49e4-b15b-7740038295a8", "account_number": "00002", "bank_code": "329", "branch": "0001", "branch_digit": null, "document": "32402502000135", "name": "QI SOCIEDADE DE CRÉDITO DIRETO S.A.", "type": "payment_account" }, "origin_transaction_key": null, "timestamp": "2022-10-19T11:55:03", "transaction_key": "da80477f-412e-40a5-81b0-c830b238081e" } ] }, "disbursement_confirmed_at": "2022-10-20T13:00:56", "disbursement_date": "2022-10-19", "disbursement_end_date": "2022-10-19", "disbursement_inelegibility_reason": null, "disbursement_inelegibility_reason_issued": null, "disbursement_options": [ { "additional_iof": 11.547136, "annual_cet": 41.0883, "assignment_amount": 3038.72, "base_iof": 27.17569413, "calculus_correction": null, "cet": 2.91, "contract_fee_amount": 0, "contract_fees": [], "created_at": "2022-10-19T11:53:01", "disbursed_issue_amount": 3000, "disbursement_date": "2022-10-19", "external_contract_fee_amount": 0, "external_contract_fees": [], "first_due_date": "2022-11-18", "installments": [ { "additional_costs": [], "business_due_date": "2022-11-21", "calendar_days": 30, "created_at": "2022-10-19T11:53:01", "due_date": "2022-11-18", "due_interest": 0, "due_principal": 3038.72, "fine_amount": null, "has_interest": true, "installment_number": 1, "post_fixed_amount": 0, "pre_fixed_amount": 75.66402982, "principal_amortization_amount": 476.64597018, "tax_amount": 1.17254909, "total_amount": 552.31, "workdays": 20 } ], "interest_subsidy_amount": 0, "issue_amount": 3038.72, "net_external_contract_fee_amount": 0, "prefixed_interest_rate": null, "share_quantity": 4, "total_iof": 38.72 } ], "disbursement_start_date": "2022-10-19", "document_certifier": { "enumerator": "electronic_client_side", "translation_path": "co.DocumentCertifier.electronic_client_side" }, "early_settlement_configuration": { "created_at": "2022-10-19T11:53:00", "early_settlement_configuration_type": { "enumerator": "fixed_rate", "translation_path": "co.EarlySettlementConfigurationType.fixed_rate" }, "effective_end_date": null, "fixed_interest_rate": 0 }, "endorsement": null, "entry": null, "events": [], "external_contract_fee_amount": 0, "external_contract_fees": [], "extra_fields": null, "facial_biometrics_enabled": false, "final_disbursement_amount": 3000, "financial_index": null, "fine_configuration": { "contract_fine_rate": 0.02, "created_at": "2022-10-19T11:53:00", "fine_delay_rate": { "annual_rate": 0.12682503, "created_at": "2022-10-19T11:53:00", "daily_rate": 0.00033173, "interest_base": { "enumerator": "calendar_days", "translation_path": "co.InterestBase.calendar_days", "year_days": 360 }, "monthly_rate": 0.01 } }, "first_due_date": "2022-11-18", "first_due_date_delay": null, "if_code": null, "installments": [ { "accrual_reference_date": null, "additional_costs": [], "advanced_paid_amount": 0, "bank_slip_key": "9d8c566a-c865-495e-8764-db8351e7ac41", "business_due_date": "2022-11-21", "calendar_days": 30, "cetip_settlements": [], "created_at": "2022-10-19T11:53:00", "digitable_line": "32990001031000699925348000000207991730000055231", "due_date": "2022-11-18", "due_interest": 0, "due_principal": 3038.72, "events": [ { "amount": null, "created_at": "2022-10-19T11:54:47", "event_date": "2022-10-19T11:54:47", "installment_event_type": { "enumerator": "open", "translation_path": "co.InstallmentEventType.open" }, "installment_old_status": { "enumerator": "created", "translation_path": "co.InstallmentStatus.created" }, "old_due_date": null }, { "amount": null, "created_at": "2022-11-18T08:00:10", "event_date": "2022-11-18T08:00:10", "installment_event_type": { "enumerator": "maturity", "translation_path": "co.InstallmentEventType.maturity" }, "installment_old_status": { "enumerator": "opened", "translation_path": "co.InstallmentStatus.opened" }, "old_due_date": null }, { "amount": 11.76, "created_at": "2022-11-22T08:00:14", "event_date": "2022-11-22T08:00:14", "installment_event_type": { "enumerator": "delay_fine", "translation_path": "co.InstallmentEventType.delay_fine" }, "installment_old_status": { "enumerator": "waiting_payment", "translation_path": "co.InstallmentStatus.waiting_payment" }, "old_due_date": null }, { "amount": 11.94, "created_at": "2022-11-23T09:13:46", "event_date": "2022-11-23T09:13:46", "installment_event_type": { "enumerator": "delay_fine", "translation_path": "co.InstallmentEventType.delay_fine" }, "installment_old_status": { "enumerator": "overdue", "translation_path": "co.InstallmentStatus.overdue" }, "old_due_date": null }, { "amount": 12.12, "created_at": "2022-11-24T09:15:55", "event_date": "2022-11-24T09:15:55", "installment_event_type": { "enumerator": "delay_fine", "translation_path": "co.InstallmentEventType.delay_fine" }, "installment_old_status": { "enumerator": "overdue", "translation_path": "co.InstallmentStatus.overdue" }, "old_due_date": null }, { "amount": 12.3, "created_at": "2022-11-25T09:24:45", "event_date": "2022-11-25T09:24:44", "installment_event_type": { "enumerator": "delay_fine", "translation_path": "co.InstallmentEventType.delay_fine" }, "installment_old_status": { "enumerator": "overdue", "translation_path": "co.InstallmentStatus.overdue" }, "old_due_date": null }, { "amount": 12.84, "created_at": "2022-11-28T09:37:41", "event_date": "2022-11-28T09:37:41", "installment_event_type": { "enumerator": "delay_fine", "translation_path": "co.InstallmentEventType.delay_fine" }, "installment_old_status": { "enumerator": "overdue", "translation_path": "co.InstallmentStatus.overdue" }, "old_due_date": null }, { "amount": 13.02, "created_at": "2022-11-29T09:17:44", "event_date": "2022-11-29T09:17:44", "installment_event_type": { "enumerator": "delay_fine", "translation_path": "co.InstallmentEventType.delay_fine" }, "installment_old_status": { "enumerator": "overdue", "translation_path": "co.InstallmentStatus.overdue" }, "old_due_date": null } ], "fine_amount": 13.02, "has_interest": true, "installment_key": "1d76836e-1fcc-4b67-8c01-64faa43de9c8", "installment_number": 1, "installment_payment": [], "installment_status": { "enumerator": "overdue", "translation_path": "co.InstallmentStatus.overdue" }, "installment_type": { "enumerator": "principal", "translation_path": "co.InstallmentType.principal" }, "original_due_principal": 3038.72, "original_pre_fixed_amount": 75.66402982, "original_principal_amortization_amount": 476.64597018, "original_total_amount": 552.31, "paid_amount": 0, "paid_at": null, "payment_type": { "enumerator": "bankslip", "translation_path": "co.PaymentType.bankslip" }, "post_fixed_amount": 0, "pre_fixed_amount": 75.66402982, "principal_amortization_amount": 476.64597018, "qr_code_key": "bdd41d56-8588-4468-9705-5233994cdc39", "qr_code_url": "00020126970014br.gov.bcb.pix2575qrcode-h.sandbox.qitech.app/bacen/cobv/bdd41d56-8588-4468-9705-5233994cdc395204000053039865802BR5925QI SOCIEDADE DE CREDITO D6009Sao Paulo61080145200062070503***63044F44", "renegotiation_proposal_key": null, "tax_amount": 1.17254909, "total_accrual_amount": null, "total_amount": 565.33, "total_paid_amount": 0, "updated_at": "2022-11-29T09:17:44", "workdays": 20 }, { "accrual_reference_date": null, "additional_costs": [], "advanced_paid_amount": 0, "bank_slip_key": "527835e4-7b09-42f2-a7d0-befed3a326fd", "business_due_date": "2022-12-20", "calendar_days": 31, "cetip_settlements": [], "created_at": "2022-10-19T11:53:00", "digitable_line": "32990001031000699925349000000205492040000055231", "due_date": "2022-12-19", "due_interest": 0, "due_principal": 2562.07402982, "events": [ { "amount": null, "created_at": "2022-10-19T11:54:47", "event_date": "2022-10-19T11:54:47", "installment_event_type": { "enumerator": "open", "translation_path": "co.InstallmentEventType.open" }, "installment_old_status": { "enumerator": "created", "translation_path": "co.InstallmentStatus.created" }, "old_due_date": null } ], "fine_amount": null, "has_interest": true, "installment_key": "dde36938-8594-4507-a87d-cd2dd5309817", "installment_number": 2, "installment_payment": [], "installment_status": { "enumerator": "opened", "translation_path": "co.InstallmentStatus.opened" }, "installment_type": { "enumerator": "principal", "translation_path": "co.InstallmentType.principal" }, "original_due_principal": 2562.07402982, "original_pre_fixed_amount": 65.94922003, "original_principal_amortization_amount": 486.36077997, "original_total_amount": 552.31, "paid_amount": 0, "paid_at": null, "payment_type": { "enumerator": "bankslip", "translation_path": "co.PaymentType.bankslip" }, "post_fixed_amount": 0, "pre_fixed_amount": 65.94922003, "principal_amortization_amount": 486.36077997, "qr_code_key": "9d2980e9-fa0c-4b21-a7c5-5ca266c9aba8", "qr_code_url": "00020126970014br.gov.bcb.pix2575qrcode-h.sandbox.qitech.app/bacen/cobv/9d2980e9-fa0c-4b21-a7c5-5ca266c9aba85204000053039865802BR5925QI SOCIEDADE DE CREDITO D6009Sao Paulo61080145200062070503***6304FBC3", "renegotiation_proposal_key": null, "tax_amount": 2.43277662, "total_accrual_amount": null, "total_amount": 552.31, "total_paid_amount": 0, "updated_at": "2022-10-19T11:56:43", "workdays": 21 }, { "accrual_reference_date": null, "additional_costs": [], "advanced_paid_amount": 0, "bank_slip_key": "d69c9ab6-01f1-40bb-9519-a06ee2230c22", "business_due_date": "2023-01-19", "calendar_days": 30, "cetip_settlements": [], "created_at": "2022-10-19T11:53:00", "digitable_line": "32990001031000699925350000000203192340000055231", "due_date": "2023-01-18", "due_interest": 0, "due_principal": 2075.71324985, "events": [ { "amount": null, "created_at": "2022-10-19T11:54:47", "event_date": "2022-10-19T11:54:47", "installment_event_type": { "enumerator": "open", "translation_path": "co.InstallmentEventType.open" }, "installment_old_status": { "enumerator": "created", "translation_path": "co.InstallmentStatus.created" }, "old_due_date": null } ], "fine_amount": null, "has_interest": true, "installment_key": "93273ee0-71bd-46a6-b5e2-39e03a365b16", "installment_number": 3, "installment_payment": [], "installment_status": { "enumerator": "opened", "translation_path": "co.InstallmentStatus.opened" }, "installment_type": { "enumerator": "principal", "translation_path": "co.InstallmentType.principal" }, "original_due_principal": 2075.71324985, "original_pre_fixed_amount": 51.68519286, "original_principal_amortization_amount": 500.62480714, "original_total_amount": 552.31, "paid_amount": 0, "paid_at": null, "payment_type": { "enumerator": "bankslip", "translation_path": "co.PaymentType.bankslip" }, "post_fixed_amount": 0, "pre_fixed_amount": 51.68519286, "principal_amortization_amount": 500.62480714, "qr_code_key": "d79eb27b-7a1e-4d4c-94a1-f20045c4904e", "qr_code_url": "00020126970014br.gov.bcb.pix2575qrcode-h.sandbox.qitech.app/bacen/cobv/d79eb27b-7a1e-4d4c-94a1-f20045c4904e5204000053039865802BR5925QI SOCIEDADE DE CREDITO D6009Sao Paulo61080145200062070503***6304E949", "renegotiation_proposal_key": null, "tax_amount": 3.73566231, "total_accrual_amount": null, "total_amount": 552.31, "total_paid_amount": 0, "updated_at": "2022-10-19T11:56:43", "workdays": 22 }, { "accrual_reference_date": null, "additional_costs": [], "advanced_paid_amount": 0, "bank_slip_key": "5c62c50f-5326-4226-b154-a0cc6d2f62e7", "business_due_date": "2023-02-23", "calendar_days": 35, "cetip_settlements": [], "created_at": "2022-10-19T11:53:00", "digitable_line": "32990001031000699925351000000201192690000055231", "due_date": "2023-02-22", "due_interest": 0, "due_principal": 1575.08844271, "events": [ { "amount": null, "created_at": "2022-10-19T11:54:47", "event_date": "2022-10-19T11:54:47", "installment_event_type": { "enumerator": "open", "translation_path": "co.InstallmentEventType.open" }, "installment_old_status": { "enumerator": "created", "translation_path": "co.InstallmentStatus.created" }, "old_due_date": null } ], "fine_amount": null, "has_interest": true, "installment_key": "1f7b16fe-04b6-4f07-a807-eb3501e44e0d", "installment_number": 4, "installment_payment": [], "installment_status": { "enumerator": "opened", "translation_path": "co.InstallmentStatus.opened" }, "installment_type": { "enumerator": "principal", "translation_path": "co.InstallmentType.principal" }, "original_due_principal": 1575.08844271, "original_pre_fixed_amount": 45.8505547, "original_principal_amortization_amount": 506.4594453, "original_total_amount": 552.31, "paid_amount": 0, "paid_at": null, "payment_type": { "enumerator": "bankslip", "translation_path": "co.PaymentType.bankslip" }, "post_fixed_amount": 0, "pre_fixed_amount": 45.8505547, "principal_amortization_amount": 506.4594453, "qr_code_key": "b55464c8-3764-4ee2-a814-ce22396aabe7", "qr_code_url": "00020126970014br.gov.bcb.pix2575qrcode-h.sandbox.qitech.app/bacen/cobv/b55464c8-3764-4ee2-a814-ce22396aabe75204000053039865802BR5925QI SOCIEDADE DE CREDITO D6009Sao Paulo61080145200062070503***63044215", "renegotiation_proposal_key": null, "tax_amount": 5.23273899, "total_accrual_amount": null, "total_amount": 552.31, "total_paid_amount": 0, "updated_at": "2022-10-19T11:56:43", "workdays": 23 }, { "accrual_reference_date": null, "additional_costs": [], "advanced_paid_amount": 0, "bank_slip_key": "256be15f-dcc6-4775-8298-c3efde5a1147", "business_due_date": "2023-03-21", "calendar_days": 26, "cetip_settlements": [], "created_at": "2022-10-19T11:53:00", "digitable_line": "32990001031000699925352000000209192950000055231", "due_date": "2023-03-20", "due_interest": 0, "due_principal": 1068.62899741, "events": [ { "amount": null, "created_at": "2022-10-19T11:54:47", "event_date": "2022-10-19T11:54:47", "installment_event_type": { "enumerator": "open", "translation_path": "co.InstallmentEventType.open" }, "installment_old_status": { "enumerator": "created", "translation_path": "co.InstallmentStatus.created" }, "old_due_date": null } ], "fine_amount": null, "has_interest": true, "installment_key": "3ed37dc1-61f8-44f1-af21-a55f0cf0795d", "installment_number": 5, "installment_payment": [], "installment_status": { "enumerator": "opened", "translation_path": "co.InstallmentStatus.opened" }, "installment_type": { "enumerator": "principal", "translation_path": "co.InstallmentType.principal" }, "original_due_principal": 1068.62899741, "original_pre_fixed_amount": 23.02305805, "original_principal_amortization_amount": 529.28694195, "original_total_amount": 552.31, "paid_amount": 0, "paid_at": null, "payment_type": { "enumerator": "bankslip", "translation_path": "co.PaymentType.bankslip" }, "post_fixed_amount": 0, "pre_fixed_amount": 23.02305805, "principal_amortization_amount": 529.28694195, "qr_code_key": "64e05528-83fb-432a-8af7-491ca4eb7b90", "qr_code_url": "00020126970014br.gov.bcb.pix2575qrcode-h.sandbox.qitech.app/bacen/cobv/64e05528-83fb-432a-8af7-491ca4eb7b905204000053039865802BR5925QI SOCIEDADE DE CREDITO D6009Sao Paulo61080145200062070503***630472F7", "renegotiation_proposal_key": null, "tax_amount": 6.59703244, "total_accrual_amount": null, "total_amount": 552.31, "total_paid_amount": 0, "updated_at": "2022-10-19T11:56:43", "workdays": 18 }, { "accrual_reference_date": null, "additional_costs": [], "advanced_paid_amount": 0, "bank_slip_key": "a8c2edaa-ed3d-4c5b-808e-b26947a5e79e", "business_due_date": "2023-04-19", "calendar_days": 29, "cetip_settlements": [], "created_at": "2022-10-19T11:53:01", "digitable_line": "32990001031000699925353000000207293240000055232", "due_date": "2023-04-18", "due_interest": 0, "due_principal": 539.34205545, "events": [ { "amount": null, "created_at": "2022-10-19T11:54:47", "event_date": "2022-10-19T11:54:47", "installment_event_type": { "enumerator": "open", "translation_path": "co.InstallmentEventType.open" }, "installment_old_status": { "enumerator": "created", "translation_path": "co.InstallmentStatus.created" }, "old_due_date": null } ], "fine_amount": null, "has_interest": true, "installment_key": "2b58b2be-89cd-4710-a6a5-81180938b501", "installment_number": 6, "installment_payment": [], "installment_status": { "enumerator": "opened", "translation_path": "co.InstallmentStatus.opened" }, "installment_type": { "enumerator": "principal", "translation_path": "co.InstallmentType.principal" }, "original_due_principal": 539.34205545, "original_pre_fixed_amount": 12.97660456, "original_principal_amortization_amount": 539.34339544, "original_total_amount": 552.32, "paid_amount": 0, "paid_at": null, "payment_type": { "enumerator": "bankslip", "translation_path": "co.PaymentType.bankslip" }, "post_fixed_amount": 0, "pre_fixed_amount": 12.97660456, "principal_amortization_amount": 539.34339544, "qr_code_key": "dcc7d257-e6a1-4d0a-88f7-1acf662482b5", "qr_code_url": "00020126970014br.gov.bcb.pix2575qrcode-h.sandbox.qitech.app/bacen/cobv/dcc7d257-e6a1-4d0a-88f7-1acf662482b55204000053039865802BR5925QI SOCIEDADE DE CREDITO D6009Sao Paulo61080145200062070503***6304C9A1", "renegotiation_proposal_key": null, "tax_amount": 8.00493468, "total_accrual_amount": null, "total_amount": 552.32, "total_paid_amount": 0, "updated_at": "2022-10-19T11:56:43", "workdays": 20 } ], "interest_grace_period": 0, "interest_payment_month_period": 1, "interest_subsidy_amount": 0, "interest_subsidy_percentage": 0, "interest_type": { "enumerator": "pre_price_days", "translation_path": "co.InterestType.pre_price_days" }, "iof_charge_method": "financed", "ipoc_code": "324025020203192147661180DiDi118261", "is_allowed_to_disburse": true, "is_portability": false, "is_refinancing": 0, "isin_number": null, "issue_amount": 3038.72, "issue_date": "2022-10-19", "issuer_document_number": "92147661180", "issuer_name": "Wxy Wsx", "kyc": null, "modality": { "code": "0203", "description": "crédito pessoal - sem consignação em folha de pagam.", "enumerator": null, "visible": true }, "net_external_contract_fee_amount": 0, "next_due_date": "2022-12-19", "number_of_installments": 6, "operation_extra_fields": null, "operation_type": { "enumerator": "structured_operation", "translation_path": "co.OperationType.structured_operation" }, "origin_key": "438ceaa3-2906-4ee3-85f9-0dcacd5f2581", "origin_type": { "enumerator": "lego-api", "translation_path": "co.OriginType.lego-api" }, "original_prefixed_interest_rate": { "annual_rate": 0.34331516, "created_at": "2022-10-19T11:53:00", "daily_rate": 0.00082017, "interest_base": { "enumerator": "calendar_days", "translation_path": "co.InterestBase.calendar_days", "year_days": 360 }, "monthly_rate": 0.0249 }, "original_total_iof": 38.72, "payment_and_settlement_agent": { "enumerator": "qi_scd", "translation_path": "co.PaymentAndSettlementAgent.qi_scd" }, "payment_type": { "enumerator": "bankslip", "translation_path": "co.PaymentType.bankslip" }, "payroll_data": null, "portability_amount": null, "portability_financial_institution_code_number": null, "portability_original_contract": null, "post_fixed_interest_base": { "enumerator": "workdays", "translation_path": "co.InterestBase.workdays", "year_days": 252 }, "post_fixed_interest_rate": null, "prefixed_interest_rate": { "annual_rate": 0.34331516, "created_at": "2022-10-19T11:53:00", "daily_rate": 0.00082017, "interest_base": { "enumerator": "calendar_days", "translation_path": "co.InterestBase.calendar_days", "year_days": 360 }, "monthly_rate": 0.0249 }, "principal_amortization_month_period": 1, "principal_grace_period": 0, "purchaser_document_number": "32402502000135", "rebate_account": null, "refinanced_credit_operations": [], "registration_institution": { "enumerator": "qi_scd", "translation_path": "co.RegistrationInstitution.qi_scd" }, "related_party_list": [ { "address": { "city": "Aguascalientes", "complement": null, "created_at": "2022-10-19T11:52:59", "neighborhood": "Aguascalientes", "number": "1", "postal_code": "20000000", "state": "SP", "street": "Zona Centro" }, "attached_document_list": [ { "created_at": "2022-10-19T11:53:01", "document_key": "5df59dca-b8d1-4dca-8358-8b4bd944f3dc", "document_type": { "enumerator": "document_identification", "translation_path": "co.DocumentType.document_identification" }, "document_url": "https://storage.googleapis.com/sandbox-doc-api/documents/5df59dca-b8d1-4dca-8358-8b4bd944f3dc/image_1666180300436.jpg", "related_party_key": null, "signature_required": false, "signature_url": null, "signed": false } ], "birth_date": "1997-10-19", "birth_place": null, "cnae_code": null, "company_document_number": null, "created_at": "2022-10-19T11:53:01", "document_identification_date": null, "document_identification_number": "", "document_identification_type": null, "email": "wxr@ff.com", "foundation_date": null, "gender": null, "income": 0.01, "individual_document_number": "92147661180", "is_pep": false, "marital_status": { "enumerator": "single", "translation_path": "co.MaritalStatus.single" }, "mother_name": null, "name": "Wxy Wsx", "nationality": "nationality", "person_type": "natural", "phone": { "area_code": "00", "country_code": "055", "created_at": "2022-10-19T11:53:00", "number": "016048311", "phone_key": "341d7c67-963c-49a5-b585-265425d71f52", "phone_type": null }, "profession": null, "property_system": null, "related_party_key": "203b2ada-ff3e-44a6-a843-f244aa1afbc9", "revenue": null, "role_type": { "enumerator": "issuer", "translation_path": "co.RoleType.issuer" }, "simples_nacional_participant": null, "spouse_document_number": null, "trading_name": null } ], "requester_identifier_key": "89bb875a4a654ecfbad0c6ce0b3b5037", "requester_key": "75f2ab85-a5ce-40b9-9b1e-915175906d78", "requester_name": "DiDi Global (99Pay)", "resource_source_account": { "enumerator": "third_party", "translation_path": "co.ResourceSourceAccount.third_party" }, "selfie_enabled": false, "settlement_bank_account_key": null, "share_quantity": 4, "signature_method": { "enumerator": "email" }, "tax_configuration": { "created_at": "2019-03-15T13:09:32", "iof_additional_rate": 0.0038, "iof_rate": 0.000082 }, "tax_exempt_amount": null, "third_party_account_key": "5d068423-6094-49e4-b15b-7740038295a8", "total_iof": 38.72 }, "operation_key": "438ceaa3-2906-4ee3-85f9-0dcacd5f2581", "status": "opened", "webhook_type": "signed_debt" } ``` STATUS 400 Response Body ```json { "data": "{\"title\": \"Bad Request\", \"description\": \"Invalid request body.\", \"translation\": \"Corpo da requisição inválido.\", \"extra_fields\": {}, \"code\": \"LEG000069\"}" } ``` ## Query Params | Campo | Tipo | Descrição | Caracteres | |---|---|-------------------------------------------------------------------------| ---| | `key` | string | Chave da divida devolvida no momento da criação da operação de crédito. | - | | `requester_identifier_key` | string | Chave da UUID4 enviada na criação da dívida. | - | | `contract_number` | string | Número da CCB retornado na emissão de dívida. | - | | `issuer_document_number` | string | Número de documento do emitente. | - | | `issuer_name` | string | Nome do emitente da dívida. | - | | `status` | string | Status da operação. | - | | `page` | string | Página atual que está sendo consultada. | - | | `page_size` | string | Quantidade de resultados que cabem na página. | - | | `total_due_balance` | boolean | Quando enviado como `true`, inclui o campo `balance_due` (saldo devedor total da operação) na resposta. Por padrão, o `balance_due` **não** é retornado. | - | --- # Consulta de dívida por Contract Number URL: /documentation/emissao_de_divida/consulta_por_contract_number ## Request ENDPOINT /v2/credit_operation/contract_number/ CONTRACT-NUMBER MÉTODO GET ## ⚠️ Observação Importante Caso o número do contrato contenha uma barra (`/`), é necessário **encodar a barra** para `%2F`. ### Exemplo prático **Entrada original:** ``` contract_number = 02159312/FGP ``` **Deve ser enviada como:** ``` 02159312%2FFGP ``` ### Exemplo em Python para encodar: ```python import urllib.parse contract_number = "02159312/FGP" encoded_contract_number = urllib.parse.quote(contract_number) print(encoded_contract_number) # 02159312%2FFGP ``` ::: ### Path params | Campo | Tipo | Descrição | Caracteres | |---|---|---|---| | `contract_number` * | string | Número do contrato de crédito. | string | ## Response STATUS 200 Response Body ```json { "credit_operation_key": "eaf5836a-ea6f-4baa-ac26-ce5199dfa448", "issue_amount": 1006.77, "origin_key": "52539e23-5c01-4b9c-8a68-6ed750ec7bc5", "assigned_at": "2025-08-24T10:00:00Z", "total_iof": 6.77, "disbursement_start_date": "2022-08-24", "disbursement_end_date": "2022-08-24", "issue_date": "2022-08-24", "requester_identifier_key": "5cb7456c-f2e3-41b3-b17a-ad47ba3c3cda", "installments": [ { "business_due_date": "2022-08-30", "due_date": "2022-08-29", "calendar_days": 5, "due_interest": 0, "due_principal": 1006.77, "fine_amount": 0, "has_interest": true, "post_fixed_amount": 0, "pre_fixed_amount": 18.93, "principal_amortization_amount": 363.14, "tax_amount": 0.15, "total_amount": 382.07, "workdays": 3, "accrual_reference_date": null, "advanced_paid_amount": 0.0, "bank_slip_key": null, "digitable_line": null, "installment_key": "b56f61ec-202c-4a7a-8a5e-11f90972bae8", "installment_status": "created", "installment_type": "principal", "original_due_principal": 1006.77, "original_pre_fixed_amount": 18.93, "original_principal_amortization_amount": 363.14, "paid_amount": 0.0, "original_total_amount": 382.07, "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": "2022-09-30", "due_date": "2022-09-29", "calendar_days": 31, "due_interest": 0, "due_principal": 643.63499424, "fine_amount": 0, "has_interest": true, "post_fixed_amount": 0, "pre_fixed_amount": 78.82, "principal_amortization_amount": 303.25, "tax_amount": 0.9, "total_amount": 382.07, "workdays": 22, "accrual_reference_date": null, "advanced_paid_amount": 0.0, "bank_slip_key": null, "digitable_line": null, "installment_key": "2a95a560-bec6-4207-9a38-98c72e023c59", "installment_status": "created", "installment_type": "principal", "original_due_principal": 643.63, "original_pre_fixed_amount": 78.82, "original_principal_amortization_amount": 303.25, "paid_amount": 0.0, "original_total_amount": 382.07, "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": "2022-11-01", "due_date": "2022-10-31", "calendar_days": 32, "due_interest": 0, "due_principal": 340.38585509, "fine_amount": 0, "has_interest": true, "post_fixed_amount": 0, "pre_fixed_amount": 41.68, "principal_amortization_amount": 340.39, "tax_amount": 1.9, "total_amount": 382.07, "workdays": 21, "accrual_reference_date": null, "advanced_paid_amount": 0.0, "bank_slip_key": null, "digitable_line": null, "installment_key": "61924f59-11e3-49d0-9cf7-2a1d0ce54924", "installment_status": "created", "installment_type": "principal", "original_due_principal": 340.39, "original_pre_fixed_amount": 41.68, "original_principal_amortization_amount": 340.39, "paid_amount": 0.0, "original_total_amount": 382.07, "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 } ], "first_due_date": "2022-08-29", "requester_key": "52f36417-368e-4f5b-8841-71e3b9caa72f", "original_total_iof": 6.77, "contract_number": "0000000001/WO", "credit_operation_status_enumerator": "waiting_signature", "operation_type_enumerator": "structured_operation", "disbursement_date": "2022-08-24", "issuer_name": "Wilker Oliveiraço", "issuer_document_number": "37197645832", "external_contract_fees": [ { "amount_type": { "enumerator": "percentage" }, "fee_amount": 0.0, "tax_amount": 0.0, "irrf_amount": 0.0, "amount": 0.0, "pis_amount": 0.0, "amount_released": 0.0, "fee_type": { "enumerator": "tac" }, "cofins_amount": 0.0, "csll_amount": 0.0, "description": null, "net_fee_amount": 0.0, "rebate_account": null, "billing_type": { "enumerator": "disbursement" }, "created_at": "2025-10-14T22:18:07" }, { "amount_type": { "enumerator": "absolute" }, "fee_amount": 0.0, "tax_amount": 0.0, "irrf_amount": 0.0, "amount": 0.0, "pis_amount": 0.0, "amount_released": 0.0, "fee_type": { "enumerator": "spread_tax_free" }, "cofins_amount": 0.0, "csll_amount": 0.0, "description": null, "net_fee_amount": 0.0, "rebate_account": null, "billing_type": { "enumerator": "disbursement" }, "created_at": "2025-10-14T22:18:07" }, { "amount_type": { "enumerator": "absolute" }, "fee_amount": 0.0, "tax_amount": 0.0, "irrf_amount": 0.0, "amount": 0.0, "pis_amount": 0.0, "amount_released": 0.0, "fee_type": { "enumerator": "tac_tax_free" }, "cofins_amount": 0.0, "csll_amount": 0.0, "description": null, "net_fee_amount": 0.0, "rebate_account": null, "billing_type": { "enumerator": "disbursement" }, "created_at": "2025-10-14T22:18:07" } ] } ``` STATUS 400 Response Body ```json { "data": "{\"title\": \"Bad Request\", \"description\": \"Invalid request body.\", \"translation\": \"Corpo da requisição inválido.\", \"extra_fields\": {}, \"code\": \"LEG000069\"}" } ``` --- # Consulta de dívida por Credit Operation Key URL: /documentation/emissao_de_divida/consulta_por_credit_operation_key ## Request ENDPOINT /v2/credit_operation/ CREDIT-OPERATION-KEY MÉTODO GET ### Path params | Campo | Tipo | Descrição | Caracteres | |---|---|---|---| | `credit_operation_key` * | string | Chave da operação de crédito. | UUID | ### Query params | Campo | Tipo | Descrição | Default | |---|---|---|---| | `eval_present_value` | boolean | Quando `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_delay` | boolean | Considera juros de mora no cálculo do valor presente. Só tem efeito quando `eval_present_value=true`. | `false` | | `calculate_spread` | boolean | Considera o spread no cálculo do valor presente. Só tem efeito quando `eval_present_value=true`. | `true` | | `present_value_reference_date` | string (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 Response Body **Sem eval_present_value** ```json { "credit_operation_key": "eaf5836a-ea6f-4baa-ac26-ce5199dfa448", "issue_amount": 1006.77, "origin_key": "52539e23-5c01-4b9c-8a68-6ed750ec7bc5", "total_iof": 6.77, "disbursement_start_date": "2022-08-24", "disbursement_end_date": "2022-08-24", "assigned_at": "2025-08-24T10:00:00Z", "issue_date": "2022-08-24", "requester_identifier_key": "5cb7456c-f2e3-41b3-b17a-ad47ba3c3cda", "installments": [ { "business_due_date": "2022-08-30", "due_date": "2022-08-29", "calendar_days": 5, "due_interest": 0, "due_principal": 1006.77, "fine_amount": 0, "has_interest": true, "post_fixed_amount": 0, "pre_fixed_amount": 18.93, "principal_amortization_amount": 363.14, "tax_amount": 0.15, "total_amount": 382.07, "workdays": 3, "accrual_reference_date": null, "advanced_paid_amount": 0.0, "bank_slip_key": null, "digitable_line": null, "installment_key": "b56f61ec-202c-4a7a-8a5e-11f90972bae8", "installment_status": "created", "installment_type": "principal", "original_due_principal": 1006.77, "original_pre_fixed_amount": 18.93, "original_principal_amortization_amount": 363.14, "paid_amount": 0.0, "original_total_amount": 382.07, "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": "2022-09-30", "due_date": "2022-09-29", "calendar_days": 31, "due_interest": 0, "due_principal": 643.63499424, "fine_amount": 0, "has_interest": true, "post_fixed_amount": 0, "pre_fixed_amount": 78.82, "principal_amortization_amount": 303.25, "tax_amount": 0.9, "total_amount": 382.07, "workdays": 22, "accrual_reference_date": null, "advanced_paid_amount": 0.0, "bank_slip_key": null, "digitable_line": null, "installment_key": "2a95a560-bec6-4207-9a38-98c72e023c59", "installment_status": "created", "installment_type": "principal", "original_due_principal": 643.63, "original_pre_fixed_amount": 78.82, "original_principal_amortization_amount": 303.25, "paid_amount": 0.0, "original_total_amount": 382.07, "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": "2022-11-01", "due_date": "2022-10-31", "calendar_days": 32, "due_interest": 0, "due_principal": 340.38585509, "fine_amount": 0, "has_interest": true, "post_fixed_amount": 0, "pre_fixed_amount": 41.68, "principal_amortization_amount": 340.39, "tax_amount": 1.9, "total_amount": 382.07, "workdays": 21, "accrual_reference_date": null, "advanced_paid_amount": 0.0, "bank_slip_key": null, "digitable_line": null, "installment_key": "61924f59-11e3-49d0-9cf7-2a1d0ce54924", "installment_status": "created", "installment_type": "principal", "original_due_principal": 340.39, "original_pre_fixed_amount": 41.68, "original_principal_amortization_amount": 340.39, "paid_amount": 0.0, "original_total_amount": 382.07, "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 } ], "first_due_date": "2022-08-29", "requester_key": "52f36417-368e-4f5b-8841-71e3b9caa72f", "original_total_iof": 6.77, "contract_number": "0000000001/WO", "credit_operation_status_enumerator": "waiting_signature", "operation_type_enumerator": "structured_operation", "disbursement_date": "2022-08-24", "issuer_name": "Wilker Oliveiraço", "issuer_document_number": "37197645832", "external_contract_fees": [ { "amount_type": { "enumerator": "percentage" }, "fee_amount": 0.0, "tax_amount": 0.0, "irrf_amount": 0.0, "amount": 0.0, "pis_amount": 0.0, "amount_released": 0.0, "fee_type": { "enumerator": "tac" }, "cofins_amount": 0.0, "csll_amount": 0.0, "description": null, "net_fee_amount": 0.0, "rebate_account": null, "billing_type": { "enumerator": "disbursement" }, "created_at": "2025-10-14T22:18:07" }, { "amount_type": { "enumerator": "absolute" }, "fee_amount": 0.0, "tax_amount": 0.0, "irrf_amount": 0.0, "amount": 0.0, "pis_amount": 0.0, "amount_released": 0.0, "fee_type": { "enumerator": "spread_tax_free" }, "cofins_amount": 0.0, "csll_amount": 0.0, "description": null, "net_fee_amount": 0.0, "rebate_account": null, "billing_type": { "enumerator": "disbursement" }, "created_at": "2025-10-14T22:18:07" }, { "amount_type": { "enumerator": "absolute" }, "fee_amount": 0.0, "tax_amount": 0.0, "irrf_amount": 0.0, "amount": 0.0, "pis_amount": 0.0, "amount_released": 0.0, "fee_type": { "enumerator": "tac_tax_free" }, "cofins_amount": 0.0, "csll_amount": 0.0, "description": null, "net_fee_amount": 0.0, "rebate_account": null, "billing_type": { "enumerator": "disbursement" }, "created_at": "2025-10-14T22:18:07" } ] } ``` **Com eval_present_value=true** ```json { "credit_operation_key": "eaf5836a-ea6f-4baa-ac26-ce5199dfa448", "issue_amount": 1006.77, "present_amount": 889.87, "origin_key": "52539e23-5c01-4b9c-8a68-6ed750ec7bc5", "total_iof": 6.77, "disbursement_start_date": "2022-08-24", "disbursement_end_date": "2022-08-24", "assigned_at": "2025-08-24T10:00:00Z", "issue_date": "2022-08-24", "requester_identifier_key": "5cb7456c-f2e3-41b3-b17a-ad47ba3c3cda", "installments": [ { "business_due_date": "2022-08-30", "due_date": "2022-08-29", "calendar_days": 5, "due_interest": 0, "due_principal": 1006.77, "fine_amount": 0, "has_interest": true, "post_fixed_amount": 0, "pre_fixed_amount": 18.93, "principal_amortization_amount": 363.14, "tax_amount": 0.15, "total_amount": 382.07, "workdays": 3, "accrual_reference_date": null, "advanced_paid_amount": 0.0, "bank_slip_key": null, "digitable_line": null, "installment_key": "b56f61ec-202c-4a7a-8a5e-11f90972bae8", "installment_status": "created", "installment_type": "principal", "original_due_principal": 1006.77, "original_pre_fixed_amount": 18.93, "original_principal_amortization_amount": 363.14, "paid_amount": 0.0, "original_total_amount": 382.07, "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, "present_amount": 296.62 }, { "business_due_date": "2022-09-30", "due_date": "2022-09-29", "calendar_days": 31, "due_interest": 0, "due_principal": 643.63499424, "fine_amount": 0, "has_interest": true, "post_fixed_amount": 0, "pre_fixed_amount": 78.82, "principal_amortization_amount": 303.25, "tax_amount": 0.9, "total_amount": 382.07, "workdays": 22, "accrual_reference_date": null, "advanced_paid_amount": 0.0, "bank_slip_key": null, "digitable_line": null, "installment_key": "2a95a560-bec6-4207-9a38-98c72e023c59", "installment_status": "created", "installment_type": "principal", "original_due_principal": 643.63, "original_pre_fixed_amount": 78.82, "original_principal_amortization_amount": 303.25, "paid_amount": 0.0, "original_total_amount": 382.07, "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, "present_amount": 296.62 }, { "business_due_date": "2022-11-01", "due_date": "2022-10-31", "calendar_days": 32, "due_interest": 0, "due_principal": 340.38585509, "fine_amount": 0, "has_interest": true, "post_fixed_amount": 0, "pre_fixed_amount": 41.68, "principal_amortization_amount": 340.39, "tax_amount": 1.9, "total_amount": 382.07, "workdays": 21, "accrual_reference_date": null, "advanced_paid_amount": 0.0, "bank_slip_key": null, "digitable_line": null, "installment_key": "61924f59-11e3-49d0-9cf7-2a1d0ce54924", "installment_status": "created", "installment_type": "principal", "original_due_principal": 340.39, "original_pre_fixed_amount": 41.68, "original_principal_amortization_amount": 340.39, "paid_amount": 0.0, "original_total_amount": 382.07, "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, "present_amount": 296.63 } ], "first_due_date": "2022-08-29", "requester_key": "52f36417-368e-4f5b-8841-71e3b9caa72f", "original_total_iof": 6.77, "contract_number": "0000000001/WO", "credit_operation_status_enumerator": "waiting_signature", "operation_type_enumerator": "structured_operation", "disbursement_date": "2022-08-24", "issuer_name": "Wilker Oliveiraço", "issuer_document_number": "37197645832", "external_contract_fees": [ { "amount_type": { "enumerator": "percentage" }, "fee_amount": 0.0, "tax_amount": 0.0, "irrf_amount": 0.0, "amount": 0.0, "pis_amount": 0.0, "amount_released": 0.0, "fee_type": { "enumerator": "tac" }, "cofins_amount": 0.0, "csll_amount": 0.0, "description": null, "net_fee_amount": 0.0, "rebate_account": null, "billing_type": { "enumerator": "disbursement" }, "created_at": "2025-10-14T22:18:07" }, { "amount_type": { "enumerator": "absolute" }, "fee_amount": 0.0, "tax_amount": 0.0, "irrf_amount": 0.0, "amount": 0.0, "pis_amount": 0.0, "amount_released": 0.0, "fee_type": { "enumerator": "spread_tax_free" }, "cofins_amount": 0.0, "csll_amount": 0.0, "description": null, "net_fee_amount": 0.0, "rebate_account": null, "billing_type": { "enumerator": "disbursement" }, "created_at": "2025-10-14T22:18:07" }, { "amount_type": { "enumerator": "absolute" }, "fee_amount": 0.0, "tax_amount": 0.0, "irrf_amount": 0.0, "amount": 0.0, "pis_amount": 0.0, "amount_released": 0.0, "fee_type": { "enumerator": "tac_tax_free" }, "cofins_amount": 0.0, "csll_amount": 0.0, "description": null, "net_fee_amount": 0.0, "rebate_account": null, "billing_type": { "enumerator": "disbursement" }, "created_at": "2025-10-14T22:18:07" } ] } ``` STATUS 400 Response Body ```json { "data": "{\"title\": \"Bad Request\", \"description\": \"Invalid request body.\", \"translation\": \"Corpo da requisição inválido.\", \"extra_fields\": {}, \"code\": \"LEG000069\"}" } ``` --- # Consulta de dívida por Requester Identifier Key URL: /documentation/emissao_de_divida/consulta_por_requester_identifier_key ## Request ENDPOINT /v2/credit_operation/requester_identifier_key/ REQUESTER-IDENTIFIER-KEY MÉTODO GET ### Path params | Campo | Tipo | Descrição | Caracteres | |---|---|---|---| | `requester_identifier_key` * | string | Chave da UUID4 enviada na criação da dívida. | UUID | ### Query params | Campo | Tipo | Descrição | Default | |---|---|---|---| | `eval_present_value` | boolean | Quando `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_delay` | boolean | Considera juros de mora no cálculo do valor presente. Só tem efeito quando `eval_present_value=true`. | `false` | | `calculate_spread` | boolean | Considera o spread no cálculo do valor presente. Só tem efeito quando `eval_present_value=true`. | `true` | | `present_value_reference_date` | string (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 Response Body **Sem eval_present_value** ```json { "credit_operation_key": "eaf5836a-ea6f-4baa-ac26-ce5199dfa448", "issue_amount": 1006.77, "origin_key": "52539e23-5c01-4b9c-8a68-6ed750ec7bc5", "total_iof": 6.77, "disbursement_start_date": "2022-08-24", "disbursement_end_date": "2022-08-24", "assigned_at": "2025-08-24T10:00:00Z", "issue_date": "2022-08-24", "requester_identifier_key": "5cb7456c-f2e3-41b3-b17a-ad47ba3c3cda", "installments": [ { "business_due_date": "2022-08-30", "due_date": "2022-08-29", "calendar_days": 5, "due_interest": 0, "due_principal": 1006.77, "fine_amount": 0, "has_interest": true, "post_fixed_amount": 0, "pre_fixed_amount": 18.93, "principal_amortization_amount": 363.14, "tax_amount": 0.15, "total_amount": 382.07, "workdays": 3, "accrual_reference_date": null, "advanced_paid_amount": 0.0, "bank_slip_key": null, "digitable_line": null, "installment_key": "b56f61ec-202c-4a7a-8a5e-11f90972bae8", "installment_status": "created", "installment_type": "principal", "original_due_principal": 1006.77, "original_pre_fixed_amount": 18.93, "original_principal_amortization_amount": 363.14, "paid_amount": 0.0, "original_total_amount": 382.07, "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": "2022-09-30", "due_date": "2022-09-29", "calendar_days": 31, "due_interest": 0, "due_principal": 643.63499424, "fine_amount": 0, "has_interest": true, "post_fixed_amount": 0, "pre_fixed_amount": 78.82, "principal_amortization_amount": 303.25, "tax_amount": 0.9, "total_amount": 382.07, "workdays": 22, "accrual_reference_date": null, "advanced_paid_amount": 0.0, "bank_slip_key": null, "digitable_line": null, "installment_key": "2a95a560-bec6-4207-9a38-98c72e023c59", "installment_status": "created", "installment_type": "principal", "original_due_principal": 643.63, "original_pre_fixed_amount": 78.82, "original_principal_amortization_amount": 303.25, "paid_amount": 0.0, "original_total_amount": 382.07, "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": "2022-11-01", "due_date": "2022-10-31", "calendar_days": 32, "due_interest": 0, "due_principal": 340.38585509, "fine_amount": 0, "has_interest": true, "post_fixed_amount": 0, "pre_fixed_amount": 41.68, "principal_amortization_amount": 340.39, "tax_amount": 1.9, "total_amount": 382.07, "workdays": 21, "accrual_reference_date": null, "advanced_paid_amount": 0.0, "bank_slip_key": null, "digitable_line": null, "installment_key": "61924f59-11e3-49d0-9cf7-2a1d0ce54924", "installment_status": "created", "installment_type": "principal", "original_due_principal": 340.39, "original_pre_fixed_amount": 41.68, "original_principal_amortization_amount": 340.39, "paid_amount": 0.0, "original_total_amount": 382.07, "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 } ], "first_due_date": "2022-08-29", "requester_key": "52f36417-368e-4f5b-8841-71e3b9caa72f", "original_total_iof": 6.77, "contract_number": "0000000001/WO", "credit_operation_status_enumerator": "waiting_signature", "operation_type_enumerator": "structured_operation", "disbursement_date": "2022-08-24", "issuer_name": "Wilker Oliveiraço", "issuer_document_number": "37197645832", "external_contract_fees": [ { "amount_type": { "enumerator": "percentage" }, "fee_amount": 0.0, "tax_amount": 0.0, "irrf_amount": 0.0, "amount": 0.0, "pis_amount": 0.0, "amount_released": 0.0, "fee_type": { "enumerator": "tac" }, "cofins_amount": 0.0, "csll_amount": 0.0, "description": null, "net_fee_amount": 0.0, "rebate_account": null, "billing_type": { "enumerator": "disbursement" }, "created_at": "2025-10-14T22:18:07" }, { "amount_type": { "enumerator": "absolute" }, "fee_amount": 0.0, "tax_amount": 0.0, "irrf_amount": 0.0, "amount": 0.0, "pis_amount": 0.0, "amount_released": 0.0, "fee_type": { "enumerator": "spread_tax_free" }, "cofins_amount": 0.0, "csll_amount": 0.0, "description": null, "net_fee_amount": 0.0, "rebate_account": null, "billing_type": { "enumerator": "disbursement" }, "created_at": "2025-10-14T22:18:07" }, { "amount_type": { "enumerator": "absolute" }, "fee_amount": 0.0, "tax_amount": 0.0, "irrf_amount": 0.0, "amount": 0.0, "pis_amount": 0.0, "amount_released": 0.0, "fee_type": { "enumerator": "tac_tax_free" }, "cofins_amount": 0.0, "csll_amount": 0.0, "description": null, "net_fee_amount": 0.0, "rebate_account": null, "billing_type": { "enumerator": "disbursement" }, "created_at": "2025-10-14T22:18:07" } ] } ``` **Com eval_present_value=true** ```json { "credit_operation_key": "eaf5836a-ea6f-4baa-ac26-ce5199dfa448", "issue_amount": 1006.77, "present_amount": 889.87, "origin_key": "52539e23-5c01-4b9c-8a68-6ed750ec7bc5", "total_iof": 6.77, "disbursement_start_date": "2022-08-24", "disbursement_end_date": "2022-08-24", "assigned_at": "2025-08-24T10:00:00Z", "issue_date": "2022-08-24", "requester_identifier_key": "5cb7456c-f2e3-41b3-b17a-ad47ba3c3cda", "installments": [ { "business_due_date": "2022-08-30", "due_date": "2022-08-29", "calendar_days": 5, "due_interest": 0, "due_principal": 1006.77, "fine_amount": 0, "has_interest": true, "post_fixed_amount": 0, "pre_fixed_amount": 18.93, "principal_amortization_amount": 363.14, "tax_amount": 0.15, "total_amount": 382.07, "workdays": 3, "accrual_reference_date": null, "advanced_paid_amount": 0.0, "bank_slip_key": null, "digitable_line": null, "installment_key": "b56f61ec-202c-4a7a-8a5e-11f90972bae8", "installment_status": "created", "installment_type": "principal", "original_due_principal": 1006.77, "original_pre_fixed_amount": 18.93, "original_principal_amortization_amount": 363.14, "paid_amount": 0.0, "original_total_amount": 382.07, "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, "present_amount": 296.62 }, { "business_due_date": "2022-09-30", "due_date": "2022-09-29", "calendar_days": 31, "due_interest": 0, "due_principal": 643.63499424, "fine_amount": 0, "has_interest": true, "post_fixed_amount": 0, "pre_fixed_amount": 78.82, "principal_amortization_amount": 303.25, "tax_amount": 0.9, "total_amount": 382.07, "workdays": 22, "accrual_reference_date": null, "advanced_paid_amount": 0.0, "bank_slip_key": null, "digitable_line": null, "installment_key": "2a95a560-bec6-4207-9a38-98c72e023c59", "installment_status": "created", "installment_type": "principal", "original_due_principal": 643.63, "original_pre_fixed_amount": 78.82, "original_principal_amortization_amount": 303.25, "paid_amount": 0.0, "original_total_amount": 382.07, "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, "present_amount": 296.62 }, { "business_due_date": "2022-11-01", "due_date": "2022-10-31", "calendar_days": 32, "due_interest": 0, "due_principal": 340.38585509, "fine_amount": 0, "has_interest": true, "post_fixed_amount": 0, "pre_fixed_amount": 41.68, "principal_amortization_amount": 340.39, "tax_amount": 1.9, "total_amount": 382.07, "workdays": 21, "accrual_reference_date": null, "advanced_paid_amount": 0.0, "bank_slip_key": null, "digitable_line": null, "installment_key": "61924f59-11e3-49d0-9cf7-2a1d0ce54924", "installment_status": "created", "installment_type": "principal", "original_due_principal": 340.39, "original_pre_fixed_amount": 41.68, "original_principal_amortization_amount": 340.39, "paid_amount": 0.0, "original_total_amount": 382.07, "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, "present_amount": 296.63 } ], "first_due_date": "2022-08-29", "requester_key": "52f36417-368e-4f5b-8841-71e3b9caa72f", "original_total_iof": 6.77, "contract_number": "0000000001/WO", "credit_operation_status_enumerator": "waiting_signature", "operation_type_enumerator": "structured_operation", "disbursement_date": "2022-08-24", "issuer_name": "Wilker Oliveiraço", "issuer_document_number": "37197645832", "external_contract_fees": [ { "amount_type": { "enumerator": "percentage" }, "fee_amount": 0.0, "tax_amount": 0.0, "irrf_amount": 0.0, "amount": 0.0, "pis_amount": 0.0, "amount_released": 0.0, "fee_type": { "enumerator": "tac" }, "cofins_amount": 0.0, "csll_amount": 0.0, "description": null, "net_fee_amount": 0.0, "rebate_account": null, "billing_type": { "enumerator": "disbursement" }, "created_at": "2025-10-14T22:18:07" }, { "amount_type": { "enumerator": "absolute" }, "fee_amount": 0.0, "tax_amount": 0.0, "irrf_amount": 0.0, "amount": 0.0, "pis_amount": 0.0, "amount_released": 0.0, "fee_type": { "enumerator": "spread_tax_free" }, "cofins_amount": 0.0, "csll_amount": 0.0, "description": null, "net_fee_amount": 0.0, "rebate_account": null, "billing_type": { "enumerator": "disbursement" }, "created_at": "2025-10-14T22:18:07" }, { "amount_type": { "enumerator": "absolute" }, "fee_amount": 0.0, "tax_amount": 0.0, "irrf_amount": 0.0, "amount": 0.0, "pis_amount": 0.0, "amount_released": 0.0, "fee_type": { "enumerator": "tac_tax_free" }, "cofins_amount": 0.0, "csll_amount": 0.0, "description": null, "net_fee_amount": 0.0, "rebate_account": null, "billing_type": { "enumerator": "disbursement" }, "created_at": "2025-10-14T22:18:07" } ] } ``` STATUS 400 Response Body ```json { "data": "{\"title\": \"Bad Request\", \"description\": \"Invalid request body.\", \"translation\": \"Corpo da requisição inválido.\", \"extra_fields\": {}, \"code\": \"LEG000069\"}" } ``` --- # Desembolso da operação URL: /documentation/emissao_de_divida/desembolso_da_operacao O desembolso de uma operação é a liberação dos recursos provenientes do contrato de crédito, na QI Tech, a forma de desembolso obedece as configurações do produto de crédito conforme explicitado nas configurações de desembolso. :::info Informação Por padrão as operações são desembolsadas via PIX na conta enviada para a operação, porém existem cinco opções que podem ser selecionadas: **1- Pix com informações de conta**; **2- Pix com chave**; **3- TED**; **4- QR code Pix**; **5- Boleto**; Elas possuem campos específicos e estão detalhados na chave "disbursement_bank_accounts" da emissão de contrato. ::: A rotina de desembolso da QI Tech roda a cada minuto observando se todos os requisitos configurados para o produto foram atendidos para aquele contrato específico e alterando seu status. ## Requisitos para Desembolso - **Data de desembolso** O Contrato de crédito da operação só é desembolsado na data definida como "disbursement_date". - **Contrato de crédito emitido e assinado** O Contrato de crédito da operação deve estar emitido e assinado. - **Colateral constituído** No caso de operações que exijam garantias, o colateral deve estar constituído para que o desembolso prossiga. - **Aprovação de desembolso** Caso a configuração de "aprovação para desembolso" esteja ativa, o contrato só será desembolsado após a chamada de API de aprovação. - **Operações com entrada precisam estar pagas** Caso a operação criada possua um parâmetro de entrada, o desembolso só ocorre após o pagamento e a liquidação financeira no sistema QI Tech. - **Alinhamento de limites** É necessário que exista limite de crédito disponível para que a operação seja desembolsada. --- # Emissão de dívida PF URL: /documentation/emissao_de_divida/emissao/emissao_de_divida_pf Com a API de emissão de dívida é possível solicitar a emissão de uma dívida para uma pessoa física. Não é necessário realizar o cadastro prévio do tomador, basta informar os dados cadastrais no momento da solicitação da dívida. :::danger Atenção! A QI Tech oferece uma solução de Onboarding de novos clientes e Anti-fraude. Para receber uma cotação, entre em contato com nosso time comercial: comercial@qitech.com.br ou (11) 3522-1301 ::: A API de dívida foi desenhada para ser executada em apenas uma requisição, após um prévio envio dos arquivos ([upload de documentos](../../upload_de_documentos)). O formato de assinatura do header e do body desta requisição é descrito em detalhes [aqui](../../primeiros_passos/teste_de_autenticacao). ## Request ENDPOINT /debt MÉTODO POST Request Body ```json { "borrower": { "name": "Alan Mathison Turing", "email": "alan.turing@email.com", "phone": { "number": "912345678", "area_code": "11", "country_code": "055" }, "is_pep": false, "address": { "city": "São Paulo", "state": "SP", "number": "1000", "street": "Avenida Feliz", "complement": "AP 801", "postal_code": "49026100", "neighborhood": "Centro" }, "role_type": "issuer", "birth_date": "1990-11-20", "mother_name": "Nome da Mãe do Alan", "nationality": "brasileiro", "person_type": "natural", "individual_document_number": "96969879003", "document_identification": "494598fd-c226-4332-a500-591ae3884673" }, "financial": { "disbursed_amount": 123456, "interest_type": "pre_price_days", "credit_operation_type": "ccb", "monthly_interest_rate": 0.018, "disbursement_date": "2026-03-01", "rebates": [ { "amount": 10, "fee_type": "tac", "amount_type": "absolute", "rebate_bank_account": { "name": "CONTA BANCARIA", "bank_code": "329", "account_digit": "1", "branch_number": "0001", "account_number": "00003", "document_number": "32402502000135" } } ], "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 } }, "disbursement_bank_account": { "name": "Alan Mathison Turing", "document_number": "96969879003", "bank_code": "341", "branch_number": "8615", "account_number": "22110", "account_digit": "2", "account_type": "checking_account" }, "purchaser_document_number": "32402502000135", "credit_agent": { "document_number": "87237271016", "name": "Agente de credito" } } ``` :::warning Atenção O objeto `credit_agent` representa o agente de crédito, por vezes conhecido como pastinha, responsável pela originação desta dívida. Este campo é obrigatório para a emissão de dívidas de consignados. ::: ## Response A resposta desse pedido de dívida retornará o plano de pagamento assim como uma **DEBT-KEY**, que é o identificador da dívida na QI SCD. STATUS 200 Response Body ```json { "webhook_type": "debt", "key": "1baea8a0-0fca-4f7c-8857-a227d4da72f8", "status": "waiting_signature", "event_datetime": "2025-03-27 22:46:10", "data": { "requester_identifier_key": "1baea8a0-0fca-4f7c-8857-a227d4da72f8", "iof_charge_method": "financed", "prefixed_interest_rate": { "annual_rate": 0.2387205316, "created_at": "2025-03-27T22:46:04", "daily_rate": 0.0005866899, "interest_base": "calendar_days_365", "monthly_rate": 0.018 }, "borrower": { "name": "Alan Mathison Turing", "document_number": "96969879003", "related_party_key": "d5cbcada-42e7-4d5b-84fc-3c2dc8038411" }, "contract": { "number": "0000192840/AMT", "urls": [ "https://storage.googleapis.com/sandbox-doc-api/documents/b2d974f9-c710-42e3-8ea4-69cc31561c38/GENERICTEST-ALAN_MATHISON_TURING-CCB-0000192840-20250327224604.pdf" ], "signers": [ { "signer_name": "Alan Mathison Turing", "signer_document_number": "96969879003", "signer_role": "issuer", "signer_email": "alan.turing@email.com", "signer_external_key": null, "signature_url": null } ] }, "installments": [ { "accrual_reference_date": null, "additional_costs": [], "advanced_paid_amount": 0.0, "bank_slip_key": null, "business_due_date": "2026-04-01", "calendar_days": 31, "digitable_line": null, "due_date": "2026-04-01", "due_interest": 0.0, "due_principal": 124424.89, "fine_amount": null, "has_interest": true, "installment_history": [], "installment_key": "b4c722a1-c977-415d-891a-342308edd52f", "installment_number": 1, "installment_payment": [], "installment_status": "created", "installment_type": "principal", "original_due_principal": 124424.89, "original_pre_fixed_amount": 2282.99189209, "original_principal_amortization_amount": 61684.03810791, "original_total_amount": 63967.03, "paid_amount": 0.0, "paid_at": null, "post_fixed_amount": 0, "pre_fixed_amount": 2282.99189209, "principal_amortization_amount": 61684.03810791, "qr_code_key": null, "qr_code_url": null, "renegotiation_proposal_key": null, "tax_amount": 156.80082487, "total_accrual_amount": null, "total_amount": 63967.03, "total_paid_amount": 0.0, "workdays": 23 }, { "accrual_reference_date": null, "additional_costs": [], "advanced_paid_amount": 0.0, "bank_slip_key": null, "business_due_date": "2026-05-04", "calendar_days": 33, "digitable_line": null, "due_date": "2026-05-04", "due_interest": 0.0, "due_principal": 62740.85189209, "fine_amount": null, "has_interest": true, "installment_history": [], "installment_key": "0d042ffc-1629-4ed4-8ec9-0972b2f715ba", "installment_number": 2, "installment_payment": [], "installment_status": "created", "installment_type": "principal", "original_due_principal": 62740.85189209, "original_pre_fixed_amount": 1226.17810791, "original_principal_amortization_amount": 62740.85189209, "original_total_amount": 63967.03, "paid_amount": 0.0, "paid_at": null, "post_fixed_amount": 0, "pre_fixed_amount": 1226.17810791, "principal_amortization_amount": 62740.85189209, "qr_code_key": null, "qr_code_url": null, "renegotiation_proposal_key": null, "tax_amount": 329.26399073, "total_accrual_amount": null, "total_amount": 63967.03, "total_paid_amount": 0.0, "workdays": 20 } ], "total_pre_fixed_amount": 3509.17, "contract_fees": [ { "fee_type": "spread", "fee_amount": 497.7 }, { "fee_type": "spread_ted_fee", "fee_amount": 1.0 } ], "contract_fee_amount": 498.7, "external_contract_fees": [ { "fee_type": "tac", "fee_amount": 10.0, "tax_amount": 1.42, "description": null, "net_fee_amount": 8.58, "rebate_bank_account": { "account_branch": "0001", "account_digit": "1", "account_number": "00003", "created_at": "2025-03-27T22:46:04", "document_number": "32402502000135", "financial_institutions": { "code_number": 329, "is_active": true, "is_pix_participant": true, "ispb": 32402502, "name": "QI SOCIEDADE DE CRÉDITO DIRETO S.A." }, "financial_institutions_code_number": "329", "name": "CONTA BANCARIA" } }, { "fee_type": "spread", "fee_amount": 0.0, "tax_amount": 0.0, "description": null, "net_fee_amount": 0.0, "rebate_bank_account": null }, { "fee_type": "insurance_premium", "fee_amount": 0.0, "tax_amount": 0.0, "description": null, "net_fee_amount": 0.0, "rebate_bank_account": null } ], "external_contract_fee_amount": 10.0, "net_external_contract_fee_amount": 8.58, "assignment_amount": 124923.59, "issue_amount": 124424.89, "disbursed_issue_amount": 123456.0, "cet": "2,3100%", "annual_cet": "31,5716%", "number_of_installments": 2, "base_iof": 486.06, "additional_iof": 472.83, "total_iof": 958.89, "collaterals": [], "entry": null } } ``` ## Definições ### Objeto Request Body | Campo | Tipo | Descrição | Máx. Caract. | |---------------------------------|--------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------| | **borrower** * | object | **[Objeto Borrower](#objeto-borrower)** - Devedor da operação de crédito | - | | **disbursement_bank_account** * | object | **[Objeto Disbursement Bank Account](#objeto-disbursement_bank_accounts)** - Dados da conta bancária para desembolso da operação | - | | **financial** * | object | **[Objeto Financial](#objeto-financial)** - Dados da conta bancária para desembolso da operaçãoIdentificador de que o objeto enviado é uma pessoa física. Deve conter SEMPRE o valor "natural" para borrower PF | - | | **purchaser_document_number** * | string | CNPJ do cessionário (comprador) da operação de crédito | - | ### Objeto Borrower | Campo | Tipo | Descrição | Máx. Caract. | |----------------------------------|---------|---------------------------------------------------------------------------------------|--------------| | **name** * | string | Nome do devedor | 100 | | **email** | string | Email do devedor | 254 | | **phone** | object | **[Objeto Phone](#objeto-phone)** - Telefone de contato do devedor | - | | **is_pep** * | boolean | Indicador de PEP (http://www.portaldatransparencia.gov.br/download-de-dados/pep) | - | | **address** * | object | **[Objeto Address](#objeto-address)** - Endereço do devedor | - | | **role_type** * | enum | default: _issuer_ | - | | **birth_date** * | date | Data de nascimento do devedor (formato "AAAA-MM-DD") | - | | **mother_name** * | string | Nome da mãe do devedor | 100 | | **nationality** | string | Nacionalidade do devedor | 50 | | **person_type** * | string | Indicador de pessoa física - default: _natural_ | - | | **individual_document_number** * | string | CPF do devedor (apenas números) | 11 | | **document_identification** * | string | **DOCUMENT_KEY** do PDF do documento de identificação do devedor com foto (RG, CNH ou CIN) | - | | **document_identification_back** |string | DOCUMENT_KEY do PDF da parte de trás do documento de identificação da pessoa com foto (RG, CNH ou CIN) (enviado previamente). | 11 | | **document_identification_type** | enum | **[Enumerador Document Identification Type](#enumerador-document-identification-type)** — Tipo do documento de identificação enviado. | - | | **document_identification_number** | string | Número do documento de identificação. Quando `document_identification_type` for `cin`, este campo deve ser igual ao CPF (`individual_document_number`). | 16 | | **wedding_certificate** | string | DOCUMENT_KEY do PDF do certificado de casamento da pessoa (enviado previamente). No caso de marital_status ser "single", o valor deste campo deve ser NULL. | 11 | | **proof_of_residence** * |string | DOCUMENT_KEY do PDF do comprovante de endereço do endereço enviado (enviado previamente). | 11 | ### Enumerador Document Identification Type | Valor | Descrição | |---|---| | `rg` | RG — Registro Geral | | `rne` | RNE — Registro Nacional de Estrangeiros | | `cnh` | CNH — Carteira Nacional de Habilitação | | `ctps` | CTPS — Carteira de Trabalho e Previdência Social | | `class_document` | Documento de classe profissional (CRM, OAB, CRC, etc.) | | `passport` | Passaporte | | `other` | Outro | | `cin` | CIN — Carteira de Identidade Nacional. O campo `document_identification_number` deve ser igual ao CPF do portador. | ### Objeto Address | Campo | Tipo | Descrição | Máx. Caract. | |--------------------|--------|--------------------------------------------------------------------------|--------------| | **city** * | string | Cidade do endereço | 100 | | **state** * | string | Estado do endereço (com dois caracteres maiúsculos) | 2 | | **number** * | string | Número do endereço | 10 | | **street** * | string | Rua do endereço | 100 | | **complement** * | string | Complemento do endereço (texto livre) | 100 | | **postal_code** * | string | CEP do endereço (http://www.buscacep.correios.com.br/sistemas/buscacep/) | 8 | | **neighborhood** * | string | Bairro do endereço | 100 | ### Objeto Phone | Campo | Descrição | Exemplo | Máx. Caract. | |--------------------|-----------|-------------------------------------------------------|--------------| | **number** * | string | Número de telefone | 10 | | **area_code** * | string | Código DDD do telefone (https://ddd.guiamais.com.br/) | 2 | | **country_code** * | string | Código DDI do telefone (https://ddi.guiamais.com.br/) | 3 | ### Objeto Disbursement Bank Account Uma emissão de dívida deve conter as informações bancárias para desembolso, por padrão, uma conta de titularidade do devedor. | Campo | Tipo | Descrição | Máx. Caract. | |-----------------------|--------|----------------------------------------------------------------------------------------------------|--------------| | name | string | Nome do titular da conta | 50 | | document_number | string | CPF do titular da conta | 11 | | bank_code * | string | Código COMPE da instituição financeira (https://www.bcb.gov.br/pom/spb/estatistica/port/ASTR003.pdf) | 3 | | branch_number * | string | Número da agência (não informar o dígito verificador da agência!) | 4 | | account_number * | string | Número da conta (sem o dígito verificador da conta!) | 10 | | account_digit * | string | Dígito verificador da conta (informar zero no lugar de letras) | 1 | | account_type | enum | [Enumerador Account Type](#enumerador-account-type) Tipo da conta | 1 | ### Objeto Financial O objeto financial descreve as informações financeiras da operação de crédito. | Campo | Tipo | Descrição | Máx. Caract. | |----------------------------|--------|---------------------------------------------------------------------------------------------------------------|--------------| | **amout** | float | Valor de emissão/nominal da operação de crédito | - | | **interest_type** | object | **[Enumerador Interest Type](#enumerador-interest-type)** - Método de amortização e forma de cálculo de juros | - | | **credit_operation_type** | object | **[Enumerador Credit Operation Type](#enumerador-credit-operation-type)** - Tipo do contrato de crédito | - | | **annual_interest_rate** | float | Taxa de juros pré-fixada expressa em decimal ao ano | - | | **disbursement_date** | date | Data do desembolso da operação | - | | **interest_grace_period** | int | Carência de juros (em meses) | - | | **principal_grace_period** | int | Período carência de principal | - | | **number_of_installments** | int | Número de parcelas da operação de crédito | - | | **fine_configuration** | object | **[Objeto Fine Configuration](#objeto-fine-configuration)** - Configuração de juros e multa por atraso | - | ### Objeto Fine Configuration No Objeto Fine Configuration são informados os valor de multa e juros por atraso da operação de crédito. | Campo | Tipo | Descrição | Máx. Caract. | |------------------------|-------|--------------------------------------------------------------------------------------|--------------| | **contract_fine_rate** | float | Percentual de multa por atraso | - | | **interest_base** | enum | **[Enumerador Interest Base](#enumerador-interest-base)** - Base de cálculo de juros | - | | **monthly_rate** | float | Percentual de juros de atraso ao mês | - | ### Objeto Rebates | Campo | Tipo | Descrição | Máx. Caract. | |---------------------------------|--------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------| | **fee_type** * | enum | Tipo da tarifa. | - | | **amount_type** * | object | Tipo do valor a ser cobrado. | - | | **amount** * | object | Valor da tarifa. Se o tipo da tarifa for percentual, o valor deverá ser entre 0 e 100. | - | ### Response Body | Campo | Tipo | Descrição | Máx. Caract. | |----------------------------|--------|----------------------------------------------------------------|--------------| | **data[n].data** | object | **[Objeto Data](#objeto-data)** | - | | **data[n].event_datetime** | date | Momento da geração da operação de crédito | - | | **data[n].key** | string | **DEBT-KEY** - Chave única da operação de crédito dentro da QI | - | | **data[n].status** | string | **[Possívies Status de uma dívida](../status_de_uma_divida)** | - | | **data[n].type** | string | _debt_ | - | # Enumeradores ### Enumerador _Person Type_ | Enumerador | Descrição | |------------------------|-----------------------| | **legal** | Pessoa juridica | | **natural** | Pesso física | ### Enumerador _Amount Type_ | Enumerador | Descrição | |------------------------|-----------------------| | **tac** | Tarifa cobrada do tomador. | | **spread** | Tarifa cobrada do fundo adicionada ao preço de cessão da operação. | ### Enumerador _Account Type_ | Enumerador | Descrição | |------------------------|-----------------------| | **checking_account** | Conta corrente | | **deposit_account** | Conta de depósito | | **guaranteed_account** | Conta de garantia | | **investment_account** | Conta de investimento | | **payment_account** | Conta de pagamento | | **saving_account** | Conta poupança | | **salary_account** | Conta salário | ### Enumerador _Interest Type_ | Enumerador | Descrição | |----------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | **pre_price_days** | Método de amortização Price (parcelas iguais) com cálculo do juros pré-fixado ao dia | | **pre_price** | Método de amortização Price (parcelas iguais) com cálculo do juros pré-fixado em períodos fixos (30 dias) | | **pre_sac** | Método de amortização SAC (amortização constante) com cálculo do juros pré-fixado ao dia | | **post_sac** | Método de amortização SAC (amortização constante) com cálculo do juros baseado em uma taxa pré-fixada + indexador pós-fixado (cdi, ipca ou igpm) ao dia | | **post_price** | Método de amortização Price (parcelas iguais) com cálculo do juros baseado em uma taxa pré-fixada + indexador pós-fixado (cdi, ipca ou igpm) em períodos fixos (30 dias) | | **post_price_days** | Método de amortização Price (parcelas iguais) com cálculo do juros baseado em uma taxa pré-fixada + indexador pós-fixado (cdi, ipca ou igpm) ao dia | ### Enumerador _Credit Operation Type_ | Enumerador | Descrição | |---------------|--------------------------------| | **ccb** | Cédula de Crédito Bancário | | **cce** | Cédula de Crédito à Exportação | | **cci** | Cédula de Crédito Imobiliário | | **nce** | Nota de Crédito à Exportação | ### Enumerador _Interest Base_ | Enumerador | Descrição | |-----------------------|---------------------------------------------------------------------------| | **workdays** | Base de cálculo de juros em dias úteis considerando um ano de 252 dias | | **calendar_days** | Base de cálculo de juros em dias corridos considerando um ano de 360 dias | | **calendar_days_365** | Base de cálculo de juros em dias corridos considerando um ano de 365 dias | ### Enumerador _Fee Type_ Cada tipo de fee deve ser previamente habilitado e configurado pela QI Tech | Enumerador | Descrição | |-----------------------|----------------------------------------------------------------------------| | **tac** | Tarifa de abertura de cadastro | | **spread** | Ágio cobrado no valor de aquisição da operação de crédito | | **warranty_analysis** | Tarifa de análise de garantias | | **ted_fee** | Tarifa de TED | | **spread_ted_fee** | Ágio da tarifa de TED cobrado no valor de aquisição da operação de crédito | --- # Emissão de dívida PJ URL: /documentation/emissao_de_divida/emissao/emissao_de_divida_pj Com a API de emissão de dívida é possível solicitar a emissão de uma dívida para uma pessoa jurídica. Não é necessário realizar o cadastro prévio do tomador, basta informar os dados cadastrais no momento da solicitação da dívida. :::danger Atenção! A QI Tech oferece uma solução de Onboarding de novos clientes e Anti-fraude. [Confira aqui a documentação das APIs deste serviço.](https://www.zaig.com.br/en/devcenter.html) Para receber uma cotação, entre em contato com nosso time comercial: comercial@qitech.com.br ou (11) 3522-1301 ::: A API de dívida foi desenhada para ser executada em apenas uma requisição, após um prévio envio dos arquivos ([upload de documentos](../../upload_de_documentos)). O formato de assinatura do header e do body desta requisição é descrito em detalhes [aqui](../../primeiros_passos/teste_de_autenticacao). ## Request ENDPOINT /debt MÉTODO POST Request Body ```json { "borrower": { "name": "RAZAO SOCIAL EMPRESA", "email": "emailempresa@email.com", "phone": { "number": "991112222", "area_code": "11", "country_code": "055" }, "address": { "city": "São Paulo", "state": "SP", "number": "215", "street": "Rua Gilberto Sabino", "complement": "3 andar", "postal_code": "05425020", "neighborhood": "Pinheiros" }, "cnae_code": "6822-6/00", "role_type": "issuer", "person_type": "legal", "company_type": "ltda", "trading_name": "NOME FANTASIA DA EMPRESA", "foundation_date": "2019-07-05", "attached_documents_list": [], "company_document_number": "80282008000127", "company_statute": "aa28e598-55e2-40f1-8884-671772c541a1", "company_representatives": [ { "name": "NOME DO REPRESENTANTE", "email": "nomedorepresentante@email.com", "phone": { "number": "990121234", "area_code": "11", "country_code": "055" }, "is_pep": false, "final_beneficiary": true, "spouse": { "name": "NOME CONJUGE REPRESENTANTE", "email": "conjugerepresentante@email.com", "phone": { "number": "988881234", "area_code": "11", "country_code": "055" }, "birth_date": "1994-12-04", "person_type": "natural", "is_pep": false, "mother_name": "NOME DA MAE DO CONJUGE DO REPRESENTANTE", "individual_document_number": "26571990032", "document_identification_number": "10101010100", "address": { "city": "São Paulo", "state": "SP", "number": "215", "street": "Rua Gilberto Sabino", "complement": "3 andar", "postal_code": "05425020", "neighborhood": "Pinheiros" } }, "address": { "city": "São Paulo", "state": "SP", "number": "215", "street": "Rua Gilberto Sabino", "complement": "3 andar", "postal_code": "05425020", "neighborhood": "Pinheiros" }, "role_type": "company_representative", "birth_date": "1993-09-10", "profession": "DIRETOR", "mother_name": "NOME DA MAE DO REPRESENTANTE", "nationality": "BRASILEIRO", "person_type": "natural", "marital_status": "married", "property_system": "partial_communion_of_goods", "attached_documents_list": [], "individual_document_number": "31057466093", "document_identification_number": "20202020200" } ] }, "financial": { "disbursed_amount": 10000, "interest_type": "pre_price_days", "credit_operation_type": "ccb", "monthly_interest_rate": 0.03, "disbursement_date": "2023-05-04", "first_due_date": "2023-06-03", "interest_grace_period": 0, "principal_grace_period": 0, "number_of_installments": 1, "fine_configuration": { "contract_fine_rate": 0.02, "interest_base": "calendar_days", "monthly_rate": 0.01 } }, "disbursement_bank_account": { "name": "RAZAO SOCIAL EMPRESA", "document_number": "80282008000127", "bank_code": "341", "branch_number": "8615", "account_number": "22110", "account_digit": "2", "account_type": "checking_account" }, "purchaser_document_number": "32402502000135" } ``` ## Response A resposta desse pedido de dívida retornará o plano de pagamento assim como uma **DEBT-KEY**, que é o identificador da dívida na QI SCD. STATUS 200 Response Body ```json { "data": { "additional_iof": 38.57988, "annual_cet": "71,3492%", "assignment_amount": 10254.13, "base_iof": 12.487704111671501, "borrower": { "document_number": "80282008000127", "name": "RAZAO SOCIAL EMPRESA", "related_party_key": "7620181e-f46a-45c1-a4ea-60439b9662ad" }, "cet": "4,5900%", "collaterals": [], "contract": { "number": "0000069971/RSE", "signature_information": [ { "signature_url": null, "signer_document_number": "31057466093", "signer_email": "nomedorepresentante@email.com", "signer_external_key": null, "signer_name": "NOME DO REPRESENTANTE", "signer_role": "issuer" } ], "urls": [ "https://storage.googleapis.com/sandbox-doc-api/documents/df3e4530-3deb-4ba8-ad4e-c28ebeffb831/20230504122831.pdf" ] }, "contract_fee_amount": 101.53, "contract_fees": [ { "fee_amount": 101.53, "fee_type": "tac" } ], "external_contract_fee_amount": 101.53, "external_contract_fees": [ { "fee_amount": 101.53, "fee_type": "spread", "net_fee_amount": 92.14, "tax_amount": 9.39 }, { "fee_amount": 0, "fee_type": "tac", "net_fee_amount": 0, "tax_amount": 0 } ], "installments": [ { "accrual_reference_date": null, "additional_costs": [], "advanced_paid_amount": 0, "bank_slip_key": null, "business_due_date": "2023-06-05", "calendar_days": 30, "digitable_line": null, "due_date": "2023-06-03", "due_interest": 0, "due_principal": 10152.6, "fine_amount": null, "has_interest": true, "installment_history": [], "installment_key": "0eb42a83-557a-437a-9819-099b5364cde9", "installment_number": 1, "installment_payment": [], "installment_status": "created", "installment_type": "principal", "original_due_principal": 10152.6, "original_pre_fixed_amount": 300.3450311613816, "original_principal_amortization_amount": 10152.60496883862, "original_total_amount": 10452.95, "paid_amount": 0, "paid_at": null, "post_fixed_amount": 0, "pre_fixed_amount": 300.3450311613816, "principal_amortization_amount": 10152.60496883862, "qr_code_key": null, "qr_code_url": null, "renegotiation_proposal_key": null, "tax_amount": 12.487704111671501, "total_accrual_amount": null, "total_amount": 10452.95, "total_paid_amount": 0, "workdays": 21 } ], "iof_charge_method": "financed", "issue_amount": 10152.6, "net_external_contract_fee_amount": 92.14, "number_of_installments": 1, "prefixed_interest_rate": { "annual_rate": 0.42576089, "created_at": "2023-05-04T12:28:30", "daily_rate": 0.00097227, "interest_base": "calendar_days_365", "monthly_rate": 0.03 }, "requester_identifier_key": "feceb7fe-1305-45eb-899d-c87d36bcc534", "total_iof": 51.07, "total_pre_fixed_amount": 300.3450311613816 }, "event_datetime": "2023-05-04 12:28:35", "key": "feceb7fe-1305-45eb-899d-c87d36bcc534", "status": "waiting_signature", "webhook_type": "debt" } ``` ### Objeto Request Body | Campo | Tipo | Descrição | Máx. Caract. | |---------------------------------|--------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------| | **borrower** * | object | **[Objeto Borrower](#objeto-borrower)** - Devedor da operação de crédito | - | | **guarantor** | object | **[Objeto Guarantor](#objeto-borrower)** - Garantidores da operação da operação de crédito | - | | **disbursement_bank_account** * | object | **[Objeto Disbursement Bank Account](#objeto-disbursement_bank_accounts)** - Dados da conta bancária para desembolso da operação | - | | **financial** * | object | **[Objeto Financial](#objeto-financial)** - Dados da conta bancária para desembolso da operaçãoIdentificador de que o objeto enviado é uma pessoa física. Deve conter SEMPRE o valor "natural" para borrower PF | - | | **purchaser_document_number** * | string | CNPJ do cessionário (comprador) da operação de crédito | - | ### Objeto Borrower | Campo | Tipo | Descrição | Máx. Caract. | |----------------------------------|---------|---------------------------------------------------------------------------------------|--------------| | **name** * | string | Razão social da empresa | 100 | | **trading_name** * | string | Nome fantasia | | | **email** * | string | Email institucional da empresa | 254 | | **phone** * | object | **[Objeto Phone](#objeto-phone)** - Telefone da empresa | - | | **is_pep** * | boolean | Indicador de PEP (http://www.portaldatransparencia.gov.br/download-de-dados/pep) | - | | **address** * | object | **[Objeto Address](#objeto-address)** - Endereço do devedor | - | | **role_type** * | enum | default: _issuer_ | - | | **person_type** * | string | Indicador de pessoa jurídica - default: _legal_ | - | | **company_document_number** * | string | CNPJ (apenas números) | - | | **cnae_code** * | string | Classificação Nacional de Atividades Econômicas | | | **company_representatives** * | array of objects | Lista de representante legais da empresa | **[Objeto Company Representatives](#objeto-company_representatives)** | | **company_type** * | enum | Tipo da empresa: "ltda", "sa", "micro_enterprise" ou "freelancer"| - | | **company_statute** * | string | `document_key` do PDF do estatuto da empresa | | | **directors_election_minute** | string | `document_key` do PDF da Ata de eleição da empresa (obrigatório apenas para emrpresas com company_type "sa") | | | **foundation_date** * | date | Data de abertura da empresa (formato "AAAA-MM-DD") | | Como mostrado acima tanto o campo "borrower" quanto os campos "guarantors" podem ser populados por Objeto PF ou Objeto PJ. Objeto PJ é o descritivo de uma pessoa jurídica na QI Tech. ### Objeto Company Representatives | Campo | Descrição | Exemplo | Máx. Caract. | |---|---|---|---| | **person_type** * | string | Identificador de que o objeto enviado é uma pessoa física ou jurídica. | natural | | **name** * | string | Razão social em caso de operações PJ ou Nome da pessoa em caso de operações PF. Limitado a 100 caracteres. | | | **mother_name** * | string | Nome da mãe do cliente em caso de PF. Limitado a 100 caracteres. | | | **birth_date** * | string | Data de nascimento da pessoa (formato "AAAA-MM-DD") | - | | **profession** * |string | Profissão do cliente. Limitado a 64 caracteres. | 64 | | **nationality** * | string | Nacionalidade do cliente. | 50 | | **marital_status** * | string | Estado civil do cliente. | | **property_system** * |string | Regime de separação de bens (obrigatório apenas para pessoas com marital_status "married"). | **[Enumeradores property_system](#enumeradores-property_system)** | | **wedding_certificate** * | string | DOCUMENT_KEY do PDF do certificado de casamento da pessoa (enviado previamente). No caso de marital_status ser "single", o valor deste campo deve ser NULL. | | | **spouse** * |string |**[Objeto Spouse](#objeto-spouse)** (obrigatório apenas quando "compulsory_separation_of_goods" for "total_communion_of_goods", "partial_communion_of_goods", "final_participation_of_acquisitions" ou "compulsory_separation_of_goods"). No caso de marital_status ser "single", o valor deste campo deve ser NULL. | **[Objeto Spouse](#objeto-spouse)** | | **is_pep** * | boolean |Declaração se a pessoa é PEP (http://www.portaldatransparencia.gov.br/download-de-dados/pep). | true/false | | **final_beneficiary** | boolean | Declaração se o representante é beneficiário final da empresa. | true/false | | **individual_document_number** * |string | CPF da pessoa (apenas números). | 10 | | **document_identification** * |string | DOCUMENT_KEY do PDF do documento de identificação da pessoa com foto (RG, CNH ou CIN) (enviado previamente) | | | **document_identification_back** |string | DOCUMENT_KEY do PDF da parte de trás do documento de identificação da pessoa com foto (RG, CNH ou CIN) (enviado previamente). | | | **document_identification_type** * | enum | Tipo do documento de identificação. Valores aceitos: `rg`, `rne`, `cnh`, `ctps`, `class_document`, `passport`, `other`, `cin`. Quando `cin`, o campo `document_identification_number` deve ser igual ao CPF. | | | **document_identification_number** * |string | Número do documento de identificação da pessoa enviado em "document_identification". Quando `document_identification_type` for `cin`, deve ser igual ao CPF (`individual_document_number`). | 16 | | **email** * |string | Email do cliente. | 254 | | **phone** * | object | Telefone do cliente | **[Objeto Phone](#objeto-phone)** | - | | **address** | object | Endereço do cliente. | **[Objeto Address](#objeto-address)** | | **proof_of_residence** |string | DOCUMENT_KEY do PDF do comprovante de endereço do endereço enviado (enviado previamente). | - | ### Objeto Spouse | Campo | Descrição | Exemplo | Máx. Caract. | |---|---|---|---| | **person_type** * | string | Identificador de que o objeto enviado é uma pessoa física ou jurídica. | natural | | **name** * | string | Razão social em caso de operações PJ ou Nome da pessoa em caso de operações PF. Limitado a 100 caracteres. | | | **mother_name** * | string | Nome da mãe do cliente em caso de PF. Limitado a 100 caracteres. | | | **birth_date** * | string | Data de nascimento da pessoa (formato "AAAA-MM-DD") | - | | **profession** * |string | Profissão do cliente. Limitado a 64 caracteres. | 64 | | **is_pep** * | boolean |Declaração se a pessoa é PEP (http://www.portaldatransparencia.gov.br/download-de-dados/pep). | true/false | | **individual_document_number** * |string | CPF da pessoa (apenas números). | 10 | | **document_identification_number** * |string | Número do documento de identificação da pessoa enviado em "document_identification". | 16 | | **email** * |string | Email do cliente. | 254 | | **phone** * | object | Telefone do cliente | **[Objeto phone](#objeto-phone)** | - | | **address** | object | Endereço do cliente. | **[Objeto address](#objeto-address)** | ### Objeto Address | Campo | Tipo | Descrição | Máx. Caract. | |--------------------|--------|--------------------------------------------------------------------------|--------------| | **city** * | string | Cidade do endereço | 100 | | **state** * | string | Estado do endereço (com dois caracteres maiúsculos) | 2 | | **number** * | string | Número do endereço | 10 | | **street** * | string | Rua do endereço | 100 | | **complement** * | string | Complemento do endereço (texto livre) | 100 | | **postal_code** * | string | CEP do endereço (http://www.buscacep.correios.com.br/sistemas/buscacep/) | 8 | | **neighborhood** * | string | Bairro do endereço | 100 | ### Objeto Phone | Campo | Descrição | Exemplo | Máx. Caract. | |--------------------|-----------|-------------------------------------------------------|--------------| | **number** * | string | Número de telefone | 10 | | **area_code** * | string | Código DDD do telefone (https://ddd.guiamais.com.br/) | 2 | | **country_code** * | string | Código DDI do telefone (https://ddi.guiamais.com.br/) | 3 | ### Objeto Disbursement Bank Account Uma emissão de dívida deve conter as informações bancárias para desembolso, por padrão, uma conta de titularidade do devedor. | Campo | Tipo | Descrição | Máx. Caract. | |-----------------------|--------|----------------------------------------------------------------------------------------------------|--------------| | name | string | Nome do titular da conta | 50 | | document_number | string | CPF do titular da conta | 11 | | bank_code * | string | Código COMPE da instituição financeira (https://www.bcb.gov.br/pom/spb/estatistica/port/ASTR003.pdf) | 3 | | branch_number * | string | Número da agência (não informar o dígito verificador da agência!) | 4 | | account_number * | string | Número da conta (sem o dígito verificador da conta!) | 10 | | account_digit * | string | Dígito verificador da conta (informar zero no lugar de letras) | 1 | | account_type | enum | [Enumerador Account Type](#enumerador-account-type) Tipo da conta | 1 | ### Objeto Financial O objeto financial descreve as informações financeiras da emissão. Aqui são definidas a taxa de juros, carência e valor da dívida entre outros. O Objeto Financeiro possui os campos descritos abaixo, porém é importante notar que alguns campos são opicionais e excludentes (caso um esteja disponível o outro não deverá ser enviado). | Campo | Tipo | Descrição | Máx. Caract. | |----------------------------|--------|---------------------------------------------------------------------------------------------------------------|--------------| | **amout** | float | Valor de emissão/nominal da operação de crédito | - | | **interest_type** | object | **[Enumerador Interest Type](#enumerador-interest-type)** - Método de amortização e forma de cálculo de juros | - | | **credit_operation_type** | object | **[Enumerador Credit Operation Type](#enumerador-credit-operation-type)** - Tipo do contrato de crédito | - | | **annual_interest_rate** | float | Taxa de juros pré-fixada expressa em decimal ao ano | - | | **disbursement_date** | date | Data do desembolso da operação | - | | **interest_grace_period** | int | Carência de juros (em meses) | - | | **principal_grace_period** | int | Período carência de principal | - | | **number_of_installments** | int | Número de parcelas da operação de crédito | - | | **fine_configuration** | object | **[Objeto Fine Configuration](#objeto-fine-configuration)** - Configuração de juros e multa por atraso | - | ### Objeto Fine Configuration No Objeto Fine Configuration são informados os valor de multa e juros por atraso da operação de crédito. | Campo | Tipo | Descrição | Máx. Caract. | |------------------------|-------|--------------------------------------------------------------------------------------|--------------| | **contract_fine_rate** | float | Percentual de multa por atraso | - | | **interest_base** | enum | **[Enumerador Interest Base](#enumerador-interest-base)** - Base de cálculo de juros | - | | **monthly_rate** | float | Percentual de juros de atraso ao mês | - | ### Objeto Rebates | Campo | Tipo | Descrição | Máx. Caract. | |---------------------------------|--------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------| | **fee_type** * | enum | Tipo da tarifa. | - | | **amount_type** * | object | Tipo do valor a ser cobrado. | - | | **amount** * | object | Valor da tarifa. Se o tipo da tarifa for percentual, o valor deverá ser entre 0 e 100. | - | ### Response Body | Campo | Tipo | Descrição | Máx. Caract. | |----------------------------|--------|----------------------------------------------------------------|--------------| | **data[n].data** | object | **[Objeto Data](#objeto-data)** | - | | **data[n].event_datetime** | date | Momento da geração da operação de crédito | - | | **data[n].key** | string | **DEBT-KEY** - Chave única da operação de crédito dentro da QI | - | | **data[n].status** | string | **[Possívies Status de uma dívida](../status_de_uma_divida)** | - | | **data[n].type** | string | _debt_ | - | # Enumeradores ### Enumerador _Person Type_ | Enumerador | Descrição | |------------------------|-----------------------| | **legal** | Pessoa juridica | | **natural** | Pesso física | ### Enumerador _Amount Type_ | Enumerador | Descrição | |------------------------|-----------------------| | **tac** | Tarifa cobrada do tomador. | | **spread** | Tarifa cobrada do fundo adicionada ao preço de cessão da operação. | ### Enumerador _Account Type_ | Enumerador | Descrição | |------------------------|-----------------------| | **checking_account** | Conta corrente | | **deposit_account** | Conta de depósito | | **guaranteed_account** | Conta de garantia | | **investment_account** | Conta de investimento | | **payment_account** | Conta de pagamento | | **saving_account** | Conta poupança | | **salary_account** | Conta salário | ### Enumerador _Interest Type_ | Enumerador | Descrição | |----------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | **pre_price_days** | Método de amortização Price (parcelas iguais) com cálculo do juros pré-fixado ao dia | | **pre_price** | Método de amortização Price (parcelas iguais) com cálculo do juros pré-fixado em períodos fixos (30 dias) | | **pre_sac** | Método de amortização SAC (amortização constante) com cálculo do juros pré-fixado ao dia | | **post_sac** | Método de amortização SAC (amortização constante) com cálculo do juros baseado em uma taxa pré-fixada + indexador pós-fixado (cdi, ipca ou igpm) ao dia | | **post_price** | Método de amortização Price (parcelas iguais) com cálculo do juros baseado em uma taxa pré-fixada + indexador pós-fixado (cdi, ipca ou igpm) em períodos fixos (30 dias) | | **post_price_days** | Método de amortização Price (parcelas iguais) com cálculo do juros baseado em uma taxa pré-fixada + indexador pós-fixado (cdi, ipca ou igpm) ao dia | ### Enumerador _Credit Operation Type_ | Enumerador | Descrição | |------------|--------------------------------| | **ccb** | Cédula de Crédito Bancário | | **cce** | Cédula de Crédito à Exportação | | **cci** | Cédula de Crédito Imobiliário | | **nce** | Nota de Crédito à Exportação | | **ncom** | Nota Comercial | ### Enumerador _Interest Base_ | Enumerador | Descrição | |-----------------------|---------------------------------------------------------------------------| | **workdays** | Base de cálculo de juros em dias úteis considerando um ano de 252 dias | | **calendar_days** | Base de cálculo de juros em dias corridos considerando um ano de 360 dias | | **calendar_days_365** | Base de cálculo de juros em dias corridos considerando um ano de 365 dias | ### Enumerador _Fee Type_ Cada tipo de fee deve ser previamente habilitado e configurado pela QI Tech | Enumerador | Descrição | |-----------------------|----------------------------------------------------------------------------| | **tac** | Tarifa de abertura de cadastro | | **spread** | Ágio cobrado no valor de aquisição da operação de crédito | | **warranty_analysis** | Tarifa de análise de garantias | | **ted_fee** | Tarifa de TED | | **spread_ted_fee** | Ágio da tarifa de TED cobrado no valor de aquisição da operação de crédito | --- # Exemplos de payload de desembolso URL: /documentation/emissao_de_divida/emissao/exemplo_payloads_desembolso ### Desembolsar em conta interna QI Tech ENDPOINT /debt MÉTODO POST ```json title='Request Body' { "disbursement_bank_accounts": [{ "bank_code": "329", "branch_number": "001", "account_number": "6947216", "account_digit": "4", "document_number": "94632180173", "name": "Pedro Felipe Henrique Alves", "percentage_receivable": 100 }] ... } ``` --- ### Desembolsar com Pix Manual ENDPOINT /debt MÉTODO POST ```json title='Request Body' { "disbursement_bank_accounts": [{ "document_number": "31233261000185", "name": "Jorge Augusto Salgado Salhani", "pix_transfer_type": "manual", "bank_code": "329", "branch_number": "0001", "account_number": "62400", "account_digit": "6", "percentage_receivable": 100 }] ... } ``` :::info Tipos de Chave Pix A “pix_key” pode ser um CPF, CNPJ, E-mail, Celular ou uma Chave Aleatória (UUID), seguindo as seguintes formatações: CPF: Número inteiro com 11 dígitos. CNPJ: Número inteiro com 14 dígitos. E-mail: Texto contendo ao menos um “@”. Celular: Texto contendo os seguintes valores: “+55” + “DDD do celular“ + “Número Inteiro do Celular com no mínimo 8 e no máximo 9 dígitos”. Ex: “+5511987654321“. Chave Aleatória: UUID. ::: --- ### Desembolsar com chave Pix ENDPOINT /debt MÉTODO POST ```json title='Request Body' { "disbursement_bank_accounts": [{ "document_number": "31233261000185", "name": "Jorge Augusto Salgado Salhani", "pix_key": "2f205c99-3161-4120-badd-854039d12de6", "pix_transfer_type": "key" }] ... } ``` --- ### Desembolsar com QR Code Pix ENDPOINT /debt MÉTODO POST ```json title='Request Body' { "disbursement_bank_accounts": [{ "qr_code_key": "b76e436e-4767-4b16-91e6-9bfc794f2510" }] ... } ``` --- ### Desembolsar com TED ENDPOINT /debt MÉTODO POST ```json title='Request Body' { "disbursement_bank_accounts": [{ "transfer_method": "ted", "bank_code": "329", "branch_number": "0001", "account_number": "62400", "account_digit": "6", "document_number": "31233261000185", "name": "Jorge Conta destino de desembolso", "percentage_receivable": 100 }] ... } ``` --- ### Desembolsar pagando um Boleto ENDPOINT /debt MÉTODO POST ```json title='Request Body' { "disbursement_bank_accounts": [{ "digitable_line": "836400000169072200500006763953020230059001020193", "amount_receivable": 1607.22 }] ... } ``` --- # Assinaturas alternativas URL: /documentation/emissao_de_divida/formalizacao/assinatura_de_contrato Para o uso de formas alternativas de assinatura é necessario que o dossie de arquivos de comprovação sejá compactado em um arquivo .zip e enviado através do endpoint /upload QI TECH, assim o document_key retornado pode ser ultilizado neste endpoint como forma de assinatura de contrato. Exemplos de assinaturas alternativas: - Ligação gravada; - Analise de crédito; ## Request ENDPOINT /debt/ DEBT-KEY /signed MÉTODO POST **Request Body** ```json { "type": "data-signature", "signatures": [ { "signed_object": { "raw_text": "Lorem ipsum dolor sit amet, consectetur a....", "document_key": "79003de0-2590-455d-9b73-426b8ca284eb", "document_md5": "7521bd5621d97af26b2c1721fc4023a8" }, "authenticity": { "timestamp": "1970-01-01 00:00:01", "document_key": "79003de0-2590-455d-9b73-426b8ca284eb", "document_md5": "79003de0-2590-455d-9b73-426b8ca284eb" }, "signer": { "name": "IVANILDO DE SENA LIMA", "email": "ivanlima2604@gmail.com", "phone": { "country_code": "055", "area_code": "11", "number": "999999999" }, "document_number": "61766976204" }, "authentication_type": "zip" } ] } ``` ## Path Params | Campo | Tipo | Descrição | Caracteres | |---|---|---|---| | `debt_key` * | string | Chave da divida devolvida no momento da criação da operação de crédito. | - | ## Body Params | Campo | Tipo | Descrição | Caracteres | |---|---|---|---| | `type` * | string | Tipo de assinatura que será enviada. | - | | `signatures` * | array of objects | Lista contendo objetos de comprovação de assinatura - deve ser enviado no caso de assinatura "type": "data-signature". | **[Objetos signatures](#objeto-signatures )**| | `path-pdf-signed` * | string | URL com o PDF assinado - deve ser enviado no caso de assinatura "type": "pdf-signature". | - | ### Objeto signatures | Campo | Tipo | Descrição | Caracteres | |---|---|---|---| | `signed_object` | object | Objeto contendo o documento que esta sendo assinado. | **[Objetos signed_object](#objeto-signed_object )** | | `authenticity` | object | objeto com dados de autenticação. | **[Objetos authenticity](#objeto-authenticity )** | | `signer` | object | Objeto com os dados do signatário. | **[Objeto signer](#objeto-signer )** | | `authentication_type` *| string | Tipo de assinatura. | - | ### Objeto signed_object | Campo | Tipo | Descrição | Caracteres | |---|---|---|---| | `raw_text` | string | Texto corrido com os dados do contrato que será assinado (Obrigatório para autenticação tipo opt-in). | - | | `document_key` | string | DOCUMENT_KEY do arquivo assinado enviado a partir da API 1.1 (obrigatório apenas caso o campo "raw_text" não seja enviado). | - | | `document_md5` | string | DOCUMENT_MD% do arquivo assinado enviado a partir da API 1.1 (obrigatório apenas caso o campo "raw_text" não seja enviado). | - | ### Objeto authenticity | Campo | Tipo | Descrição | Caracteres | |---|---|---|---| | `timestamp` *| string | Data da assinatura. | - | | `document_key` * | string | DOCUMET_KEY retornado pela API 1.1 após o envio do arquivo com as evidencias de assinatura. | - | | `document_md5` * | string | DOCUMET_MD5 retornado pela API 1.1 após o envio do arquivo com as evidencias de assinatura. | - | ### Objeto signer | Campo | Tipo | Descrição | Caracteres | |---|---|---|---| | `name` *| string | Nome do signatário. | - | | `email` *| string | E-mail do signatário. | - | | `phone` | string | Objeto de telefone do signatário. | **[Objeto phone](#objeto-phone)** | | `document_number` *| string | Numero de documento do signatário. | - | ### Objeto phone | Campo | Tipo | Descrição | Caracteres | |---|---|---|---| |`country_code` *| string | Código DDI do telefone (https://ddi.guiamais.com.br/) | 3 | | `area_code` *| string | Código DDD do telefone (https://ddd.guiamais.com.br/) | 2 | | `number` *| string |Número de telefone (apenas números) | 10 | ## Response STATUS 200 **Response Body** ```json { "data": {}, "event_datetime": "2022-11-07 15:24:47", "key": "\", "status": "signature_received", "webhook_type": "debt" } ``` STATUS 400 **Response Body** ```json { "data": "{\"title\": \"Bad Request\", \"description\": \"Invalid request body.\", \"translation\": \"Corpo da requisição inválido.\", \"extra_fields\": {}, \"code\": \"LEG000069\"}" } ``` --- # Assinatura de contrato com OPT-IN URL: /documentation/emissao_de_divida/formalizacao/assinatura_opt_in ## Request ENDPOINT /debt/ DEBT-KEY /signed MÉTODO POST **Request Body** ```json { "type": "data_signature", "signatures": [ { "signed_object": { "raw_text": "Lorem ipsum dolor sit amet, consectetur a...." }, "authenticity": { "timestamp": "1970-01-01 00:00:01", "ip_address": "179.104.42.245", "session_id": "ddb1d063-4fdf-4330-af9c-3316e9142ff3" }, "signer": { "name": "IVANILDO DE SENA LIMA", "email": "ivanlima2604@gmail.com", "phone": { "country_code": "055", "area_code": "11", "number": "999999999" }, "document_number": "61766976204" }, "authentication_type": "opt-in" } ] } ``` ## Path Params | Campo | Tipo | Descrição | Caracteres | |---|---|---|---| | `debt_key` * | string | Chave da divida devolvida no momento da criação da operação de crédito. | - | ## Body Params | Campo | Tipo | Descrição | Caracteres | |---|---|---|---| | `type` * | string | Tipo de assinatura que será enviada. | - | | `signatures` * | array of objects | Lista contendo objetos de comprovação de assinatura - deve ser enviado no caso de assinatura "type": "data-signature". | **[Objetos signatures](#objeto-signatures )**| ### Objeto signatures | Campo | Tipo | Descrição | Caracteres | |---|---|---|---| | `signed_object` | object | Objeto contendo o documento que esta sendo assinado. | **[Objetos signed_object](#objeto-signed_object )** | | `authenticity` | object | objeto com dados de autenticação. | **[Objetos authenticity](#objeto-authenticity )** | | `signer` | object | Objeto com os dados do signatário. | **[Objeto signer](#objeto-signer )** | | `authentication_type` *| string | Tipo de assinatura. | - | ### Objeto signed_object | Campo | Tipo | Descrição | Caracteres | |---|---|---|---| | `raw_text` * | string | Texto corrido com os dados do contrato que será assinado. | - | ### Objeto authenticity | Campo | Tipo | Descrição | Caracteres | |---|---|---|---| | `timestamp` *| string | Data da assinatura. | - | | `ip_address` | string | Campo obrigatório para o authentication_type “opt-in” indicando o endereço de IP onde o aceite foi coletado. | - | | `session_id` | string | ID de identificação de sessão do cliente no momento da assinatura - deve ser consultável e as evidencias da sessão devem ser armazenadas por um período de no mínimo 5 anos (Obrigatório para o authentication_type "opt-in"). | - | | `geolocation` | object | Campo opcional de geolocalização. | - | ### Objeto signer | Campo | Tipo | Descrição | Caracteres | |---|---|---|---| | `name` *| string | Nome do signatário. | - | | `email` *| string | E-mail do signatário. | - | | `phone` | string | Objeto de telefone do signatário. | **[Objeto phone](#objeto-phone)** | | `document_number` *| string | Numero de documento do signatário. | - | ### Objeto phone | Campo | Tipo | Descrição | Caracteres | |---|---|---|---| |`country_code` *| string | Código DDI do telefone (https://ddi.guiamais.com.br/) | 3 | | `area_code` *| string | Código DDD do telefone (https://ddd.guiamais.com.br/) | 2 | | `number` *| string |Número de telefone (apenas números) | 10 | ## Response STATUS 200 **Response Body** ```json { "data": {}, "event_datetime": "2022-11-07 15:24:47", "key": "\", "status": "signature_received", "webhook_type": "debt" } ``` STATUS 400 **Response Body** ```json { "data": "{\"title\": \"Bad Request\", \"description\": \"Invalid request body.\", \"translation\": \"Corpo da requisição inválido.\", \"extra_fields\": {}, \"code\": \"LEG000069\"}" } ``` --- # Envio do PDF assinado URL: /documentation/emissao_de_divida/formalizacao/assinatura_pdf ## Request ENDPOINT /debt/ DEBT-KEY /signed MÉTODO POST **Request Body** ```json { "type": "pdf-signature", "path-pdf-signed": "https://www.google.com/" } ``` ## Path Params | Campo | Tipo | Descrição | Caracteres | |---|---|---|---| | `debt_key` * | string | Chave da divida devolvida no momento da criação da operação de crédito. | - | ## Body Params | Campo | Tipo | Descrição | Caracteres | |---|---|---|---| | `type` * | string | Tipo de assinatura que será enviada. | - | | `path-pdf-signed` * | string | URL com o PDF assinado - deve ser enviado no caso de assinatura "type": "pdf-signature". | - | ## Response STATUS 200 **Response Body** ```json { "data": {}, "event_datetime": "2022-11-07 15:24:47", "key": "\", "status": "signature_received", "webhook_type": "debt" } ``` STATUS 400 **Response Body** ```json { "data": "{\"title\": \"Bad Request\", \"description\": \"Invalid request body.\", \"translation\": \"Corpo da requisição inválido.\", \"extra_fields\": {}, \"code\": \"LEG000069\"}" } ``` --- # Assinatura de contrato com selfie URL: /documentation/emissao_de_divida/formalizacao/assinatura_selfie A autenticação através de selfie é disponibilizada para os parceiros que utilizam os serviços de nalise de crédito QI Tech, onde a autenticação através de selfie é validada e um ID de comprovação é gerado. Este ID gerado através dos endpoints de anaise de crédito QI Tech podem ultilizados como assinatura do contrato. ## Request ENDPOINT /debt/ DEBT-KEY /signed MÉTODO POST **Request Body** ```json { "type": "data-signature", "signatures": [ { "signed_object": { "raw_text": "Lorem ipsum dolor sit amet, consectetur a....", "document_key": "79003de0-2590-455d-9b73-426b8ca284eb", "document_md5": "7521bd5621d97af26b2c1721fc4023a8" }, "authenticity": { "timestamp": "1970-01-01 00:00:01", "facial_recognition_key": "79003de0-2590-455d-9b73-426b8ca284eb" }, "signer": { "name": "IVANILDO DE SENA LIMA", "email": "ivanlima2604@gmail.com", "phone": { "country_code": "055", "area_code": "11", "number": "999999999" }, "document_number": "61766976204" }, "authentication_type": "opt-in" } ] } ``` ## Path Params | Campo | Tipo | Descrição | Caracteres | |---|---|---|---| | `debt_key` * | string | Chave da divida devolvida no momento da criação da operação de crédito. | - | ## Body Params | Campo | Tipo | Descrição | Caracteres | |---|---|---|---| | `type` * | string | Tipo de assinatura que será enviada. | - | | `signatures` * | array of objects | Lista contendo objetos de comprovação de assinatura - deve ser enviado no caso de assinatura "type": "data-signature". | **[Objetos signatures](#objeto-signatures )**| ### Objeto signatures | Campo | Tipo | Descrição | Caracteres | |---|---|---|---| | `signed_object` | object | Objeto contendo o documento que esta sendo assinado. | **[Objetos signed_object](#objeto-signed_object )** | | `authenticity` | object | objeto com dados de autenticação. | **[Objetos authenticity](#objeto-authenticity )** | | `signer` | object | Objeto com os dados do signatário. | **[Objeto signer](#objeto-signer )** | | `authentication_type` *| string | Tipo de assinatura. | - | ### Objeto signed_object | Campo | Tipo | Descrição | Caracteres | |---|---|---|---| | `raw_text` | string | Texto corrido com os dados do contrato que será assinado (Obrigatório para autenticação tipo opt-in). | - | | `document_key` | string | DOCUMENT_KEY do arquivo assinado enviado a partir da API 1.1 (obrigatório apenas caso o campo "raw_text" não seja enviado). | - | | `document_md5` | string | DOCUMENT_MD5 do arquivo assinado enviado a partir da API 1.1 (obrigatório apenas caso o campo "raw_text" não seja enviado). | - | ### Objeto authenticity | Campo | Tipo | Descrição | Caracteres | |---|---|---|---| | `timestamp` *| string | Data da assinatura. | - | | `facial_recognition_key` * | string | Deve conter o facial_recognition_key devolvido pela API de face recognition QI Tech - Este campo só é disponível para o authentication_type "selfie" e exclui a obrigatoriedade do envio de outras comprovações. | - | ### Objeto signer | Campo | Tipo | Descrição | Caracteres | |---|---|---|---| | `name` *| string | Nome do signatário. | - | | `email` *| string | E-mail do signatário. | - | | `phone` | string | Objeto de telefone do signatário. | **[Objeto phone](#objeto-phone)** | | `document_number` *| string | Numero de documento do signatário. | - | ### Objeto phone | Campo | Tipo | Descrição | Caracteres | |---|---|---|---| |`country_code` *| string | Código DDI do telefone (https://ddi.guiamais.com.br/) | 3 | | `area_code` *| string | Código DDD do telefone (https://ddd.guiamais.com.br/) | 2 | | `number` *| string |Número de telefone (apenas números) | 10 | ## Response STATUS 200 **Response Body** ```json { "data": {}, "event_datetime": "2022-11-07 15:24:47", "key": "\", "status": "signature_received", "webhook_type": "debt" } ``` STATUS 400 **Response Body** ```json { "data": "{\"title\": \"Bad Request\", \"description\": \"Invalid request body.\", \"translation\": \"Corpo da requisição inválido.\", \"extra_fields\": {}, \"code\": \"LEG000069\"}" } ``` --- # Assinatura de contrato URL: /documentation/emissao_de_divida/formalizacao/introducao_formalizacao Por padrão a QI Tech realiza a coleta de assinaturas através da QI Sign e o contrato é enviado para os assinantes no momento da emissão, porém ainda existe a possibilidade de o parceiro realizar a coleta de assinaturas de forma independente e enviar o documento assinado ou as evidencias de assinatura para a QI Tech para seguir com a operação. :::caution **Atenção** Para que essa coleta seja realizada pelo parceiro e depois o documento assinado seja enviado através de API é necessário solicitar a configuração desse fluxo para o time de suporte QI Tech. ::: O processo de assinatura pode ser feito de 2 formas: 1 - A coleta de assinaturas é realizada através da plataforma QI Tech; 2 - O parceiro realiza a coleta de assinaturas de forma independente e depois envia o contrato assinado para a QI Tech - Essa possibilidade contempla tanto o envio do PDF assinado quanto o envio de um hash de assinatura; O fluxo de chamadas muda de acordo com o processo escolhido, podendo seguis as esteiras de chamadas abaixo: ## Fluxo 1 Após solicitar a configuração de fluxo 1 de assinatura para o time de suporte QI Tech, a única chamada necessária para realizar a emissão da divida é a chamada do conjunto 3 de acordo com o tomador de crédito da operação. A QI tech por sua vez fará a emissão do contrato de crédito pré-configurado e o disparo para assinatura - o acompanhamento da operação poderá ser realizado através da API 5.1 ou através dos callbacks enviados. A assinatura do documento é através da plataforma QI Sign e pode ocorrer via email, whatsapp ou sms no período de 7 dias após o momento da emissão do contrato. Por conta da assincronia da assinatura, quando o contrato é assinado pelo tomador, um evento é disparado via webhook ao originador. ## Fluxo 2 Após solicitar a configuração de fluxo 2 de assinatura para o time de suporte QI Tech, existe um fluxo de chamadas que deve ser realizado. A primeira chamada será obrigatoriamente do conjunto de APIs 3 (de acordo com o tomador de crédito da operação) para realizar a emissão do PDF do contrato e a ultima chamada será a API 4.1 para realizar o envio do contrato já assinado; No caso da assinatura do documento ser via certificadora, é necessário realizar o envio da url com o PDF assinado na API 4.1; No caso de assinatura via optin no front, as informações que serão enviadas na API 4.1 serão as evidencias de aceite do cliente. A QI tech por sua vez seguira o fluxo para o desembolso - o acompanhamento da operação poderá ser realizado através da API 5.1 ou através dos webhooks enviados. ## Tipos de assinatura aceitos ### **pdf-signature** Esse tipo indica que o PDF emitido através da "/debt" será assinado e link com o PDF assinado será enviado através da API 4.1 como forma de autenticação. ### **data-signature** Esse tipo indica que o PDF emitido através da "/debt" será assinado através de um hash anexado em sua ultima pagina. A autenticação através de dados pode ter 3 tipos: #### **Opt-in** A assinatura através de opt-in significa que o cliente vai dar o aceite do contrato através do front. Para que essa assinatura seja valida, alguns dados devem ser enviados obrigatoriamente. #### **Zip** A assinatura através de zip contempla o envio de um arquivo de comprovação, como uma ligação gravada. #### **Selfie** A autenticação através de selfie é disponibilizada para os parceiros que utilizam os serviços de CaaS QI Tech, onde a autenticação através de selfie é validada e um id de comprovação é gerado. --- # Gerar Boleto ou PIX para uma Parcela URL: /documentation/emissao_de_divida/gerar_boleto_ou_pix_para_uma_parcela Permite gerar um boleto bancário ou código PIX para o pagamento de uma parcela específica de uma operação de crédito. :::caution Substituição de meio de pagamento Caso a parcela ja possua um boleto/pix ativo para pagamento o mesmo será desativado e substituido pelo novo método de pagamento. ::: ## Endpoint ### Request ENDPOINT /debt/ DEBT-KEY /installment/ INSTALLMENT-KEY / PAYMENT-TYPE MÉTODO POST Parâmetros de Caminho | Parâmetro | Tipo | Descrição | |-----------|------|-----------| | DEBT-KEY | string | Chave identificadora da dívida | | INSTALLMENT-KEY | string | Chave identificadora da parcela | | PAYMENT-TYPE | string | Tipo de pagamento desejado bankslip (boleto) ou pix (qrcode pix) | Request Body ```json {} ``` Response Response Body ```json { "installment_key": "installment_key", "due_date": "2022-09-08", "business_due_date": "2022-09-09", "pre_fixed_amount": 70.0, "principal_amortization_amount": 1000.0, "total_amount": 1070.0, "bank_slip_key": "bank_slip_key", "qr_code_key": "qr_code_key", "qr_code_url": "qr_code_url", "digitable_line": "digitable_line" } ``` Objeto Response Body | Campo | Tipo | Descrição | |-------|------|-----------| | installment_key | string | Identificador único da parcela no formato UUID | | due_date | string | Data de vencimento da parcela no formato YYYY-MM-DD | | business_due_date | string | Data de vencimento da parcela em dia útil no formato YYYY-MM-DD | | pre_fixed_amount | number | Valor dos juros | | principal_amortization_amount | number | Valor do principal a ser amortizado | | total_amount | number | Valor total da parcela (juros + principal) | | bank_slip_key | string | Chave identificadora do boleto bancário | | qr_code_key | string | Chave identificadora do QR code PIX | | qr_code_url | string | URL para pagamento do QR code PIX | | digitable_line | string | Linha digitável do boleto bancário | --- # Introdução URL: /documentation/emissao_de_divida/introducao Nesta seção você aprenderá quais os passos necessários para emissão, formalização, desembolso e cancelamento de um contrato de crédito. ## 1. Envio dos documentos necessários para a emissão da dívida Para realizar a emissão de uma dívida, existem certos critérios regulatórios que devem ser atendidos. Dentre estes critérios, está a identificação do devedor por parte da instituição financeira emissora do crédito. Para cumprimento deste critério, se faz necessário, no mínimo, o envio dos seguintes documentos: - **Devedor Pessoa Física**: Documento oficial com foto (RG ou CNH); - **Devedor Pessoa Jurídica**: Contrato/Estatuto Social, Ata de Eleição (no caso de S.A.'s), Documento oficial com foto dos representantes e Procuração (caso existam procuradores); Para realizar o envio desta documentação vocês devem utilizar nosso [endpoint de upload de documentos](../upload_de_documentos). :::danger Atenção! A QI Tech oferece uma solução de Onboarding, OCR para validação de documentos e Anti-fraude. [Confira aqui a documentação das APIs deste serviço.](/documentation/caas/onboarding/natural_person) Para receber uma cotação consulte nosso time comercial: comercial@qitech.com.br ou (11) 2339-4763 ::: ## 2. Simulação da dívida Na QI Tech disponibilizamos aos nossos clientes a possibilidade de [simular os valores uma operação de crédito](simulacao_de_divida_novo) antes da sua emissão de fato. A simulação segue o mesmo padrão da solicitação de emissão de dívida, porém não é necessário informar os dados cadastrais e de conta de desembolso do devedor. Além disso, oferecemos a possibilidade de efetuar diversas simulações com uma única request. ## 3. Emissão da dívida Com a minuta da operação de crédito definida, o time de suporte QI Tech realizará a parametrização do contrato na plataforma e seu PDF poderá ser emitido através do endpoint de emissão de dívida, conforme os casos abaixo: - [Para emissão de uma dívida para uma pessoa física.](emissao/emissao_de_divida_pf) - [Para emissão de uma dívida para uma pessoa jurídica.](emissao/emissao_de_divida_pj) ## 4. Realização da assinatura do contrato de crédito O Processo de assinatura pode variar de acordo com o produto que será disponibilizado. Para entender as configurações de assinatura [clique aqui](formalizacao/introducao_formalizacao). ## 5. Desembolso do crédito ao devedor O desembolso é automático e pode ser configurado de duas formas. Para entender as configurações de desembolso [clique aqui](emissao/exemplo_payloads_desembolso). --- ## Processo de cessão Após realizados todos estes passos, passamos para o processo de cessão da dívida que é 100% pilotado pela QI Tech. Para mais detalhes sobre o desembolso, [clique aqui](desembolso_da_operacao). --- # Metadata URL: /documentation/emissao_de_divida/metadata Objeto que permite a consulta de operações de crédito através de chaves e valores personalizados. ## 1. Criar Metadata ### Objeto Request Body | Campo | Tipo | Descrição | Máx. Caract. | |---------------------------------|--------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------| | **metadata_key** * | string | Chave metadata | 100 | | **metadata_value** * | string | Valor metadata | 100 | ### Request ENDPOINT /credit_operation/[CREDIT-OPERATION-KEY]/metadata MÉTODO POST Request Body ```json { "metadata_key": "key", "metadata_value": "value" } ``` ## 2. Remover Metadata ### Request ENDPOINT /credit_operation/[CREDIT-OPERATION-KEY]/metadata MÉTODO DELETE Request Body ```json { "metadata_key": "key", "metadata_value": "value" } ``` ## 3. Consulta de operação de crédito utilizando Metadata :::caution Na consulta por metadata, os dois campos 'metadata_key' e 'metadata_value' devem ser informados. ::: ### Request ENDPOINT /credit_operations MÉTODO GET
PARAMETERS page, page_size, metadata_key, metadata_value, credit_operation_status ### Response Response Body ```json { "data": [ { "credit_operation_key": "cc217253-e89f-4d14-bf89-fb29afaa2895", "contract_number": "0000000007/WO", "credit_operation_status": "waiting_signature", "additional_iof": 3.817322, "total_iof": 7.19, "original_total_iof": 7.2, "attached_documents": [ { "document_key": "2f7bfc50-d7c0-4d4e-a5ce-d8bba2aeb348", "document_url": "https://storage.googleapis.com/dev-doc-api/documents/2f7bfc50-d7c0-4d4e-a5ce-d8bba2aeb348/sample.pdf", "signature_url": null, "document_type": "document_identification", "signature_required": false, "signed": false }, { "document_key": "568ca6b7-45a8-42e5-a383-e93641625040", "document_url": "b", "signature_url": null, "document_type": "ccb_pre_price", "signature_required": true, "signed": false } ], "annual_cet": 316.4973, "assigned": false, "assigned_at": null, "assignment_amount": 1007.19, "issue_amount": 1007.19, "disbursed_issue_amount": 1000, "final_disbursement_amount": 1000, "base_iof": 3.37226774, "calculus_correction": null, "central_depository": null, "cet": 12.62, "collateral_constituted": true, "collateral_type": null, "contract_fee_amount": 0, "external_contract_fee_amount": 0, "credit_operation_type": "ccb", "operation_type": "structured_operation", "creditor_bank_account_key": null, "custodian": "qi_scd", "disbursement_date": "2022-08-08", "disbursement_start_date": "2022-08-08", "disbursement_end_date": "2022-08-08", "first_due_date": "2022-08-18", "disbursement_accounts": [ { "account_branch": "0001", "account_digit": "3", "account_number": "94134", "account_type": null, "disbursement_type": "pix", "amount_receivable": null, "digitable_line": null, "financial_institutions_code_number": 329, "ispb": "32402502", "name": "Teste", "percentage_receivable": 100, "pix_key": "qitech@qitech.com.br", "pix_transfer_key": "0956cf37-5ef6-4a63-9c01-f29b259e1993", "pix_type": "key", "qr_code_key": null } ], "document_certifier": "clicksign", "number_of_installments": 3, "installments": [ { "accrual_reference_date": null, "advanced_paid_amount": 0, "bank_slip_key": null, "business_due_date": "2022-08-19", "due_date": "2022-08-18", "calendar_days": 10, "digitable_line": null, "due_interest": 0, "due_principal": 1007.19, "fine_amount": null, "has_interest": true, "installment_key": "5f45b7b4-f7f0-464b-94a7-cdea47f3811b", "installment_status": "created", "installment_type": "principal", "original_due_principal": 1007.19, "original_pre_fixed_amount": 38.24205854, "original_principal_amortization_amount": 351.17794146, "paid_amount": 0, "post_fixed_amount": 0, "original_total_amount": 389.42, "pre_fixed_amount": 38.24205854, "principal_amortization_amount": 351.17794146, "qr_code_key": null, "qr_code_url": null, "renegotiation_proposal_key": null, "tax_amount": 0.28796591, "total_accrual_amount": null, "total_amount": 389.42, "total_paid_amount": 0, "workdays": 8 }, { "accrual_reference_date": null, "advanced_paid_amount": 0, "bank_slip_key": null, "business_due_date": "2022-09-20", "due_date": "2022-09-19", "calendar_days": 32, "digitable_line": null, "due_interest": 0, "due_principal": 656.01205854, "fine_amount": null, "has_interest": true, "installment_key": "f844a3ea-bde3-4f94-ada1-607e799b9095", "installment_status": "created", "installment_type": "principal", "original_due_principal": 656.01205854, "original_pre_fixed_amount": 80.33658151, "original_principal_amortization_amount": 309.08341849, "paid_amount": 0, "post_fixed_amount": 0, "original_total_amount": 389.42, "pre_fixed_amount": 80.33658151, "principal_amortization_amount": 309.08341849, "qr_code_key": null, "qr_code_url": null, "renegotiation_proposal_key": null, "tax_amount": 1.06448329, "total_accrual_amount": null, "total_amount": 389.42, "total_paid_amount": 0, "workdays": 21 }, { "accrual_reference_date": null, "advanced_paid_amount": 0, "bank_slip_key": null, "business_due_date": "2022-10-19", "due_date": "2022-10-18", "calendar_days": 29, "digitable_line": null, "due_interest": 0, "due_principal": 346.92864005, "fine_amount": null, "has_interest": true, "installment_key": "e6d67f54-8827-40c4-ade0-1b9b8fd03689", "installment_status": "created", "installment_type": "principal", "original_due_principal": 346.92864005, "original_pre_fixed_amount": 42.49135995, "original_principal_amortization_amount": 346.92864005, "paid_amount": 0, "post_fixed_amount": 0, "original_total_amount": 389.42, "pre_fixed_amount": 42.49135995, "principal_amortization_amount": 346.92864005, "qr_code_key": null, "qr_code_url": null, "renegotiation_proposal_key": null, "tax_amount": 2.01981854, "total_accrual_amount": null, "total_amount": 389.42, "total_paid_amount": 0, "workdays": 20 } ], "interest_grace_period": 0, "interest_payment_month_period": 1, "interest_subsidy_amount": 0, "interest_subsidy_percentage": 0, "interest_type": "pre_price", "iof_charge_method": "financed", "ipoc_code": "3240250202021371976458320000000007/WO", "issue_date": "2022-08-08", "issuer_document_number": "37197645832", "issuer_name": "Wilker Oliveira\u00e7o", "modality": "0202", "origin_key": "52539e23-5c01-4b9c-8a68-6ed750ec7bc5", "payment_and_settlement_agent": "qi_scd", "post_fixed_interest_rate": null, "prefixed_interest_rate": { "annual_rate": 3, "daily_rate": 0.00385824, "monthly_rate": 0.12246205, "interest_base": "calendar_days" }, "fine_configuration": { "contract_fine_rate": 0.02, "fine_delay_rate": { "annual_rate": 0.12682503, "daily_rate": 0.00033173, "interest_base": "calendar_days", "monthly_rate": 0.01 } }, "principal_amortization_month_period": 1, "principal_grace_period": 0, "purchaser_document_number": "04113929151550", "requester_key": "52f36417-368e-4f5b-8841-71e3b9caa72f", "requester_identifier_key": null, "settlement_bank_account_key": "e7e60779-6605-4af5-bd00-1f465f2c5da5", "share_quantity": 2, "tax_configuration": { "iof_additional_rate": 0.000082, "iof_rate": 0.0038 }, "third_party_account_key": "96015228-4905-42fc-bda6-e70e0e552b6b", "disbursement_options": [ { "additional_iof": 3.817322, "annual_cet": 316.4973, "assignment_amount": 1007.19, "base_iof": 3.37226774, "calculus_correction": null, "cet": 12.62, "contract_fee_amount": 0, "disbursed_issue_amount": 1000, "disbursement_date": "2022-08-08", "external_contract_fee_amount": 0, "first_due_date": "2022-08-18", "installments": [ { "business_due_date": "2022-08-19", "due_date": "2022-08-18", "calendar_days": 10, "due_interest": 0, "due_principal": 1007.19, "fine_amount": null, "has_interest": true, "post_fixed_amount": 0, "pre_fixed_amount": 38.24205854, "principal_amortization_amount": 351.17794146, "tax_amount": 0.28796591, "total_amount": 389.42, "workdays": 8 }, { "business_due_date": "2022-09-20", "due_date": "2022-09-19", "calendar_days": 32, "due_interest": 0, "due_principal": 656.01205854, "fine_amount": null, "has_interest": true, "post_fixed_amount": 0, "pre_fixed_amount": 80.33658151, "principal_amortization_amount": 309.08341849, "tax_amount": 1.06448329, "total_amount": 389.42, "workdays": 21 }, { "business_due_date": "2022-10-19", "due_date": "2022-10-18", "calendar_days": 29, "due_interest": 0, "due_principal": 346.92864005, "fine_amount": null, "has_interest": true, "post_fixed_amount": 0, "pre_fixed_amount": 42.49135995, "principal_amortization_amount": 346.92864005, "tax_amount": 2.01981854, "total_amount": 389.42, "workdays": 20 } ], "interest_subsidy_amount": 0, "issue_amount": 1007.19, "net_external_contract_fee_amount": 0, "share_quantity": 2, "total_iof": 2, "prefixed_interest_rate": { "annual_rate": 3, "daily_rate": 0.00385824, "monthly_rate": 0.12246205, "interest_base": "calendar_days" } } ], "related_parties": [ { "company_document_number": null, "email": "teste.teste@yopmail.com", "foundation_date": null, "gender": "male", "individual_document_number": "61592798071", "is_pep": null, "marital_status": null, "mother_name": null, "nationality": null, "person_type": "natural", "related_party_key": "16e3b6a8-bec0-4bd2-8b23-caaad54afd8c", "role_type": "issuer", "trading_name": null, "simples_nacional_participant": null, "spouse_document_number": null, "profession": null, "address": { "city": "Bauru", "complement": null, "neighborhood": "Centro", "number": "343", "postal_code": "17057770", "state": "SP", "street": "Av Um" }, "phone": { "area_code": "14", "country_code": "055", "number": "936180266" }, "attached_documents": [ { "document_key": "2f7bfc50-d7c0-4d4e-a5ce-d8bba2aeb348", "document_url": "https://storage.googleapis.com/dev-doc-api/documents/2f7bfc50-d7c0-4d4e-a5ce-d8bba2aeb348/sample.pdf", "signature_url": null, "document_type": "document_identification", "signature_required": false, "signed": false } ] } ] } ], "pagination": { "current_page": 1, "next_page": 2, "rows_per_page": 10, "total_pages": 1, "total_rows": 1, "contain_last_page": true } } ``` --- # Introdução URL: /documentation/emissao_de_divida/reapresentacao_de_conta_bancaria Esta página vai auxiliar a reapresentar dados bancários após um erro no desembolso ### 1 - Atualização de conta bancária Primeiro você deve atualizar os dados da conta bancária do tomador #### Request ENDPOINT /debt/DEBT/disbursement_bank_accounts MÉTODO PUT Request Body **Usando dados bancários** ```json { "disbursement_bank_accounts": [{ "document_number": "31233261000185", "name": "Jorge Augusto Salgado Salhani", "pix_transfer_type": "manual", "bank_code": "329", "branch_number": "0001", "account_number": "62400", "account_digit": "6", "percentage_receivable": 100 }] } ``` **Usando chave pix** ```json { "disbursement_bank_accounts": [{ "document_number": "31233261000185", "name": "Jorge Augusto Salgado Salhani", "pix_key": "2f205c99-3161-4120-badd-854039d12de6", "pix_transfer_type": "key" }] } ``` ### 2 - Atualização da data de desembolso Após, você deve atualizar as datas de desembolso #### Request ENDPOINT /debt/DEBT/disbursement_option MÉTODO PATCH Request Body **Atualização de data de desembolso** ```json { "disbursement_date": "2025-11-28", "status": "active" } ``` --- # Reenviar documentos das partes relacionadas ao contrato de crédito URL: /documentation/emissao_de_divida/reenviar_documentos_das_partes_relacionadas ## Request ENDPOINT /debt/ DEBT-KEY /related_party/ RELATED-PARTY-KEY /attached_document MÉTODO POST **Request Body** ```json { "document_identification": "2893fc74-88fd-4cc9-a5c6-8a63d9d00f41", "document_identification_back": "e881ddf4-bc9a-48e0-9555-cac979f65431", "wedding_certificate": "955a0e36-1abd-4efd-868a-f0b3d53bc585", "proof_of_residence": "ea5f7b08-77fd-4adb-8bf5-f86379c28ee3", "company_statute": "150292ad-be66-4ba0-a306-0ceda20616f0", "directors_election_minute": "ca37979e-6f11-4465-bf3b-69cd8307549c", "insurance_agreement":"4be38197-e8a9-4c96-882d-99e38a7199a7", "loan_agreement_evidence": "494598fd-c226-4332-a500-591ae3684673" } ``` ### Path Params | Campo | Tipo | Descrição | |---|---|---| | `debt_key` * | string | debt_key da operação. | | `related_party_key` * | string | key da parte relacionada que os documentos serão enviados. | ### Body Params | Campo | Tipo | Descrição | Caracteres | |---|---| ---| ---| | `document_identification` | string | Frente do RG ou CNH para person_type "natural". | chave uuid | | `document_identification_back` | string | Verso do RG ou CNH para person_type "natural". | chave uuid | | `wedding_certificate` | string |Certidão de casamento para person_type "natural". | chave uuid | | `proof_of_residence` | string | Comprovante de residência para person_type "natural". | chave uuid | | `company_statute` | string | Estatuto social para person_type "legal". | chave uuid | | `insurance_agreement` | string | Evidência da contratação de seguro para a operação de crédito | chave uuid | | `loan_agreement_evidence` | string | Evidência do contrato de empréstimo. | chave uui ## Response STATUS 201 **Response Body** ```json " {} " ``` STATUS 400 **Response Body** ```json { "data": "{\"title\": \"Bad Request\", \"description\": \"Invalid request body.\", \"translation\": \"Corpo da requisição inválido.\", \"extra_fields\": {}, \"code\": \"LEG000069\"}" } ``` --- # Ações pós-desembolso URL: /documentation/emissao_de_divida/reprocessar_acao_pos_desembolso ## 1. Webhooks de sucesso ou falha na execução de uma ação pós desembolso :::info Aviso A *action_key* é a chave identificadora de uma ação pós desembolso. ::: ### Sucesso WEBHOOK_TYPE debt_actions STATUS success **Boleto** ```json title='Webhook Body' { "key": "19dee101-a781-4308-b7d1-f4426c2df111", "data": [ { "status": "done", "action_key": "02f6392b-65d3-4f3e-ae91-cd5b371c7111", "action_data": { "digitable_line": "11193708089000014656468000284304297860007686111" }, "action_type": "bankslip_payment", "action_error": null, "execution_data": { "bank_slip": { "payer": { "name": "PAGADOR", "document_number": "33128940002", "document_number_formatted": "331.289.400-02" }, "beneficiary": { "name": "TESTES FINANCIAMENTO", "document_number": "16832953000156", "document_number_formatted": "16.832.953/0001-56" }, "payment_key": "318aa3a0-01ca-41ac-9e0f-23c24bc67fc9", "payment_date": "2024-07-23", "digitable_line": "11193708089000014656468000284304297860007686111", "expiration_date": "2024-07-23", "tax_collection_info": {}, "payment_date_formatted": "23/07/2024", "expiration_date_formatted": "23/07/2024", "financial_institution_name": "BCO BRADESCO S.A.", "financial_institution_compe_number": "237" }, "origin_key": "318aa3a0-01ca-41ac-9e0f-23c24bc67111", "transacted_at": "2024-07-23 21:31:09", "source_account": { "owner_name": "PAGADOR", "account_digit": "5", "account_branch": "0001", "account_number": "4588111", "owner_document_number": "33128940002", "financial_institution_name": "QI SCD S.A.", "owner_document_number_formatted": "331.289.400-02", "financial_institution_compe_number": 329 }, "source_subtype": "bank_slip_payment", "transaction_key": "a7af6954-3bc5-4f7e-a872-b4e47800d111", "transacted_at_br": "2024-07-23 18:31:09", "pdf_encoded_string": "BASE 64 DO PDF DO COMPROVANTE", "transaction_amount": 76862.27, "transacted_at_formatted": "23/07/2024, 21:31:09", "transacted_at_br_formatted": "23/07/2024, 18:31:09", "transaction_amount_formatted": "R$ 76.862,27", "source_subtype_translation_ptbr": "Pagamento de Boleto" } } ], "webhook_type": "debt_actions", "event_datetime": "2024-07-23 21:31:18" } ``` **TED** ```json title='Webhook Body' { "key": "25f14329-3734-40d8-bc5a-c5349b3cd111", "data": [ { "status": "done", "action_key": "650e9041-65ec-4fd8-9b11-01e37316cf94", "action_data": { "qr_code": null, "destination": { "name": "TOMAR DIVIDA", "account_digit": "1", "account_branch": "0001", "account_number": "12214111", "document_number": "61359908021", "financial_institution_code_number": "380" }, "digitable_line": null, "pix_transfer_type": null, "transaction_amount": 500 }, "action_type": "funds_transfer", "action_error": null, "execution_data": { "origin_key": "ec2112a3-9b75-4cf3-b18e-7af06857fdc5", "transacted_at": "2024-07-04 10:03:25", "source_account": { "owner_name": "Conta de Origem", "account_digit": "9", "account_branch": "0001", "account_number": "2845000", "owner_document_number": "49783394487", "financial_institution_name": "QI SCD S.A.", "owner_document_number_formatted": "494.924.100-10", "financial_institution_compe_number": 329 }, "source_subtype": "withdrawal", "target_account": { "owner_name": "CONTA DESTINO", "account_type": "checking_account", "account_digit": "1", "account_branch": "0001", "account_number": "12214111", "account_type_str": "Conta Corrente", "owner_document_number": "61359908021", "financial_institution_name": "PICPAY", "owner_document_number_formatted": "613.599.080-21", "financial_institution_compe_number": "380" }, "transaction_key": "eeb35946-099f-4d40-8930-881aa3730d55", "transacted_at_br": "2024-07-04 07:03:25", "pdf_encoded_string": "BASE 64 DO PDF DO COMPROVANTE", "transaction_amount": 500, "transacted_at_formatted": "04/07/2024, 10:03:25", "transacted_at_br_formatted": "04/07/2024, 07:03:25", "transaction_amount_formatted": "R$ 500,00", "source_subtype_translation_ptbr": "Transferência" } } ], "webhook_type": "debt_actions", "event_datetime": "2024-07-04 10:03:33" } ``` ### Erro na ação pós-desembolso Em caso de erro no pagamento da ação pós-desembolso, o parceiro será notificado através do seguinte webhook: WEBHOOK_TYPE after_disbursement_action_update STATUS error **Boleto** ```json title='Webhook Body' { "key": "e358e7e3-17b8-4aab-9da1-92f6b78dea00", "data": { "status": "error", "action_key": "e2495e5a-df32-4826-b6f0-419014d3c35a", "error_data": { "error_code": "QIT000007", "description": "Account blocked balance cannot be negative." }, "action_data": { "digitable_line": "10495419967200010004900031456924592920008049295" }, "action_type": "bankslip_payment", "execution_data": null }, "webhook_type": "after_disbursement_action_update", "event_datetime": "2023-03-22 12:06:38" } ``` **TED** ```json title='Webhook Body' { "key": "e358e7e3-17b8-4aab-9da1-92f6b78dea00", "data": { "status": "error", "action_key": "e2495e5a-df32-4826-b6f0-419014d3c35a", "error_data": { "error_code": "QIT000007", "description": "Account blocked balance cannot be negative." }, "action_data": { "destination": { "name": "Nome Credor Original", "account_digit": "0", "account_branch": "0897", "account_number": "20001", "document_number": "87163234000138", "financial_institution_code_number": "341" }, "transaction_amount": 1000 }, "action_type": "funds_transfer", "execution_data": null }, "webhook_type": "after_disbursement_action_update", "event_datetime": "2023-03-22 12:06:38" } ``` ### Estorno da TED da ação pós-desembolso Caso a TED realizada na ação pós-desembolso seja devolvida pela instituição financeira destinatária, o parceiro será notificado através do seguinte webhook: WEBHOOK_TYPE after_disbursement_action_update STATUS refused ```json title='Webhook Body' { "key": "f4b5c36a-2aa1-4865-9678-e5a6fa585845", "data": { "status": "refused", "action_key": "cf3b8809-36dc-4574-8763-3600e413cf5c", "error_data": { "code": "agencia_conta_invalida", "description": "Agência ou Conta Destinatária do Crédito Inválida" }, "action_data": { "destination": { "name": "SILVANA RAMOS DOS SANTOS", "account_digit": "1", "account_branch": "0150", "account_number": "301771620", "document_number": "30874011884", "financial_institution_code_number": "237" }, "transaction_amount": 3200 }, "action_type": "funds_transfer", "action_amount": 3200.0 }, "webhook_type": "after_disbursement_action_update", "event_datetime": "2023-03-23 14:46:39" } ``` ## 2. Reprocessar ação pós desembolso alterando dados da ação Caso ocorra um erro/estorno no pagamento da ação pós-desembolso, ela pode ser retentada através do seguinte endpoint ### Path Params | Campo | Tipo | Descrição | |---|---| ---| | `action_key` * | string | Chave da ação devolvida no momento da criação da operação de crédito. | ### Request ENDPOINT /baas/action/ ACTION-KEY MÉTODO PATCH Request Body **TED** ```json { "destination": { "name": "Nome Credor Original", "account_digit": "0", "account_branch": "0897", "account_number": "20001", "document_number": "87163234000138", "financial_institution_code_number": "341" }, "transaction_amount": 4736.07 } ``` **Linha digitável Boleto** ```json { "digitable_line": "10495419967200010004900031456924592920008041111" } ``` **Pix Copia e Cola** ```json { "qr_code": "00020126930014br.gov.bcb.pix2571qrcode-h.sandbox.qitech.app/bacen/cobv/66e9a02c1c304b1eacf7ba984eea19ce5204000053039865802BR5925BANKSOFTTECNOLOGIALTDA(EB6008SaoPaulo61080145200062070503***6304E27B", "pix_transfer_type": "qr_code", "transaction_amount": "299.00" } ``` ## 3. Reprocessar ação pós desembolso sem alteração de dados ### Request ENDPOINT /baas/action/action_retry/ ACTION-KEY MÉTODO PATCH :::info Informação As respostas dos dois endpoints são as mesmas ::: ### Response STATUS 200 Response Body ```json { "action_data": { "origin_key": "8b8742f0-0b7c-4939-bfcf-9bae8c60c088", "pdf_encoded_string": "\", "source_account": { "account_branch": "0001", "account_digit": "1", "account_number": "2788652", "financial_institution_compe_number": 329, "financial_institution_name": "QI SCD S.A.", "owner_document_number": "12345678911", "owner_document_number_formatted": "123.456.789-11", "owner_name": "Nome do titular da conta" }, "source_subtype": "withdrawal", "source_subtype_translation_ptbr": "Transferência", "target_account": { "account_branch": "1012", "account_digit": "1", "account_number": "12345", "account_type": "checking_account", "account_type_str": "Conta Corrente", "financial_institution_compe_number": "341", "financial_institution_name": "ITAÚ UNIBANCO S.A.", "owner_document_number": "12345678911", "owner_document_number_formatted": "125.220.107-94", "owner_name": "Nome do titular da conta destino" }, "transacted_at": "2023-03-14 17:57:20", "transacted_at_br": "2023-03-14 14:57:20", "transacted_at_br_formatted": "14/03/2023, 14:57:20", "transacted_at_formatted": "14/03/2023, 17:57:20", "transaction_amount": 2000, "transaction_amount_formatted": "R$ 2.000,00", "transaction_key": "ae139d20-396e-4c7e-a675-a8cb01160f5d" }, "action_key": "fe3f251d-6b85-4d35-96dd-08fc37d09a82" } ``` STATUS 400 Response Body ```json { "data": "{\"title\": \"Bad Request\", \"description\": \"Invalid request body.\", \"translation\": \"Corpo da requisição inválido.\", \"extra_fields\": {}, \"code\": \"LEG000069\"}" } ``` STATUS 402 Response Body ```json { "data": "{\"title\": \"Block Balance Error\", \"description\": \"Impossible to block an amount greater than account balance\", \"translation\": \"Não é possível blockear uma quantidade maior do que o saldo na conta\", \"extra_fields\": {}, \"code\": \"ACC000018\"}" } ``` --- # Alterar Dados de Desembolso URL: /documentation/emissao_de_divida/reprocessar_multiplas_datas/trocar_conta ## Request ENDPOINT /debt/ DEBT-KEY /disbursement_bank_accounts MÉTODO PUT ### Path Params | Campo | Tipo | Descrição | |---|---| ---| | `debt_key` *(obrigatório)* | string | ID da divida emitida. | **Request Body** ```json { "disbursement_bank_accounts": [{ "bank_code": "329", "branch_number": "001", "account_number": "6947216", "account_digit": "4", "account_type": "checking_account", "document_number": "946321801", "name": "Pedro Felipe Henrique Alves", "percentage_receivable": 100 }] } ``` ### Body Params Uma emissão de dívida deve conter as informações bancárias para desembolso, por padrão, uma conta de titularidade do devedor. | Campo | Tipo | Descrição | Máx. Caract. | |-----------------------|--------|----------------------------------------------------------------------------------------------------|--------------| | name * | string | Nome do titular da conta | 50 | | document_number * | string | CPF do titular da conta | 11 | | bank_code * | string | Código COMPE da instituição financeira (https://www.bcb.gov.br/pom/spb/estatistica/port/ASTR003.pdf) | 3 | | branch_number * | string | Número da agência (não informar o dígito verificador da agência!) | 4 | | account_number * | string | Número da conta (sem o dígito verificador da conta!) | 10 | | account_digit * | string | Dígito verificador da conta (informar zero no lugar de letras) | 1 | | account_type | enum | [Enumerador Account Type](#enumerador-account-type) Tipo da conta | 1 | ## Response STATUS 200 **Request Body** ```json {} ``` STATUS 400 **Request Body** ```json { "data": "{\"title\": \"Bad Request\", \"description\": \"Invalid request body.\", \"translation\": \"Corpo da requisição inválido.\", \"extra_fields\": {}, \"code\": \"LEG000069\"}" } ``` --- # Alterar Data de Desembolso URL: /documentation/emissao_de_divida/reprocessar_multiplas_datas/trocar_data ## Request ENDPOINT /debt/ DEBT-KEY /disbursement_option MÉTODO PATCH ### Path Params | Campo | Tipo | Descrição | |---|---| ---| | `debt_key` *(obrigatório)* | string | ID da divida emitida. | **Request Body** ```json { "disbursement_date": "2023-06-30", "status": "active" } ``` ### Body Params | Campo | Tipo | Descrição | |---|---| ---| | `disbursement_date` | string | Data de desembolso da operação. | | `status` | string | Indica se a data deve ser configurada ou removida. | ## Response STATUS 200 **Request Body** ```json { "data": { "additional_iof": 17.770586, "annual_cet": 31.682, "assignment_amount": 4676.97, "base_iof": 127.71954759, "borrower": { "document_number": "88229032939", "name": "Teste", "related_party_key": "13d210c8-d39a-40f9-bd16-b6ab81d35fa8" }, "cet": 2.32, "collaterals": [], "contract": { "number": "0000051370/TG", "urls": [ "https://storage.googleapis.com/dev-doc-api/documents/a715175f-8d29-4929-9576-4b692d1e9610/BEATRIZCOUTODECARVALHO-TESTE-CCB-0000051370-20230707151409.pdf" ] }, "contract_fee_amount": 0.5, "contract_fees": [{ "fee_amount": 0.5, "fee_type": "spread" }], "disbursed_issue_amount": 4530.98, "entry": null, "external_contract_fee_amount": 0.0, "external_contract_fees": [{ "description": null, "fee_amount": 0.0, "fee_type": "spread", "net_fee_amount": 0.0, "rebate_bank_account": null, "tax_amount": 0.0 }], "installments": [{ "accrual_reference_date": null, "additional_costs": [], "advanced_paid_amount": 0.0, "bank_slip_key": null, "business_due_date": "2023-08-29", "calendar_days": 50, "digitable_line": null, "due_date": "2023-08-28", "due_interest": 0.0, "due_principal": 4676.47, "fine_amount": null, "has_interest": true, "installment_history": [], "installment_key": "29c6e226-b710-4e3b-a5d6-62119b9d9547", "installment_number": 1, "installment_payment": [], "installment_status": "created", "installment_type": "principal", "original_due_principal": 4676.47, "original_pre_fixed_amount": 164.86042852, "original_principal_amortization_amount": 25.13957148, "original_total_amount": 190.0, "paid_amount": 0.0, "paid_at": null, "post_fixed_amount": null, "pre_fixed_amount": 164.86042852, "principal_amortization_amount": 25.13957148, "qr_code_key": null, "qr_code_url": null, "renegotiation_proposal_key": null, "tax_amount": 0.10307224, "total_accrual_amount": null, "total_amount": 190.0, "total_paid_amount": 0.0, "workdays": 36 }, { "accrual_reference_date": null, "additional_costs": [], "advanced_paid_amount": 0.0, "bank_slip_key": null, "business_due_date": "2023-09-29", "calendar_days": 31, "digitable_line": null, "due_date": "2023-09-28", "due_interest": 0.0, "due_principal": 4651.33042852, "fine_amount": null, "has_interest": true, "installment_history": [], "installment_key": "322d7973-4d2a-41a6-ad1b-2fef59c551b7", "installment_number": 2, "installment_payment": [], "installment_status": "created", "installment_type": "principal", "original_due_principal": 4651.33042852, "original_pre_fixed_amount": 100.99385125, "original_principal_amortization_amount": 89.00614875, "original_total_amount": 190.0, "paid_amount": 0.0, "paid_at": null, "post_fixed_amount": null, "pre_fixed_amount": 100.99385125, "principal_amortization_amount": 89.00614875, "qr_code_key": null, "qr_code_url": null, "renegotiation_proposal_key": null, "tax_amount": 0.59117884, "total_accrual_amount": null, "total_amount": 190.0, "total_paid_amount": 0.0, "workdays": 22 }, { "accrual_reference_date": null, "additional_costs": [], "advanced_paid_amount": 0.0, "bank_slip_key": null, "business_due_date": "2023-10-31", "calendar_days": 30, "digitable_line": null, "due_date": "2023-10-28", "due_interest": 0.0, "due_principal": 4562.32427977, "fine_amount": null, "has_interest": true, "installment_history": [], "installment_key": "a2d43778-0342-48f7-a0d2-c385773fa545", "installment_number": 3, "installment_payment": [], "installment_status": "created", "installment_type": "principal", "original_due_principal": 4562.32427977, "original_pre_fixed_amount": 95.83242026, "original_principal_amortization_amount": 94.16757974, "original_total_amount": 190.0, "paid_amount": 0.0, "paid_at": null, "post_fixed_amount": null, "pre_fixed_amount": 95.83242026, "principal_amortization_amount": 94.16757974, "qr_code_key": null, "qr_code_url": null, "renegotiation_proposal_key": null, "tax_amount": 0.85711331, "total_accrual_amount": null, "total_amount": 190.0, "total_paid_amount": 0.0, "workdays": 20 }, { "accrual_reference_date": null, "additional_costs": [], "advanced_paid_amount": 0.0, "bank_slip_key": null, "business_due_date": "2023-11-29", "calendar_days": 31, "digitable_line": null, "due_date": "2023-11-28", "due_interest": 0.0, "due_principal": 4468.15670003, "fine_amount": null, "has_interest": true, "installment_history": [], "installment_key": "9126aa9a-6bb0-44c6-8ea4-61fd68fcd936", "installment_number": 4, "installment_payment": [], "installment_status": "created", "installment_type": "principal", "original_due_principal": 4468.15670003, "original_pre_fixed_amount": 97.01661904, "original_principal_amortization_amount": 92.98338096, "original_total_amount": 190.0, "paid_amount": 0.0, "paid_at": null, "post_fixed_amount": null, "pre_fixed_amount": 97.01661904, "principal_amortization_amount": 92.98338096, "qr_code_key": null, "qr_code_url": null, "renegotiation_proposal_key": null, "tax_amount": 1.08269849, "total_accrual_amount": null, "total_amount": 190.0, "total_paid_amount": 0.0, "workdays": 20 }, { "accrual_reference_date": null, "additional_costs": [], "advanced_paid_amount": 0.0, "bank_slip_key": null, "business_due_date": "2023-12-29", "calendar_days": 30, "digitable_line": null, "due_date": "2023-12-28", "due_interest": 0.0, "due_principal": 4375.17331907, "fine_amount": null, "has_interest": true, "installment_history": [], "installment_key": "f0b363f9-0aca-4154-b14a-2c7933374abc", "installment_number": 5, "installment_payment": [], "installment_status": "created", "installment_type": "principal", "original_due_principal": 4375.17331907, "original_pre_fixed_amount": 91.90128137, "original_principal_amortization_amount": 98.09871863, "original_total_amount": 190.0, "paid_amount": 0.0, "paid_at": null, "post_fixed_amount": null, "pre_fixed_amount": 91.90128137, "principal_amortization_amount": 98.09871863, "qr_code_key": null, "qr_code_url": null, "renegotiation_proposal_key": null, "tax_amount": 1.38358433, "total_accrual_amount": null, "total_amount": 190.0, "total_paid_amount": 0.0, "workdays": 21 }, { "accrual_reference_date": null, "additional_costs": [], "advanced_paid_amount": 0.0, "bank_slip_key": null, "business_due_date": "2024-01-30", "calendar_days": 31, "digitable_line": null, "due_date": "2024-01-28", "due_interest": 0.0, "due_principal": 4277.07460043, "fine_amount": null, "has_interest": true, "installment_history": [], "installment_key": "c7c41dee-28a3-4b37-b2de-256fa0c9a0a9", "installment_number": 6, "installment_payment": [], "installment_status": "created", "installment_type": "principal", "original_due_principal": 4277.07460043, "original_pre_fixed_amount": 92.86767319, "original_principal_amortization_amount": 97.13232681, "original_total_amount": 190.0, "paid_amount": 0.0, "paid_at": null, "post_fixed_amount": null, "pre_fixed_amount": 92.86767319, "principal_amortization_amount": 97.13232681, "qr_code_key": null, "qr_code_url": null, "renegotiation_proposal_key": null, "tax_amount": 1.61686471, "total_accrual_amount": null, "total_amount": 190.0, "total_paid_amount": 0.0, "workdays": 20 }, { "accrual_reference_date": null, "additional_costs": [], "advanced_paid_amount": 0.0, "bank_slip_key": null, "business_due_date": "2024-02-29", "calendar_days": 31, "digitable_line": null, "due_date": "2024-02-28", "due_interest": 0.0, "due_principal": 4179.94227362, "fine_amount": null, "has_interest": true, "installment_history": [], "installment_key": "ee5d7b27-5160-49d3-9eb0-ec5a2f20e50d", "installment_number": 7, "installment_payment": [], "installment_status": "created", "installment_type": "principal", "original_due_principal": 4179.94227362, "original_pre_fixed_amount": 90.75864903, "original_principal_amortization_amount": 99.24135097, "original_total_amount": 190.0, "paid_amount": 0.0, "paid_at": null, "post_fixed_amount": null, "pre_fixed_amount": 90.75864903, "principal_amortization_amount": 99.24135097, "qr_code_key": null, "qr_code_url": null, "renegotiation_proposal_key": null, "tax_amount": 1.90424304, "total_accrual_amount": null, "total_amount": 190.0, "total_paid_amount": 0.0, "workdays": 21 }, { "accrual_reference_date": null, "additional_costs": [], "advanced_paid_amount": 0.0, "bank_slip_key": null, "business_due_date": "2024-04-01", "calendar_days": 29, "digitable_line": null, "due_date": "2024-03-28", "due_interest": 0.0, "due_principal": 4080.70092265, "fine_amount": null, "has_interest": true, "installment_history": [], "installment_key": "a9ec8c98-0061-4956-8af8-93d5742f6c1f", "installment_number": 8, "installment_payment": [], "installment_status": "created", "installment_type": "principal", "original_due_principal": 4080.70092265, "original_pre_fixed_amount": 82.82984224, "original_principal_amortization_amount": 107.17015776, "original_total_amount": 190.0, "paid_amount": 0.0, "paid_at": null, "post_fixed_amount": null, "pre_fixed_amount": 82.82984224, "principal_amortization_amount": 107.17015776, "qr_code_key": null, "qr_code_url": null, "renegotiation_proposal_key": null, "tax_amount": 2.31123162, "total_accrual_amount": null, "total_amount": 190.0, "total_paid_amount": 0.0, "workdays": 21 }, { "accrual_reference_date": null, "additional_costs": [], "advanced_paid_amount": 0.0, "bank_slip_key": null, "business_due_date": "2024-04-30", "calendar_days": 31, "digitable_line": null, "due_date": "2024-04-28", "due_interest": 0.0, "due_principal": 3973.53076489, "fine_amount": null, "has_interest": true, "installment_history": [], "installment_key": "bfd2ceab-74d4-4ff4-b099-c6ab986b7acb", "installment_number": 9, "installment_payment": [], "installment_status": "created", "installment_type": "principal", "original_due_principal": 3973.53076489, "original_pre_fixed_amount": 86.2768573, "original_principal_amortization_amount": 103.7231427, "original_total_amount": 190.0, "paid_amount": 0.0, "paid_at": null, "post_fixed_amount": null, "pre_fixed_amount": 86.2768573, "principal_amortization_amount": 103.7231427, "qr_code_key": null, "qr_code_url": null, "renegotiation_proposal_key": null, "tax_amount": 2.50055752, "total_accrual_amount": null, "total_amount": 190.0, "total_paid_amount": 0.0, "workdays": 20 }, { "accrual_reference_date": null, "additional_costs": [], "advanced_paid_amount": 0.0, "bank_slip_key": null, "business_due_date": "2024-05-29", "calendar_days": 30, "digitable_line": null, "due_date": "2024-05-28", "due_interest": 0.0, "due_principal": 3869.80762219, "fine_amount": null, "has_interest": true, "installment_history": [], "installment_key": "eb41f47f-ffcd-4d4d-8834-600cfe95b2a4", "installment_number": 10, "installment_payment": [], "installment_status": "created", "installment_type": "principal", "original_due_principal": 3869.80762219, "original_pre_fixed_amount": 81.2859859, "original_principal_amortization_amount": 108.7140141, "original_total_amount": 190.0, "paid_amount": 0.0, "paid_at": null, "post_fixed_amount": null, "pre_fixed_amount": 81.2859859, "principal_amortization_amount": 108.7140141, "qr_code_key": null, "qr_code_url": null, "renegotiation_proposal_key": null, "tax_amount": 2.88831393, "total_accrual_amount": null, "total_amount": 190.0, "total_paid_amount": 0.0, "workdays": 21 }, { "accrual_reference_date": null, "additional_costs": [], "advanced_paid_amount": 0.0, "bank_slip_key": null, "business_due_date": "2024-07-01", "calendar_days": 31, "digitable_line": null, "due_date": "2024-06-28", "due_interest": 0.0, "due_principal": 3761.09360809, "fine_amount": null, "has_interest": true, "installment_history": [], "installment_key": "13183e83-70cf-4990-a3cc-c979e43015b9", "installment_number": 11, "installment_payment": [], "installment_status": "created", "installment_type": "principal", "original_due_principal": 3761.09360809, "original_pre_fixed_amount": 81.6642313, "original_principal_amortization_amount": 108.3357687, "original_total_amount": 190.0, "paid_amount": 0.0, "paid_at": null, "post_fixed_amount": null, "pre_fixed_amount": 81.6642313, "principal_amortization_amount": 108.3357687, "qr_code_key": null, "qr_code_url": null, "renegotiation_proposal_key": null, "tax_amount": 3.15365423, "total_accrual_amount": null, "total_amount": 190.0, "total_paid_amount": 0.0, "workdays": 22 }, { "accrual_reference_date": null, "additional_costs": [], "advanced_paid_amount": 0.0, "bank_slip_key": null, "business_due_date": "2024-07-30", "calendar_days": 30, "digitable_line": null, "due_date": "2024-07-28", "due_interest": 0.0, "due_principal": 3652.75783939, "fine_amount": null, "has_interest": true, "installment_history": [], "installment_key": "a2ed3748-8567-4cab-a1ff-0cf6b2698d15", "installment_number": 12, "installment_payment": [], "installment_status": "created", "installment_type": "principal", "original_due_principal": 3652.75783939, "original_pre_fixed_amount": 76.72681698, "original_principal_amortization_amount": 113.27318302, "original_total_amount": 190.0, "paid_amount": 0.0, "paid_at": null, "post_fixed_amount": null, "pre_fixed_amount": 76.72681698, "principal_amortization_amount": 113.27318302, "qr_code_key": null, "qr_code_url": null, "renegotiation_proposal_key": null, "tax_amount": 3.39026637, "total_accrual_amount": null, "total_amount": 190.0, "total_paid_amount": 0.0, "workdays": 20 }, { "accrual_reference_date": null, "additional_costs": [], "advanced_paid_amount": 0.0, "bank_slip_key": null, "business_due_date": "2024-08-29", "calendar_days": 31, "digitable_line": null, "due_date": "2024-08-28", "due_interest": 0.0, "due_principal": 3539.48465638, "fine_amount": null, "has_interest": true, "installment_history": [], "installment_key": "1e009f23-2044-40ba-8249-a9077a2391b9", "installment_number": 13, "installment_payment": [], "installment_status": "created", "installment_type": "principal", "original_due_principal": 3539.48465638, "original_pre_fixed_amount": 76.85245907, "original_principal_amortization_amount": 113.14754093, "original_total_amount": 190.0, "paid_amount": 0.0, "paid_at": null, "post_fixed_amount": null, "pre_fixed_amount": 76.85245907, "principal_amortization_amount": 113.14754093, "qr_code_key": null, "qr_code_url": null, "renegotiation_proposal_key": null, "tax_amount": 3.3865059, "total_accrual_amount": null, "total_amount": 190.0, "total_paid_amount": 0.0, "workdays": 23 }, { "accrual_reference_date": null, "additional_costs": [], "advanced_paid_amount": 0.0, "bank_slip_key": null, "business_due_date": "2024-10-01", "calendar_days": 31, "digitable_line": null, "due_date": "2024-09-28", "due_interest": 0.0, "due_principal": 3426.33711545, "fine_amount": null, "has_interest": true, "installment_history": [], "installment_key": "e475d886-a596-4541-bcae-4986bf7c3609", "installment_number": 14, "installment_payment": [], "installment_status": "created", "installment_type": "principal", "original_due_principal": 3426.33711545, "original_pre_fixed_amount": 74.39569823, "original_principal_amortization_amount": 115.60430177, "original_total_amount": 190.0, "paid_amount": 0.0, "paid_at": null, "post_fixed_amount": null, "pre_fixed_amount": 74.39569823, "principal_amortization_amount": 115.60430177, "qr_code_key": null, "qr_code_url": null, "renegotiation_proposal_key": null, "tax_amount": 3.46003675, "total_accrual_amount": null, "total_amount": 190.0, "total_paid_amount": 0.0, "workdays": 22 }, { "accrual_reference_date": null, "additional_costs": [], "advanced_paid_amount": 0.0, "bank_slip_key": null, "business_due_date": "2024-10-29", "calendar_days": 30, "digitable_line": null, "due_date": "2024-10-28", "due_interest": 0.0, "due_principal": 3310.73281367, "fine_amount": null, "has_interest": true, "installment_history": [], "installment_key": "5584643d-4e65-4e99-9483-b3c1b051fd63", "installment_number": 15, "installment_payment": [], "installment_status": "created", "installment_type": "principal", "original_due_principal": 3310.73281367, "original_pre_fixed_amount": 69.54252108, "original_principal_amortization_amount": 120.45747892, "original_total_amount": 190.0, "paid_amount": 0.0, "paid_at": null, "post_fixed_amount": null, "pre_fixed_amount": 69.54252108, "principal_amortization_amount": 120.45747892, "qr_code_key": null, "qr_code_url": null, "renegotiation_proposal_key": null, "tax_amount": 3.60529234, "total_accrual_amount": null, "total_amount": 190.0, "total_paid_amount": 0.0, "workdays": 21 }, { "accrual_reference_date": null, "additional_costs": [], "advanced_paid_amount": 0.0, "bank_slip_key": null, "business_due_date": "2024-11-29", "calendar_days": 31, "digitable_line": null, "due_date": "2024-11-28", "due_interest": 0.0, "due_principal": 3190.27533475, "fine_amount": null, "has_interest": true, "installment_history": [], "installment_key": "23a0002c-49bf-4c22-a506-d89ae4372249", "installment_number": 16, "installment_payment": [], "installment_status": "created", "installment_type": "principal", "original_due_principal": 3190.27533475, "original_pre_fixed_amount": 69.27011321, "original_principal_amortization_amount": 120.72988679, "original_total_amount": 190.0, "paid_amount": 0.0, "paid_at": null, "post_fixed_amount": null, "pre_fixed_amount": 69.27011321, "principal_amortization_amount": 120.72988679, "qr_code_key": null, "qr_code_url": null, "renegotiation_proposal_key": null, "tax_amount": 3.61344551, "total_accrual_amount": null, "total_amount": 190.0, "total_paid_amount": 0.0, "workdays": 22 }, { "accrual_reference_date": null, "additional_costs": [], "advanced_paid_amount": 0.0, "bank_slip_key": null, "business_due_date": "2024-12-31", "calendar_days": 30, "digitable_line": null, "due_date": "2024-12-28", "due_interest": 0.0, "due_principal": 3069.54544796, "fine_amount": null, "has_interest": true, "installment_history": [], "installment_key": "5efbf6d0-84bc-4041-8a33-e9ab1bf82969", "installment_number": 17, "installment_payment": [], "installment_status": "created", "installment_type": "principal", "original_due_principal": 3069.54544796, "original_pre_fixed_amount": 64.47633798, "original_principal_amortization_amount": 125.52366202, "original_total_amount": 190.0, "paid_amount": 0.0, "paid_at": null, "post_fixed_amount": null, "pre_fixed_amount": 64.47633798, "principal_amortization_amount": 125.52366202, "qr_code_key": null, "qr_code_url": null, "renegotiation_proposal_key": null, "tax_amount": 3.7569232, "total_accrual_amount": null, "total_amount": 190.0, "total_paid_amount": 0.0, "workdays": 20 }, { "accrual_reference_date": null, "additional_costs": [], "advanced_paid_amount": 0.0, "bank_slip_key": null, "business_due_date": "2025-01-29", "calendar_days": 31, "digitable_line": null, "due_date": "2025-01-28", "due_interest": 0.0, "due_principal": 2944.02178595, "fine_amount": null, "has_interest": true, "installment_history": [], "installment_key": "e9bb5d68-8c93-43a4-b240-d68b0d1d6d08", "installment_number": 18, "installment_payment": [], "installment_status": "created", "installment_type": "principal", "original_due_principal": 2944.02178595, "original_pre_fixed_amount": 63.9232354, "original_principal_amortization_amount": 126.0767646, "original_total_amount": 190.0, "paid_amount": 0.0, "paid_at": null, "post_fixed_amount": null, "pre_fixed_amount": 63.9232354, "principal_amortization_amount": 126.0767646, "qr_code_key": null, "qr_code_url": null, "renegotiation_proposal_key": null, "tax_amount": 3.77347756, "total_accrual_amount": null, "total_amount": 190.0, "total_paid_amount": 0.0, "workdays": 21 }, { "accrual_reference_date": null, "additional_costs": [], "advanced_paid_amount": 0.0, "bank_slip_key": null, "business_due_date": "2025-03-05", "calendar_days": 31, "digitable_line": null, "due_date": "2025-02-28", "due_interest": 0.0, "due_principal": 2817.94502134, "fine_amount": null, "has_interest": true, "installment_history": [], "installment_key": "d6c34059-ba9b-4345-b937-35293f34a3dd", "installment_number": 19, "installment_payment": [], "installment_status": "created", "installment_type": "principal", "original_due_principal": 2817.94502134, "original_pre_fixed_amount": 61.18574366, "original_principal_amortization_amount": 128.81425634, "original_total_amount": 190.0, "paid_amount": 0.0, "paid_at": null, "post_fixed_amount": null, "pre_fixed_amount": 61.18574366, "principal_amortization_amount": 128.81425634, "qr_code_key": null, "qr_code_url": null, "renegotiation_proposal_key": null, "tax_amount": 3.85541069, "total_accrual_amount": null, "total_amount": 190.0, "total_paid_amount": 0.0, "workdays": 23 }, { "accrual_reference_date": null, "additional_costs": [], "advanced_paid_amount": 0.0, "bank_slip_key": null, "business_due_date": "2025-03-31", "calendar_days": 28, "digitable_line": null, "due_date": "2025-03-28", "due_interest": 0.0, "due_principal": 2689.130765, "fine_amount": null, "has_interest": true, "installment_history": [], "installment_key": "63fa4169-f1a9-43f0-a059-70e2df35ac7e", "installment_number": 20, "installment_payment": [], "installment_status": "created", "installment_type": "principal", "original_due_principal": 2689.130765, "original_pre_fixed_amount": 52.68330953, "original_principal_amortization_amount": 137.31669047, "original_total_amount": 190.0, "paid_amount": 0.0, "paid_at": null, "post_fixed_amount": null, "pre_fixed_amount": 52.68330953, "principal_amortization_amount": 137.31669047, "qr_code_key": null, "qr_code_url": null, "renegotiation_proposal_key": null, "tax_amount": 4.10988855, "total_accrual_amount": null, "total_amount": 190.0, "total_paid_amount": 0.0, "workdays": 18 }, { "accrual_reference_date": null, "additional_costs": [], "advanced_paid_amount": 0.0, "bank_slip_key": null, "business_due_date": "2025-04-29", "calendar_days": 31, "digitable_line": null, "due_date": "2025-04-28", "due_interest": 0.0, "due_principal": 2551.81407453, "fine_amount": null, "has_interest": true, "installment_history": [], "installment_key": "859ee4fa-f781-419b-8888-731b0f8fc01b", "installment_number": 21, "installment_payment": [], "installment_status": "created", "installment_type": "principal", "original_due_principal": 2551.81407453, "original_pre_fixed_amount": 55.40726995, "original_principal_amortization_amount": 134.59273005, "original_total_amount": 190.0, "paid_amount": 0.0, "paid_at": null, "post_fixed_amount": null, "pre_fixed_amount": 55.40726995, "principal_amortization_amount": 134.59273005, "qr_code_key": null, "qr_code_url": null, "renegotiation_proposal_key": null, "tax_amount": 4.02836041, "total_accrual_amount": null, "total_amount": 190.0, "total_paid_amount": 0.0, "workdays": 19 }, { "accrual_reference_date": null, "additional_costs": [], "advanced_paid_amount": 0.0, "bank_slip_key": null, "business_due_date": "2025-05-29", "calendar_days": 30, "digitable_line": null, "due_date": "2025-05-28", "due_interest": 0.0, "due_principal": 2417.22134448, "fine_amount": null, "has_interest": true, "installment_history": [], "installment_key": "d6e25388-d54d-42ca-8b46-ac70fa7aeb23", "installment_number": 22, "installment_payment": [], "installment_status": "created", "installment_type": "principal", "original_due_principal": 2417.22134448, "original_pre_fixed_amount": 50.7741553, "original_principal_amortization_amount": 139.2258447, "original_total_amount": 190.0, "paid_amount": 0.0, "paid_at": null, "post_fixed_amount": null, "pre_fixed_amount": 50.7741553, "principal_amortization_amount": 139.2258447, "qr_code_key": null, "qr_code_url": null, "renegotiation_proposal_key": null, "tax_amount": 4.16702953, "total_accrual_amount": null, "total_amount": 190.0, "total_paid_amount": 0.0, "workdays": 21 }, { "accrual_reference_date": null, "additional_costs": [], "advanced_paid_amount": 0.0, "bank_slip_key": null, "business_due_date": "2025-07-01", "calendar_days": 31, "digitable_line": null, "due_date": "2025-06-28", "due_interest": 0.0, "due_principal": 2277.99549978, "fine_amount": null, "has_interest": true, "installment_history": [], "installment_key": "d92f0e38-fa48-48c2-a79e-e8316fe5c870", "installment_number": 23, "installment_payment": [], "installment_status": "created", "installment_type": "principal", "original_due_principal": 2277.99549978, "original_pre_fixed_amount": 49.46187558, "original_principal_amortization_amount": 140.53812442, "original_total_amount": 190.0, "paid_amount": 0.0, "paid_at": null, "post_fixed_amount": null, "pre_fixed_amount": 49.46187558, "principal_amortization_amount": 140.53812442, "qr_code_key": null, "qr_code_url": null, "renegotiation_proposal_key": null, "tax_amount": 4.20630606, "total_accrual_amount": null, "total_amount": 190.0, "total_paid_amount": 0.0, "workdays": 21 }, { "accrual_reference_date": null, "additional_costs": [], "advanced_paid_amount": 0.0, "bank_slip_key": null, "business_due_date": "2025-07-29", "calendar_days": 30, "digitable_line": null, "due_date": "2025-07-28", "due_interest": 0.0, "due_principal": 2137.45737535, "fine_amount": null, "has_interest": true, "installment_history": [], "installment_key": "04aa2658-8fbe-4147-8a14-03c7bba13577", "installment_number": 24, "installment_payment": [], "installment_status": "created", "installment_type": "principal", "original_due_principal": 2137.45737535, "original_pre_fixed_amount": 44.89766385, "original_principal_amortization_amount": 145.10233615, "original_total_amount": 190.0, "paid_amount": 0.0, "paid_at": null, "post_fixed_amount": null, "pre_fixed_amount": 44.89766385, "principal_amortization_amount": 145.10233615, "qr_code_key": null, "qr_code_url": null, "renegotiation_proposal_key": null, "tax_amount": 4.34291292, "total_accrual_amount": null, "total_amount": 190.0, "total_paid_amount": 0.0, "workdays": 21 }, { "accrual_reference_date": null, "additional_costs": [], "advanced_paid_amount": 0.0, "bank_slip_key": null, "business_due_date": "2025-08-29", "calendar_days": 31, "digitable_line": null, "due_date": "2025-08-28", "due_interest": 0.0, "due_principal": 1992.35503921, "fine_amount": null, "has_interest": true, "installment_history": [], "installment_key": "af5b3343-7d91-46cf-a908-bf24e4e79907", "installment_number": 25, "installment_payment": [], "installment_status": "created", "installment_type": "principal", "original_due_principal": 1992.35503921, "original_pre_fixed_amount": 43.25979382, "original_principal_amortization_amount": 146.74020618, "original_total_amount": 190.0, "paid_amount": 0.0, "paid_at": null, "post_fixed_amount": null, "pre_fixed_amount": 43.25979382, "principal_amortization_amount": 146.74020618, "qr_code_key": null, "qr_code_url": null, "renegotiation_proposal_key": null, "tax_amount": 4.39193437, "total_accrual_amount": null, "total_amount": 190.0, "total_paid_amount": 0.0, "workdays": 23 }, { "accrual_reference_date": null, "additional_costs": [], "advanced_paid_amount": 0.0, "bank_slip_key": null, "business_due_date": "2025-09-30", "calendar_days": 31, "digitable_line": null, "due_date": "2025-09-28", "due_interest": 0.0, "due_principal": 1845.61483303, "fine_amount": null, "has_interest": true, "installment_history": [], "installment_key": "1e7981d6-4274-49f1-ab6e-a98d97485e78", "installment_number": 26, "installment_payment": [], "installment_status": "created", "installment_type": "principal", "original_due_principal": 1845.61483303, "original_pre_fixed_amount": 40.07363891, "original_principal_amortization_amount": 149.92636109, "original_total_amount": 190.0, "paid_amount": 0.0, "paid_at": null, "post_fixed_amount": null, "pre_fixed_amount": 40.07363891, "principal_amortization_amount": 149.92636109, "qr_code_key": null, "qr_code_url": null, "renegotiation_proposal_key": null, "tax_amount": 4.48729599, "total_accrual_amount": null, "total_amount": 190.0, "total_paid_amount": 0.0, "workdays": 21 }, { "accrual_reference_date": null, "additional_costs": [], "advanced_paid_amount": 0.0, "bank_slip_key": null, "business_due_date": "2025-10-29", "calendar_days": 30, "digitable_line": null, "due_date": "2025-10-28", "due_interest": 0.0, "due_principal": 1695.68847194, "fine_amount": null, "has_interest": true, "installment_history": [], "installment_key": "a07e171b-e2a6-49b4-9d6d-8124fff9d736", "installment_number": 27, "installment_payment": [], "installment_status": "created", "installment_type": "principal", "original_due_principal": 1695.68847194, "original_pre_fixed_amount": 35.61823023, "original_principal_amortization_amount": 154.38176977, "original_total_amount": 190.0, "paid_amount": 0.0, "paid_at": null, "post_fixed_amount": null, "pre_fixed_amount": 35.61823023, "principal_amortization_amount": 154.38176977, "qr_code_key": null, "qr_code_url": null, "renegotiation_proposal_key": null, "tax_amount": 4.62064637, "total_accrual_amount": null, "total_amount": 190.0, "total_paid_amount": 0.0, "workdays": 22 }, { "accrual_reference_date": null, "additional_costs": [], "advanced_paid_amount": 0.0, "bank_slip_key": null, "business_due_date": "2025-12-01", "calendar_days": 31, "digitable_line": null, "due_date": "2025-11-28", "due_interest": 0.0, "due_principal": 1541.30670217, "fine_amount": null, "has_interest": true, "installment_history": [], "installment_key": "0cd84cc5-0dd0-4318-99f9-178843d3d5b5", "installment_number": 28, "installment_payment": [], "installment_status": "created", "installment_type": "principal", "original_due_principal": 1541.30670217, "original_pre_fixed_amount": 33.46622796, "original_principal_amortization_amount": 156.53377204, "original_total_amount": 190.0, "paid_amount": 0.0, "paid_at": null, "post_fixed_amount": null, "pre_fixed_amount": 33.46622796, "principal_amortization_amount": 156.53377204, "qr_code_key": null, "qr_code_url": null, "renegotiation_proposal_key": null, "tax_amount": 4.6850558, "total_accrual_amount": null, "total_amount": 190.0, "total_paid_amount": 0.0, "workdays": 23 }, { "accrual_reference_date": null, "additional_costs": [], "advanced_paid_amount": 0.0, "bank_slip_key": null, "business_due_date": "2025-12-30", "calendar_days": 30, "digitable_line": null, "due_date": "2025-12-28", "due_interest": 0.0, "due_principal": 1384.77293013, "fine_amount": null, "has_interest": true, "installment_history": [], "installment_key": "24dc3c8b-ac3a-496e-8646-a1e66051090b", "installment_number": 29, "installment_payment": [], "installment_status": "created", "installment_type": "principal", "original_due_principal": 1384.77293013, "original_pre_fixed_amount": 29.08739451, "original_principal_amortization_amount": 160.91260549, "original_total_amount": 190.0, "paid_amount": 0.0, "paid_at": null, "post_fixed_amount": null, "pre_fixed_amount": 29.08739451, "principal_amortization_amount": 160.91260549, "qr_code_key": null, "qr_code_url": null, "renegotiation_proposal_key": null, "tax_amount": 4.81611428, "total_accrual_amount": null, "total_amount": 190.0, "total_paid_amount": 0.0, "workdays": 19 }, { "accrual_reference_date": null, "additional_costs": [], "advanced_paid_amount": 0.0, "bank_slip_key": null, "business_due_date": "2026-01-29", "calendar_days": 31, "digitable_line": null, "due_date": "2026-01-28", "due_interest": 0.0, "due_principal": 1223.86032464, "fine_amount": null, "has_interest": true, "installment_history": [], "installment_key": "bba128ee-b195-4a65-9caf-3ebe452d9d10", "installment_number": 30, "installment_payment": [], "installment_status": "created", "installment_type": "principal", "original_due_principal": 1223.86032464, "original_pre_fixed_amount": 26.57354762, "original_principal_amortization_amount": 163.42645238, "original_total_amount": 190.0, "paid_amount": 0.0, "paid_at": null, "post_fixed_amount": null, "pre_fixed_amount": 26.57354762, "principal_amortization_amount": 163.42645238, "qr_code_key": null, "qr_code_url": null, "renegotiation_proposal_key": null, "tax_amount": 4.89135372, "total_accrual_amount": null, "total_amount": 190.0, "total_paid_amount": 0.0, "workdays": 22 }, { "accrual_reference_date": null, "additional_costs": [], "advanced_paid_amount": 0.0, "bank_slip_key": null, "business_due_date": "2026-03-03", "calendar_days": 31, "digitable_line": null, "due_date": "2026-02-28", "due_interest": 0.0, "due_principal": 1060.43387227, "fine_amount": null, "has_interest": true, "installment_history": [], "installment_key": "35a03898-607a-4194-804c-bfd375c3ea45", "installment_number": 31, "installment_payment": [], "installment_status": "created", "installment_type": "principal", "original_due_principal": 1060.43387227, "original_pre_fixed_amount": 23.02508598, "original_principal_amortization_amount": 166.97491402, "original_total_amount": 190.0, "paid_amount": 0.0, "paid_at": null, "post_fixed_amount": null, "pre_fixed_amount": 23.02508598, "principal_amortization_amount": 166.97491402, "qr_code_key": null, "qr_code_url": null, "renegotiation_proposal_key": null, "tax_amount": 4.99755918, "total_accrual_amount": null, "total_amount": 190.0, "total_paid_amount": 0.0, "workdays": 20 }, { "accrual_reference_date": null, "additional_costs": [], "advanced_paid_amount": 0.0, "bank_slip_key": null, "business_due_date": "2026-03-31", "calendar_days": 28, "digitable_line": null, "due_date": "2026-03-28", "due_interest": 0.0, "due_principal": 893.45895824, "fine_amount": null, "has_interest": true, "installment_history": [], "installment_key": "0a8a83db-835d-46bc-8e24-c542c44d6e68", "installment_number": 32, "installment_payment": [], "installment_status": "created", "installment_type": "principal", "original_due_principal": 893.45895824, "original_pre_fixed_amount": 17.50393379, "original_principal_amortization_amount": 172.49606621, "original_total_amount": 190.0, "paid_amount": 0.0, "paid_at": null, "post_fixed_amount": null, "pre_fixed_amount": 17.50393379, "principal_amortization_amount": 172.49606621, "qr_code_key": null, "qr_code_url": null, "renegotiation_proposal_key": null, "tax_amount": 5.16280726, "total_accrual_amount": null, "total_amount": 190.0, "total_paid_amount": 0.0, "workdays": 20 }, { "accrual_reference_date": null, "additional_costs": [], "advanced_paid_amount": 0.0, "bank_slip_key": null, "business_due_date": "2026-04-29", "calendar_days": 31, "digitable_line": null, "due_date": "2026-04-28", "due_interest": 0.0, "due_principal": 720.96289203, "fine_amount": null, "has_interest": true, "installment_history": [], "installment_key": "07e3155c-30b5-4d13-8a31-0af4c7d5c9c5", "installment_number": 33, "installment_payment": [], "installment_status": "created", "installment_type": "principal", "original_due_principal": 720.96289203, "original_pre_fixed_amount": 15.65418772, "original_principal_amortization_amount": 174.34581228, "original_total_amount": 190.0, "paid_amount": 0.0, "paid_at": null, "post_fixed_amount": null, "pre_fixed_amount": 15.65418772, "principal_amortization_amount": 174.34581228, "qr_code_key": null, "qr_code_url": null, "renegotiation_proposal_key": null, "tax_amount": 5.21817016, "total_accrual_amount": null, "total_amount": 190.0, "total_paid_amount": 0.0, "workdays": 20 }, { "accrual_reference_date": null, "additional_costs": [], "advanced_paid_amount": 0.0, "bank_slip_key": null, "business_due_date": "2026-05-29", "calendar_days": 30, "digitable_line": null, "due_date": "2026-05-28", "due_interest": 0.0, "due_principal": 546.61707975, "fine_amount": null, "has_interest": true, "installment_history": [], "installment_key": "d1badc80-d7a2-4428-abf6-4877ac9f4497", "installment_number": 34, "installment_payment": [], "installment_status": "created", "installment_type": "principal", "original_due_principal": 546.61707975, "original_pre_fixed_amount": 11.48178326, "original_principal_amortization_amount": 178.51821674, "original_total_amount": 190.0, "paid_amount": 0.0, "paid_at": null, "post_fixed_amount": null, "pre_fixed_amount": 11.48178326, "principal_amortization_amount": 178.51821674, "qr_code_key": null, "qr_code_url": null, "renegotiation_proposal_key": null, "tax_amount": 5.34305023, "total_accrual_amount": null, "total_amount": 190.0, "total_paid_amount": 0.0, "workdays": 21 }, { "accrual_reference_date": null, "additional_costs": [], "advanced_paid_amount": 0.0, "bank_slip_key": null, "business_due_date": "2026-06-30", "calendar_days": 31, "digitable_line": null, "due_date": "2026-06-28", "due_interest": 0.0, "due_principal": 368.098863, "fine_amount": null, "has_interest": true, "installment_history": [], "installment_key": "4b466830-c432-4478-a1b9-bff6562834ee", "installment_number": 35, "installment_payment": [], "installment_status": "created", "installment_type": "principal", "original_due_principal": 368.098863, "original_pre_fixed_amount": 7.99248758, "original_principal_amortization_amount": 182.00751242, "original_total_amount": 190.0, "paid_amount": 0.0, "paid_at": null, "post_fixed_amount": null, "pre_fixed_amount": 7.99248758, "principal_amortization_amount": 182.00751242, "qr_code_key": null, "qr_code_url": null, "renegotiation_proposal_key": null, "tax_amount": 5.44748485, "total_accrual_amount": null, "total_amount": 190.0, "total_paid_amount": 0.0, "workdays": 20 }, { "accrual_reference_date": null, "additional_costs": [], "advanced_paid_amount": 0.0, "bank_slip_key": null, "business_due_date": "2026-07-29", "calendar_days": 30, "digitable_line": null, "due_date": "2026-07-28", "due_interest": 0.0, "due_principal": 186.09135058, "fine_amount": null, "has_interest": true, "installment_history": [], "installment_key": "0e8843ff-1339-40ab-a0b5-c450eca68e44", "installment_number": 36, "installment_payment": [], "installment_status": "created", "installment_type": "principal", "original_due_principal": 186.09135058, "original_pre_fixed_amount": 3.90887682, "original_principal_amortization_amount": 186.09112318, "original_total_amount": 190.0, "paid_amount": 0.0, "paid_at": null, "post_fixed_amount": null, "pre_fixed_amount": 3.90887682, "principal_amortization_amount": 186.09112318, "qr_code_key": null, "qr_code_url": null, "renegotiation_proposal_key": null, "tax_amount": 5.56970732, "total_accrual_amount": null, "total_amount": 190.0, "total_paid_amount": 0.0, "workdays": 22 } ], "iof_charge_method": "financed", "issue_amount": 4676.47, "net_external_contract_fee_amount": 0.0, "number_of_installments": 36, "prefixed_interest_rate": { "annual_rate": 0.28777498, "created_at": "2023-07-07T18:13:42", "daily_rate": 0.00069316, "interest_base": "calendar_days_365", "monthly_rate": 0.0213 }, "requester_identifier_key": "7d174b91-e411-4375-b788-9ced9b941cd0", "total_iof": 145.49, "total_pre_fixed_amount": 2163.53022742 }, "event_datetime": "2023-07-07 19:04:20", "key": "7d174b91-e411-4375-b788-9ced9b941cd0", "status": "waiting_signature", "webhook_type": "debt" } ``` STATUS 400 **Request Body** ```json { "data": "{\"title\": \"Bad Request\", \"description\": \"Invalid request body.\", \"translation\": \"Corpo da requisição inválido.\", \"extra_fields\": {}, \"code\": \"LEG000069\"}" } ``` --- # Seguro URL: /documentation/emissao_de_divida/seguro Na QI Tech disponibilizamos aos nossos clientes a possibilidade de oferecer seguro junto com a operação de crédito, aqui você entenderá como usá-lo em nossas API's e entender melhor sobre esse novo produto. :::caution Atenção Esse produto está disponível apenas para parceiros cadastrados, por favor consulte um de nossos comerciais para mais detalhes. ::: ## Como usar Para contratar ou simular uma dívida com a contratação de seguro, deverá ser adicionado a lista de rebates um rebate do tipo "insurance_premium_qi", sem nenhum valor declarado, pois ele será calculado de acordo com o valor de emissão da proposta e com o produto de seguro a ser contratado. :::caution Atenção Não é possível usar rebates do tipo tac ou **insurance_premium** junto com o **insurance_premium_qi**. ::: Objeto Rebate ```json { "rebates": [ { "fee_type": "insurance_premium_qi", "description": "insurance_premium_plus" } ] } ``` ## Simulação de dívida ### Request No exemplo abaixo, está descrita uma simulação de dívida, onde é pedido uma cotação de seguro. ENDPOINT /fgts_simulation MÉTODO POST Request Body ```json { "borrower": { "person_type": "natural", "individual_document_number": "46338864879", "birth_date": "1996-03-20" }, "financial": { "desired_installments": [ { "total_amount": 200, "due_date": "2023-10-01" } ], "interest_type": "pre_price_days", "disbursement_date": "2023-03-03", "fine_configuration": { "monthly_rate": 0, "interest_base": "calendar_days", "contract_fine_rate": 0 }, "monthly_interest_rate": 0.018, "credit_operation_type": "ccb", "interest_grace_period": 0, "number_of_installments": 1, "principal_grace_period": 0, "rebates": [ { "fee_type": "insurance_premium_qi", "description": "insurance_premium_plus" } ] } } ``` ### Response STATUS 200 Response Body ```json { "type": "debt", "key": "a445c71c-d752-4159-82bf-097d8125b66c", "status": "finished", "event_datetime": "2024-10-03 00:26:26", "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": "structured_operation", "post_fixed_interest_base": "workdays", "post_fixed_interest_rate": null, "prefixed_interest_rate": { "interest_base": "calendar_days_365", "annual_rate": 0.23872053, "monthly_rate": 0.018, "daily_rate": 0.00058669 }, "issue_date": "2023-03-03", "number_of_installments": 1, "requester_key": "9cdbe6f9-0e94-45a7-af5f-2cec36356493", "final_disbursement_amount": 119.01, "total_pre_fixed_amount": 23.3844066642, "iof_amount": 3.74, "cet": 0.0773, "annual_cet": 1.44428, "disbursement_date": "2023-03-03", "installments": [ { "calendar_days": 212, "workdays": 145.0, "business_due_date": "2023-10-02", "due_date": "2023-10-01", "due_principal": 176.62, "has_interest": true, "post_fixed_amount": null, "pre_fixed_amount": 23.3844066642, "tax_amount": 3.0702854745495474, "total_amount": 200, "principal_amortization_amount": 176.6155933358, "installment_number": 1 } ], "external_contract_fees": [ { "fee_type": "spread", "amount_type": "absolute", "amount": 0.0, "fee_amount": 0.0, "tax_amount": 0.0, "net_fee_amount": 0.0, "csll_amount": 0, "irrf_amount": 0, "pis_amount": 0, "cofins_amount": 0, "amount_released": 0, "description": null }, { "fee_type": "tac", "amount_type": "absolute", "amount": 0.0, "fee_amount": 0.0, "tax_amount": 0.0, "net_fee_amount": 0.0, "csll_amount": 0, "irrf_amount": 0, "pis_amount": 0, "cofins_amount": 0, "amount_released": 0, "description": null }, { "fee_type": "insurance_premium_qi", "description": "insurance_premium_plus", "amount_type": "percentage", "amount": 30.0, "fee_amount": 52.99, "tax_amount": 0.0, "net_fee_amount": 52.99, "csll_amount": 0, "irrf_amount": 0, "pis_amount": 0, "cofins_amount": 0, "amount_released": 52.99, "description": null } ], "contract_fee_amount": 0.88, "external_contract_fee_amount": 52.99, "net_external_contract_fee_amount": 52.99, "contract_fees": [ { "fee_type": "tac", "amount_type": "percentage", "amount": 0.5, "fee_amount": 0.88 } ], "issue_amount": 176.62, "disbursed_issue_amount": 119.01, "assignment_amount": 176.62, "disbursement_options": [ { "iof_amount": 3.74, "total_pre_fixed_amount": 23.3844066642, "cet": 0.0773, "annual_cet": 1.44428, "contract_fees": [ { "fee_type": "tac", "amount_type": "percentage", "amount": 0.5, "fee_amount": 0.88 } ], "external_contract_fees": [ { "fee_type": "spread", "amount_type": "absolute", "amount": 0.0, "fee_amount": 0.0, "tax_amount": 0.0, "net_fee_amount": 0.0, "csll_amount": 0, "irrf_amount": 0, "pis_amount": 0, "cofins_amount": 0, "amount_released": 0, "description": null }, { "fee_type": "tac", "amount_type": "absolute", "amount": 0.0, "fee_amount": 0.0, "tax_amount": 0.0, "net_fee_amount": 0.0, "csll_amount": 0, "irrf_amount": 0, "pis_amount": 0, "cofins_amount": 0, "amount_released": 0, "description": null }, { "fee_type": "insurance_premium_qi", "description": "insurance_premium_plus", "amount_type": "percentage", "amount": 30.0, "fee_amount": 52.99, "tax_amount": 0.0, "net_fee_amount": 52.99, "csll_amount": 0, "irrf_amount": 0, "pis_amount": 0, "cofins_amount": 0, "amount_released": 52.99, "description": null } ], "contract_fee_amount": 0.88, "external_contract_fee_amount": 52.99, "net_external_contract_fee_amount": 52.99, "disbursement_date": "2023-03-03", "first_due_date": "2023-10-01", "installments": [ { "calendar_days": 212, "workdays": 145.0, "business_due_date": "2023-10-02", "due_date": "2023-10-01", "due_principal": 176.62, "has_interest": true, "post_fixed_amount": null, "pre_fixed_amount": 23.3844066642, "tax_amount": 3.0702854745495474, "total_amount": 200, "principal_amortization_amount": 176.6155933358, "installment_number": 1 } ], "issue_amount": 176.62, "disbursed_issue_amount": 119.01, "assignment_amount": 176.62, "final_disbursement_amount": 119.01, "prefixed_interest_rate": { "interest_base": "calendar_days_365", "annual_rate": 0.23872053, "monthly_rate": 0.018, "daily_rate": 0.00058669 } } ] } } ``` :::danger AVISO É possível validar a elegibilidade da cobrança de seguro, já na simulação.\ Para isso, é obrigatório o envio da data de nascimento (**birth_date**), CPF do devedor (**document_number**) e o rebate "**insurance_premium_qi**".\ Se o CPF for elegível, teremos um retorno de sucesso, se não for elegível, a requisição de simulação retornará um erro. ::: :::danger AVISO O envio da data de nascimento (**birth_date**) **não é obrigatório na simulação com seguro**. Porém, na emissão de dívida temos a obrigatoriedade do envio desse campo, caso haja a contração do produto. ::: ## Consulta de elegibilidade de CPF para o seguro Em posse dos dados de **CPF**, é possível a consulta da elegibilidade do CPF. ### Request ENDPOINT /debts/borrower/[document_number]/insurance_premium_eligibility?birth_date=1994-06-11&issue_amount=150 METHOD GET ### Params | Campo | Descrição | |-------------------|-----------------------------------------| | `document_number` | Número de CPF do devedor | | `birth_date` | Data de nascimento | | `issue_amount` | Valor de emissão da operação de crédito | ### Response STATUS 200 Response Body ```json { "eligible": true } ``` ### Descrição | Campo | Tipo | |------------------------------|--------| | `elegible` | boleean | :::caution Atenção Para um CPF com o retorno **"elegible": false**, tanto a simulação, quanto a emissão da dívida não serão possíveis com o envio de insurance_premium_qi na lista **rebates**. ::: ## Criação de dívida Para criação de dívida com seguro é necessário alguns dados obrigatórios do tomador do crédito, como **endereço, telefone, email e data de nascimento**. Se alguns desses dados for omtido a dívida não será emitida. ### Request ENDPOINT /debt MÉTODO POST Request Body ```json { "borrower": { "person_type": "natural", "individual_document_number": "46338864879", "name": "PATRICIA APARECIDA DO NASCIMENTO PEREIRA DA SILVA", "is_pep": false, "mother_name": "HELENA DO NASCIMENTO PEREIRA DA SILVA", "email": "email@email.com", "birth_date": "1994-06-11", "phone": { "number": "900000000", "area_code": "11", "country_code": "055" }, "address": { "city": "São Paulo", "state": "SP", "number": "215", "street": "Gilberto Sabino", "complement": "s/c", "postal_code": "12345012", "neighborhood": "Pinheiros" } }, "financial": { "desired_installments": [ { "total_amount": 200, "due_date": "2023-10-01" } ], "interest_type": "pre_price_days", "disbursement_date": "2023-03-03", "fine_configuration": { "monthly_rate": 0, "interest_base": "calendar_days", "contract_fine_rate": 0 }, "monthly_interest_rate": 0.018, "credit_operation_type": "ccb", "interest_grace_period": 0, "number_of_installments": 1, "principal_grace_period": 0, "rebates": [ { "fee_type": "insurance_premium_qi", "description": "insurance_premium_plus" } ] }, "disbursement_bank_account": { "ispb_number": "18236120", "branch_number": "1", "account_number": "87823171", "account_digit": "0", "document_number": "46338864879", "name": "PATRICIA APARECIDA DO NASCIMENTO PEREIRA DA SILVA", "percentage_receivable": 1 }, "purchaser_document_number": "32402502000135" } ``` ### Response STATUS 201 Response Body ```json { "webhook_type": "debt", "key": "7a9bb512-7b38-4dbc-a109-1bc122b67a4a", "status": "waiting_signature", "event_datetime": "2023-03-03 18:06:18", "data": { "borrower": { "name": "PATRICIA APARECIDA DO NASCIMENTO PEREIRA DA SILVA", "document_number": "46338864879", "related_party_key": "1b98cff5-b1eb-4f3d-b337-716d76137770" }, "contract": { "number": "0000062201/PAD", "urls": [ "https://storage.googleapis.com/live-doc-api/documents/45e5b9c0-0f56-40a8-aace-d206f72c164d/QISCD-NOME_DO_DEVEDOR-CCB-0000000002-20230317183044.pdf" ], "external_contract_key": "35b882b1-9937-41d3-bf43-e0d30062dc1b", "signature_information": [ { "signer_name": "PATRICIA APARECIDA DO NASCIMENTO PEREIRA DA SILVA", "signer_document_number": "46338864879", "signer_role": "issuer", "signer_email": "email@email.com", "signer_external_key": "3a50f3cd-8178-49c8-9fc2-984b4caa4a5b", "signature_url": "https://sandbox.sign.qitech.com.br/s/ml9Myfp" } ] }, "requester_identifier_key": "7a9bb512-7b38-4dbc-a109-1bc122b67a4a", "iof_charge_method": "financed", "collaterals": [], "contract_fees": [], "external_contract_fees": [ { "fee_type": "insurance_premium_qi", "description": "insurance_premium_plus", "fee_amount": 52.99, "tax_amount": 0, "net_fee_amount": 52.99 } ], "external_contract_fee_amount": 52.99, "net_external_contract_fee_amount": 52.99, "contract_fee_amount": 0, "issue_amount": 176.62, "assignment_amount": 176.62, "cet": "7,6200%", "annual_cet": "141,3472%", "number_of_installments": 1, "base_iof": 3.0702854745495474, "additional_iof": 0.671156, "total_iof": 3.74, "prefixed_interest_rate": { "annual_rate": 0.23872053, "created_at": "2024-09-11T18:06:07", "daily_rate": 0.00058669, "interest_base": "calendar_days_365", "monthly_rate": 0.018 }, "installments": [ { "accrual_reference_date": null, "additional_costs": [], "advanced_paid_amount": 0, "bank_slip_key": null, "business_due_date": "2023-10-02", "calendar_days": 212, "digitable_line": null, "due_date": "2023-10-01", "due_interest": 0, "due_principal": 176.62, "fine_amount": null, "has_interest": true, "installment_history": [], "installment_key": "6087c6c1-d665-4ba8-bfb2-b447cd57d3e3", "installment_number": 1, "installment_payment": [], "installment_status": "created", "installment_type": "principal", "original_due_principal": 176.62, "original_pre_fixed_amount": 23.3844066642, "original_principal_amortization_amount": 176.6155933358, "original_total_amount": 200, "paid_amount": 0, "paid_at": null, "post_fixed_amount": null, "pre_fixed_amount": 23.3844066642, "principal_amortization_amount": 176.6155933358, "qr_code_key": null, "qr_code_url": null, "renegotiation_proposal_key": null, "tax_amount": 3.0702854745495474, "total_accrual_amount": null, "total_amount": 200, "total_paid_amount": 0, "workdays": 145 } ], "total_pre_fixed_amount": 23.3844066642 } } ``` ## Webhooks ### Seguro emitido A emissão do seguro será feito após o desembolso da operação, o seguinte webhook será enviado quando o seguro terminar de ser emitido com os dados do seguro. :::caution Atenção Ao receber o webhook de bilhete emitido é obrigatório a transmissão do documento do bilhete gerado para o tomador de crédito. ::: Webhook Body ```json { "data": { "credit_operation_key": "5ae2c008-44c1-4435-bbfa-094a4b11d962", "insurance_policy_document_key": "9990ce22-aeac-4728-82da-d1f22c33873f", "insurance_date": "2024-09-11", "term_start_date": "2024-09-11", "term_end_date": "2025-09-11", "insurance_amount": 1600, "operation_amount": 6400, "covers": [ { "cover_amount": 200, "cover_type": "permanent_disability", "cover_prize_amount": 572.82 }, { "cover_amount": 100, "cover_type": "accidental_death", "cover_prize_amount": 572.82 }, { "capitalcover_amount_segurado": 300, "cover_type": "unemployment", "cover_prize_amount": 572.82 } ], "policy_number": "1098200000008", "prize_number": "3907", "insurance_premium_net_amount": 1145.63, "iof_amount": 4.37 }, "event_datetime": "2023-03-03 22:39:39", "key": "dc575950-dcce-48e1-99a6-5fb0ada63d86", "status": "active", "webhook_type": "insurance_premium.status_change" } ``` ### Seguro cancelado O seguro pode ser cancelado quando o tomador do crédito queira desistir de operação de créditoe a operação for revertida, se algum limite de cobertura for ultrapassado (tornando inelegível a contratação do seguro) ou quando tomador acaba desistindo somente do seguro. :::caution Atenção O bilhete de seguro só pode ser cancelado totalmente dentro de 7 dias corridos do desembolso da operação de crédito, caso queira cancelar após isso o valor devolvido vai ser proporcional a duração do seguro. ::: Webhook Body ```json { "key": "dc575950-dcce-48e1-99a6-5fb0ada63d86", "data": { "cancel_reason": "reversed_operation", "credit_operation_key": "2fbd6613-3228-5gdg-9377-93db394bf2d4" }, "status": "canceled", "webhook_type": "insurance_premium.status_change", "event_datetime": "2023-03-03 22:39:39" } ``` ### Motivos de cancelamento | cancel_reason | Descrição | |-------------------------------|----------------------------------------| | `reversed_operation` | Operação revertida e seguro cancelados | | `cover_limit_amount_exceeded` | Somente o seguro foi cancelado. Algum limite de cobertura foi ultrapassado e não foi possível a emissão do seguro | | `insurance_premium_cancel` | Somente o seguro foi cancelado. Cancelamento do tomador direto com a seguradora | ## Consulta do seguro ### Request ENDPOINT /debt/[debt_key]/insurance_premiums METHOD GET ### Response STATUS 200 Response Body ```json { "data": [ { "insurance_premium_key": "e4fe84e3-cc71-481b-87ea-8a07f7d69079", "status": "active", "credit_operation_key": "5ae2c008-44c1-4435-bbfa-094a4b11d962", "disbursement_key": "bd0ea133-ff47-4a21-a3e6-24186e5e2fc1", "contract_number": "4069550961/QIT", "requester_key": "1040ce22-aeac-4728-82da-d1f22c33873f", "insurance_policy_document_key": "9990ce22-aeac-4728-82da-d1f22c33873f", "insurance_date": "2024-09-11", "term_start_date": "2024-09-11", "term_end_date": "2025-09-11", "insurance_amount": 1600, "operation_amount": 6400, "customer": { "customer_key": "cd587fa8-3abd-4023-99ab-957df60933a5", "document_number": "08556878350", "name": "Wilker Oliveiraço", "birth_date": "1998-03-21", "email": "urich.oliveira@yopmail.com", "phone": { "country_code": "55", "area_code": "11", "number": "966931427" }, "address": { "postal_code": "56821686", "state": "CE", "city": "Ceará", "neighborhood": "Marmiteiros", "street": "Conjunto João Gabriel da Mata", "number": "95", "complement": "" } }, "covers": [ { "cover_amount": 200, "cover_type": "permanent_disability", "cover_prize_amount": 572.82 }, { "cover_amount": 100, "cover_type": "accidental_death", "cover_prize_amount": 572.82 }, { "cover_amount": 300, "cover_type": "unemployment", "cover_prize_amount": 572.82 } ], "policy_number": "1098200000008", "prize_number": "3907", "insurance_premium_net_amount": 1145.63, "iof_amount": 4.37 } ], "pagination": { "current_page": 0, "next_page": 0, "rows_per_page": 1 } } ``` ### Request ENDPOINT /debt/[DEBT-KEY]/insurance_premium/[INSURANCE-PREMIUM-KEY] METHOD GET ### Response STATUS 200 Response Body ```json { "insurance_premium_key": "e4fe84e3-cc71-481b-87ea-8a07f7d69079", "status": "active", "credit_operation_key": "5ae2c008-44c1-4435-bbfa-094a4b11d962", "disbursement_key": "bd0ea133-ff47-4a21-a3e6-24186e5e2fc1", "contract_number": "4069550961/QIT", "requester_key": "1040ce22-aeac-4728-82da-d1f22c33873f", "insurance_policy_document_key": "9990ce22-aeac-4728-82da-d1f22c33873f", "insurance_date": "2024-09-11", "term_start_date": "2024-09-11", "term_end_date": "2025-09-11", "insurance_amount": 1600, "operation_amount": 6400, "customer": { "customer_key": "cd587fa8-3abd-4023-99ab-957df60933a5", "document_number": "08556878350", "name": "Wilker Oliveiraço", "birth_date": "1998-03-21", "gender": "male", "email": "urich.oliveira@yopmail.com", "phone": { "country_code": "55", "area_code": "11", "number": "966931427" }, "address": { "postal_code": "56821686", "state": "CE", "city": "Ceará", "neighborhood": "Marmiteiros", "street": "Conjunto João Gabriel da Mata", "number": "95", "complement": "" } }, "covers": [ { "cover_amount": 300, "cover_type": "permanent_disability", "cover_prize_amount": 572.82 }, { "cover_amount": 300, "cover_type": "accidental_death", "cover_prize_amount": 572.82 }, { "cover_amount": 300, "cover_type": "unemployment", "cover_prize_amount": 572.82 } ], "policy_number": "1098200000008", "prize_number": "3907", "insurance_premium_net_amount": 1145.63, "iof_amount": 4.37 } ``` ## Consulta do documento bilhete :::caution Atenção O link do documento é expirável e tem uma duração de 15 minutos. ::: ### Request ENDPOINT /document/[DOCUMENT-KEY]/url METHOD GET ### Response STATUS 200 Response Body ```json { "document_key": "a11dc0fe-51ed-41aa-bb40-bca80d6e515b", "signed_document_url": null, "document_url": "https://storage.googleapis.com/dev-doc-api-private/documents/a11dc0fe-51ed-41aa-bb40-bca80d6e515b/TESTEELECTRONIC2.pdf?Expires=1726081733&GoogleAccessId=doc-api-signed-url-service-acc%40qicredit-dev.iam.gserviceaccount.com&Signature=CNY8ch%2BQ2FuLXrbRZGLhH41A7SkNJRUUq%2FJoegTIMeXEiNImD%2FkPoEHyNtOXWUUR8JtEL6ppT0s1tXA9oFfLjzOtvzMOfpal0TwJDLSsX9r4HxcxvzFZUJELAn9yIAcRhqR%2BnzUn0WYyQA%2B0hAalz%2Bj274pXhIExqJJR4LiDUAkzRE3WD0GOvsV7afAoqQ8P3Xxj4mvOM3P%2BuFhgP6hcJmq0K%2B5qHssF3DtvpQFLcLaQ7T45YoQDCnDFGztD0Un0%2BNBwv4n2142rV3rMu9h3DzLmQbEjaeYgHb4wq2kOfyfEUSbaU683d6hA7CNyrPWMeoi%2F%2BgTfFFadbcGCMGX2%2BQ%3D%3D", "expiration_datetime": "2023-03-03T19:08:53.000Z" } ``` --- # Simulação de dívida antigo URL: /documentation/emissao_de_divida/simulacao_de_divida_antigo Na QI Tech disponibilizamos aos nossos clientes a possibilidade de simular os valores uma operação de crédito antes da sua emissão de fato. A simulação segue o mesmo padrão da solicitação de emissão de dívida, porém não é necessário informar os dados cadastrais e de conta de desembolso do devedor. ## Request No exemplo abaixo, esta descrita uma solicitação de simulação de dívida. ENDPOINT /debt_simulation MÉTODO POST Request Body **Data de vencimento e valor da parcela** ```json { "borrower": { "person_type": "natural" }, "financial": { "desired_installments": [ { "total_amount": 578.69, "due_date": "2027-04-01" }, { "total_amount": 304.25, "due_date": "2028-04-01" } ], "interest_type": "pre_price_days", "disbursement_date": "2026-09-06", "fine_configuration": { "monthly_rate": 0.0, "interest_base": "calendar_days", "contract_fine_rate": 0.0 }, "annual_interest_rate": 0.2387205, "credit_operation_type": "ccb", "interest_grace_period": 0, "number_of_installments": 2, "principal_grace_period": 0, "rebates": [ { "amount": 10, "fee_type": "tac", "amount_type": "absolute", "rebate_bank_account": { "name": "CONTA BANCARIA", "bank_code": "329", "account_digit": "1", "branch_number": "0001", "account_number": "00003", "document_number": "32402502000135" } } ] } } ``` **Taxa e data de parcela** ```json { "borrower": { "person_type": "natural" }, "financial": { "interest_type": "pre_price_days", "disbursement_start_date": "2025-09-03", "disbursement_end_date": "2025-09-03", "issue_date": "2025-09-03", "fine_configuration": { "monthly_rate": 0, "contract_fine_rate": 0, "interest_base": "calendar_days" }, "monthly_interest_rate": 0.1929244498, "disbursed_amount": 10000.00, "credit_operation_type": "ccb", "interest_grace_period": 0, "number_of_installments": 18, "principal_grace_period": 0, "due_dates": [ "2025-09-28", "2025-10-28", "2025-11-28", "2025-12-28", "2026-01-28", "2026-02-28", "2026-03-28", "2026-04-28", "2026-05-28", "2026-06-28", "2026-07-28", "2026-08-28", "2026-09-28", "2026-10-28", "2026-11-28", "2026-12-28", "2027-01-28", "2027-02-28" ] } } ``` ## Response STATUS 200 Response Body ```json { "type": "debt", "key": "bf84379c-d4cf-4f16-a63c-865c129e6fce", "status": "finished", "event_datetime": "2025-03-27 22:28:37", "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": "structured_operation", "post_fixed_interest_base": "workdays", "post_fixed_interest_rate": null, "prefixed_interest_rate": { "interest_base": "calendar_days_365", "annual_rate": 0.23872053, "monthly_rate": 0.0179999999, "daily_rate": 0.0005866899 }, "issue_date": "2026-09-06", "number_of_installments": 2, "requester_key": "f2b3b903-aa41-4a79-8b2f-abc3cc5a6590", "final_disbursement_amount": 701.6, "total_pre_fixed_amount": 153.0, "iof_amount": 18.34, "cet": 0.0219, "annual_cet": 0.297, "disbursement_date": "2026-09-06", "installments": [ { "calendar_days": 207, "workdays": 140, "business_due_date": "2027-04-01", "due_date": "2027-04-01", "due_principal": 729.94, "has_interest": true, "post_fixed_amount": 0, "pre_fixed_amount": 94.22564648, "tax_amount": 8.22329794, "total_amount": 578.69, "principal_amortization_amount": 484.46435352, "installment_number": 1 }, { "calendar_days": 366, "workdays": 253, "business_due_date": "2028-04-03", "due_date": "2028-04-01", "due_principal": 245.47564648, "has_interest": true, "post_fixed_amount": 0, "pre_fixed_amount": 58.77435352, "tax_amount": 7.3470861, "total_amount": 304.25, "principal_amortization_amount": 245.47564648, "installment_number": 2 } ], "external_contract_fees": [ { "fee_type": "tac", "amount_type": "absolute", "amount": 10.0, "fee_amount": 10.0, "tax_amount": 1.42, "net_fee_amount": 8.58, "csll_amount": 0, "irrf_amount": 0, "pis_amount": 0, "cofins_amount": 0, "amount_released": 8.58, "description": null }, { "fee_type": "spread_tax_free", "amount_type": "absolute", "amount": 0.0, "fee_amount": 0.0, "tax_amount": 0.0, "net_fee_amount": 0.0, "csll_amount": 0, "irrf_amount": 0, "pis_amount": 0, "cofins_amount": 0, "amount_released": 0, "description": null }, { "fee_type": "tac_tax_free", "amount_type": "absolute", "amount": 0.0, "fee_amount": 0.0, "tax_amount": 0.0, "net_fee_amount": 0.0, "csll_amount": 0, "irrf_amount": 0, "pis_amount": 0, "cofins_amount": 0, "amount_released": 0, "description": null }, { "fee_type": "insurance_premium", "amount_type": "absolute", "amount": 0.0, "fee_amount": 0.0, "tax_amount": 0.0, "net_fee_amount": 0.0, "csll_amount": 0, "irrf_amount": 0, "pis_amount": 0, "cofins_amount": 0, "amount_released": 0, "description": null } ], "contract_fee_amount": 3.65, "external_contract_fee_amount": 10.0, "net_external_contract_fee_amount": 8.58, "contract_fees": [ { "fee_type": "spread", "amount_type": "percentage", "amount": 0.5, "fee_amount": 3.65 }, { "fee_type": "spread_ted_fee", "amount_type": "absolute", "amount": 3.0, "fee_amount": 3.0 } ], "issue_amount": 729.94, "disbursed_issue_amount": 701.6, "assignment_amount": 736.59, "disbursement_options": [ { "iof_amount": 18.34, "total_pre_fixed_amount": 153.0, "cet": 0.0219, "annual_cet": 0.297, "contract_fees": [ { "fee_type": "spread", "amount_type": "percentage", "amount": 0.5, "fee_amount": 3.65 }, { "fee_type": "spread_ted_fee", "amount_type": "absolute", "amount": 3.0, "fee_amount": 3.0 } ], "external_contract_fees": [ { "fee_type": "tac", "amount_type": "absolute", "amount": 10.0, "fee_amount": 10.0, "tax_amount": 1.42, "net_fee_amount": 8.58, "csll_amount": 0.0, "irrf_amount": 0.0, "pis_amount": 0.0, "cofins_amount": 0.0, "amount_released": 8.58, "description": null }, { "fee_type": "spread_tax_free", "amount_type": "absolute", "amount": 0.0, "fee_amount": 0.0, "tax_amount": 0.0, "net_fee_amount": 0.0, "csll_amount": 0, "irrf_amount": 0, "pis_amount": 0, "cofins_amount": 0, "amount_released": 0.0, "description": null }, { "fee_type": "tac_tax_free", "amount_type": "absolute", "amount": 0.0, "fee_amount": 0.0, "tax_amount": 0.0, "net_fee_amount": 0.0, "csll_amount": 0, "irrf_amount": 0, "pis_amount": 0, "cofins_amount": 0, "amount_released": 0.0, "description": null }, { "fee_type": "insurance_premium", "amount_type": "absolute", "amount": 0.0, "fee_amount": 0.0, "tax_amount": 0.0, "net_fee_amount": 0.0, "csll_amount": 0, "irrf_amount": 0, "pis_amount": 0, "cofins_amount": 0, "amount_released": 0.0, "description": null } ], "contract_fee_amount": 3.65, "external_contract_fee_amount": 10.0, "net_external_contract_fee_amount": 8.58, "disbursement_date": "2026-09-06", "first_due_date": "2027-04-01", "installments": [ { "calendar_days": 207, "workdays": 140, "business_due_date": "2027-04-01", "due_date": "2027-04-01", "due_principal": 729.94, "has_interest": true, "post_fixed_amount": 0, "pre_fixed_amount": 94.22564648, "tax_amount": 8.22329794, "total_amount": 578.69, "principal_amortization_amount": 484.46435352, "installment_number": 1 }, { "calendar_days": 366, "workdays": 253, "business_due_date": "2028-04-03", "due_date": "2028-04-01", "due_principal": 245.47564648, "has_interest": true, "post_fixed_amount": 0, "pre_fixed_amount": 58.77435352, "tax_amount": 7.3470861, "total_amount": 304.25, "principal_amortization_amount": 245.47564648, "installment_number": 2 } ], "issue_amount": 729.94, "disbursed_issue_amount": 701.6, "assignment_amount": 736.59, "final_disbursement_amount": 701.6, "prefixed_interest_rate": { "interest_base": "calendar_days_365", "annual_rate": 0.23872053, "monthly_rate": 0.0179999999, "daily_rate": 0.0005866899 } } ] } } ``` ## Definições ### Request Body ### Objeto Borrower | Campo | Tipo | Descrição | Enum | |---|---|---|---| | **person_type** | object | Natureza Jurídica do devedor da operação | natural ou legal | ### Objeto Financial | Campo | Tipo | Descrição | Máx. Caract. | |---|--- |---|---| | **amout** | float | Valor de emissão/nominal da operação de crédito | - | | **interest_type** | object | **[Enumerador Interest Type](#enumerador-interest-type)** - Método de amortização e forma de cálculo de juros | - | | **credit_operation_type** | object | **[Enumerador Credit Operation Type](#enumerador-credit-operation-type)** - Tipo do contrato de crédito | - | | **annual_interest_rate** | float | Taxa de juros pré-fixada expressa em decimal ao ano | - | | **disbursement_date** | date | Data do desembolso da operação | - | | **interest_grace_period** | int | Carência de juros (em meses) | - | | **principal_grace_period** | int | Período carência de principal | - | | **number_of_installments** | int | Número de parcelas da operação de crédito | - | | **fine_configuration** | object | **[Objeto fine_configuration](#objeto-fine-configuration)** - Configuração de juros e multa por atraso | - | ### Objeto Fine Configuration | Campo | Tipo | Descrição | Máx. Caract. | |---|---|---|---| | **contract_fine_rate** | float | Percentual de multa por atraso expresso em decimal | - | | **interest_base** | enum | **[Enumerador Interest Base](#enumerador-interest-base)** - Base de cálculo de juros | - | | **monthly_rate** | float | Percentual de juros de atraso ao mês expresso em decimal | - | ### Response Body | Campo | Tipo | Descrição | Máx. Caract. | |----------------------------|--------|---------------------------------|--------------| | **data.data** | object | **[Objeto Data](#objeto-data)** | - | | **data.event_datetime** | date | Momento da geração da simulação | - | | **data.key** | string | Chave única da simulação | - | | **data.status** | string | _finished_ | - | | **data.type** | string | _debt_ | - | ### Objeto Data | Campo | Tipo | Descrição | Máx. Caract. | |-----------------------------------------|--------|-------------------------------------------------------------------------------------------------------------------------------|--------------| | **annual_cet** | float | Custo efetivo total expresso em decimal ao ano | - | | **assignment_amount** | float | Valor de aquisição da operação de crédito | - | | **cet** | float | Custo efetivo total expresso em decimal ao mês | - | | **contract_fee_amount** | float | Fee da QI Tech cobrado na operação | - | | **contract_fees** | object | **[Objeto Contract Fees](#objeto-contract-fees)** - Lista de Fee's da QI Tech cobrados na operação | - | | **credit_operation_type** | enum | **[Enumerador Credit Operation Type](#enumerador-credit-operation-type)** - Tipo do contrato de crédito | - | | **disbursed_issue_amount** | float | Valor desembolsado na operação de crédito | - | | **disbursement_date** | date | Data do desembolso da operação | - | | **disbursement_options** | list | Lista de opções de desembolso da operação (os valores financeiros da operação podem variar de acordo com o dia do desembolso) | - | | **external_contract_fee_amount** | float | Valor do Fee cobrado na operação rebatido pela QI ao parceiro | - | | **external_contract_fees** | list | **[Objeto Contract Fees](#objeto-contract-fees)** - Lista de Fee's cobrados na operação rebatidos pela QI ao parceiro | - | | **final_disbursement_amount** | float | Valor efetivamente desembolsado para o devedor | - | | **installments** | list | **[Objeto Installments](#objeto-installments)** - Parcelas da operação | - | | **interest_grace_period** | int | Carência de juros (em meses) | - | | **interest_payment_month_period** | int | Frequência da cobrança de juros nas parcelas (em meses) | - | | **interest_type** | enum | **[Enumerador Interest Type](#enumerador-interest-type)** - Método de amortização e forma de cálculo de juros | - | | **iof_amount** | float | Valor total do IOF (composto pela soma do IOF Base e IOF Total) | - | | **issue_amount** | float | Valor de emissão/nominal da operação de crédito | - | | **issue_date** | date | Data da emissão do cotrato da operação | - | | **net_external_contract_fee_amount** | float | Valor líquido do Fee cobrado na operação rebatido pela QI ao parceiro | - | | **operation_type** | enum | **[Enumerador Operation Type](#enumerador-operation-type)** | - | | **post_fixed_interest_base** | enum | **[Enumerador Interest Base](#enumerador-interest-base)** - Base de cálculo de juros | - | | **post_fixed_interest_rate** | object | **[Objeto Interest Rate](#objeto-interest-rate)** - Indexador de juros pós-fixados do contrato | - | | **prefixed_interest_rate** | object | **[Objeto Interest Rate](#objeto-interest-rate)** - Taxa de juros Nominal pré-fixada do contrato | - | | **principal_amortization_month_period** | int | Frequência da cobrança de principal nas parcelas (em meses) | - | | **principal_grace_period** | int | Período carência de principal (em meses) | - | | **requester_key** | string | Chave única identificadora do parceiro dentro da QI. | - | | **total_pre_fixed_amount** | float | Total de juros pago pelo devedor na operação de crédito | - | ### Objeto Contract Fees | Campo | Tipo | Descrição | Máx. Caract. | |-----------------|-------|-----------------------------------------------------------------------------------------------------|--------------| | **amount** | float | Valor do Fee (em percentual ou valor absoluto, a depender do valor informado no campo _amount_type_ | - | | **amount_type** | enum | **[Enumeradores amount_type](#enumerador-amount-type)** - Unidade do valor do Fee | - | | **fee_amount** | float | Valor absoluto do Fee cobrado na operação | - | | **fee_type** | enum | **[Enumerador Fee Type](#enumerador-fee-type)** - Tipo do Fee cobrado na operação | - | ### Objeto Installments | Campo | Tipo | Descrição | Máx. Caract. | |-----------------------------------|---------|--------------------------------------------------------------------------------|--------------| | **business_due_date** | date | Data do vencimento em dia útil da parcela | - | | **calendar_days** | int | Quantos dias corridos entre uma parcela e outra | - | | **due_date** | date | Data do vencimento em dia corrido da parcela | - | | **due_principal** | float | Principal remanescente na data de vencimento da parcela antes de seu pagamento | - | | **has_interest** | boolean | _true_ - Indicador de incidência de juros na parcela | - | | **installment_number** | int | Número da parcela | - | | **post_fixed_amount** | float | Valor de juros pós-fixado pago na parcela | - | | **pre_fixed_amount** | float | Valor de juros pré-fixado pago na parcela | - | | **principal_amortization_amount** | float | Valor de amortização pago na parcela | - | | **tax_amount** | float | IOF Base da parcela | - | | **total_amount** | float | Valor total da parcela | - | | **workdays** | int | Quantos dias úteis entre uma parcela e outra | - | ### Objeto Interest Rate | Campo | Descrição | Máx. Caract. | |-------------------|---------------------------------------------------------------------------------------|--------------| | **annual_rate** | Taxa de juros pré/pós expressa em decimal ao ano | - | | **daily_rate** | Taxa de juros pré/pós expressa em decimal ao dia | - | | **interest_base** | **[Enumerador Interest Base](#enumerador-interest-base)** - Base de cálculo de juros | - | | **monthly_rate** | Taxa de juros pré/pós expressa em decimal ao mês | - | # Enumeradores ### Enumerador _Person Type_ | Enumerador | Descrição | |------------------------|-----------------------| | **legal** | Pessoa juridica | | **natural** | Pesso física | ### Enumerador _Account Type_ | Enumerador | Descrição | |------------------------|-----------------------| | **checking_account** | Conta corrente | | **deposit_account** | Conta de depósito | | **guaranteed_account** | Conta de garantia | | **investment_account** | Conta de investimento | | **payment_account** | Conta de pagamento | | **saving_account** | Conta poupança | | **salary_account** | Conta salário | ### Enumerador _Amount Type_ | Enumerador | Descrição | |------------------------|-----------------------| | **absolute** | Valor absoluto | | **percentage** | Valor percentual | ### Enumerador _Interest Type_ | Enumerador | Descrição | |----------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | **pre_price_days** | Método de amortização Price (parcelas iguais) com cálculo do juros pré-fixado ao dia | | **pre_price** | Método de amortização Price (parcelas iguais) com cálculo do juros pré-fixado em períodos fixos (30 dias) | | **pre_sac** | Método de amortização SAC (amortização constante) com cálculo do juros pré-fixado ao dia | | **post_sac** | Método de amortização SAC (amortização constante) com cálculo do juros baseado em uma taxa pré-fixada + indexador pós-fixado (cdi, ipca ou igpm) ao dia | | **post_price** | Método de amortização Price (parcelas iguais) com cálculo do juros baseado em uma taxa pré-fixada + indexador pós-fixado (cdi, ipca ou igpm) em períodos fixos (30 dias) | | **post_price_days** | Método de amortização Price (parcelas iguais) com cálculo do juros baseado em uma taxa pré-fixada + indexador pós-fixado (cdi, ipca ou igpm) ao dia | ### Enumerador _Credit Operation Type_ | Enumerador | Descrição | |---------------|--------------------------------| | **ccb** | Cédula de Crédito Bancário | | **cce** | Cédula de Crédito à Exportação | | **cci** | Cédula de Crédito Imobiliário | | **nce** | Nota de Crédito à Exportação | ### Enumerador _Interest Base_ | Enumerador | Descrição | |-----------------------|---------------------------------------------------------------------------| | **workdays** | Base de cálculo de juros em dias úteis considerando um ano de 252 dias | | **calendar_days** | Base de cálculo de juros em dias corridos considerando um ano de 360 dias | | **calendar_days_365** | Base de cálculo de juros em dias corridos considerando um ano de 365 dias | ### Enumerador _Fee Type_ Cada tipo de fee deve ser previamente habilitado e configurado pela QI Tech | Enumerador | Descrição | |-----------------------|----------------------------------------------------------------------------| | **tac** | Tarifa de abertura de cadastro | | **spread** | Ágio cobrado no valor de aquisição da operação de crédito | | **warranty_analysis** | Tarifa de análise de garantias | | **ted_fee** | Tarifa de TED | | **spread_ted_fee** | Ágio da tarifa de TED cobrado no valor de aquisição da operação de crédito | --- # Simulação de dívida novo URL: /documentation/emissao_de_divida/simulacao_de_divida_novo Na QI Tech disponibilizamos aos nossos clientes a possibilidade de simular os valores uma operação de crédito antes da sua emissão de fato. A simulação segue o mesmo padrão da solicitação de emissão de dívida, porém não é necessário informar os dados cadastrais e de conta de desembolso do devedor. ## Request No exemplo abaixo, esta descrita uma solicitação de simulação de dívida. ENDPOINT /v2/credit_operation/simulation MÉTODO POST Request Body **Data de vencimento e valor da parcela** ```json { "credit_operation_type": "ccb", "disbursed_issue_amount": 2800, "disbursement_date": "2025-09-24", "first_due_date": "2025-10-24", "force_installments_on_workdays": true, "interest_type": "pre_price_days", "issuer_person_type": "natural", "monthly_interest_rate": 0.04488, "number_of_installments": 12, "principal_amortization_month_period": 1 } ``` **Valor desembolsado e parcelas** ```json { "credit_operation_type": "ccb", "disbursed_issue_amount": 460, "disbursement_date": "2025-09-24", "first_due_date": "2025-10-24", "force_installments_on_workdays": true, "interest_type": "pre_price_days", "issuer_person_type": "natural", "number_of_installments": 3, "principal_amortization_month_period": 1, "interest_base": "calendar_days_365", "installments": [ { "due_date": "2026-02-26", "amount": 137.48 }, { "due_date": "2026-03-26", "amount": 180.56 }, { "due_date": "2026-04-27", "amount": 180.56 } ] } ``` ## Response STATUS 200 Response Body ```json { "additional_iof": 0.14, "annual_cet": 145.08, "assignment_amount": 36.21, "base_iof": 0.1, "cet": 7.76, "disbursed_amount": 35.9, "disbursement_date": "2024-09-06", "fees": [ { "amount": 0.0, "fee_amount": 0.0, "amount_type": "absolute", "fee_type": "tac", "type": "external" }, { "amount": 0.0, "fee_amount": 0.0, "amount_type": "absolute", "fee_type": "spread", "type": "external" }, { "amount": 0.2, "fee_amount": 0.07, "amount_type": "percentage", "fee_type": "spread", "type": "internal" } ], "first_due_date": "2024-09-25", "installments": [ { "due_date": "2024-09-25", "amount": 19.5, "due_principal": 36.14, "due_interest": 0.0, "has_interest": true, "period": 0.6129032258064516, "period_workdays": 0.6190476190476191, "calendar_days": 19, "workdays": 13, "installment_number": 1, "period_to_disbursement": 0.6129032258064516, "prefixed_amount": 1.58227236, "period_workdays_to_disbursement": 1.0, "calendar_days_to_disbursement": 19, "workdays_to_disbursement": 13, "tax_amount": 0.02791582, "principal_amortization_amount": 17.91772764 }, { "due_date": "2024-10-25", "amount": 19.5, "due_principal": 18.22227236, "due_interest": 0.0, "has_interest": true, "period": 1.0, "period_workdays": 1.0, "calendar_days": 30, "workdays": 22, "installment_number": 2, "period_to_disbursement": 1.6129032258064515, "prefixed_amount": 1.27772764, "period_workdays_to_disbursement": 2.0, "calendar_days_to_disbursement": 49, "workdays_to_disbursement": 35, "tax_amount": 0.07321709, "principal_amortization_amount": 18.22227236 } ], "interest_type": "pre_price_days", "issue_amount": 36.14, "prefixed_interest_rate": { "interest_base": "calendar_days", "annual_rate": 1.25219159, "daily_rate": 0.00225783, "monthly_rate": 0.07 }, "tax_configuration": { "additional_rate": 0.0038, "base_rate": 0.000082 }, "total_iof": 0.24 } ``` ## Definições ### Request Body ### Payload | Campo | Tipo | Descrição | Máx. Caract. | |---|--- |---|---| | **credit_operation_type** | enum | **[Enumerador Credit Operation Type](#enumerador-credit-operation-type)** - Tipo do contrato de crédito | - | | **disbursed_issue_amount** | float | Valor de emissão/nominal da operação de crédito | - | | **disbursement_date** | date | Data do desembolso da operação | - | | **first_due_date** | date | Data de vencimento da primeira parcela | - | | **force_installments_on_workdays** | boolean | _true_ - Indicador de parcelas agendadas em dias úteis | - | | **interest_type** | enum | **[Enumerador Interest Type](#enumerador-interest-type)** - Método de amortização e forma de cálculo de juros | - | | **issuer_person_type** | enum | **[Enumerador Person Type](#enumerador-person-type)** | - | | **monthly_interest_rate** | float | Taxa de juros mensal pré-fixada do contrato | - | | **number_of_installments** | int | Número de parcelas da operação de crédito | - | | **principal_amortization_month_period** | int | Quantidade de meses de amortização do principal | - | | **installments** | list | **[Objeto Installments](#objeto-installments)** - Parcelas da operação | - | ### Response Body ### Payload | Campo | Tipo | Descrição | Máx. Caract. | |-----------------------------------------|--------|-------------------------------------------------------------------------------------------------------------------------------|--------------| | **annual_cet** | float | Custo efetivo total expresso em decimal ao ano | - | | **assignment_amount** | float | Valor de aquisição da operação de crédito | - | | **cet** | float | Custo efetivo total expresso em decimal ao mês | - | | **fees** | object | **[Objeto Fees](#objeto-fees)** - Lista de Fee's da QI Tech cobrados na operação | - | | **disbursed_amount** | float | Valor desembolsado na operação de crédito | - | | **disbursement_date** | date | Data do desembolso da operação | - | | **installments** | list | **[Objeto Installments Response](#objeto-installments-response)** - Parcelas da operação | - | | **interest_type** | enum | **[Enumerador Interest Type](#enumerador-interest-type)** - Método de amortização e forma de cálculo de juros | - | | **additional_iof** | float | Valor de IOF adicional | - | | **base_iof** | float | Valor do IOF Base | - | | **total_iof** | float | Valor do IOF Total | - | | **issue_amount** | float | Valor de emissão/nominal da operação de crédito | - | | **tax_configuration** | object | **[Objeto Tax Configuration](#objeto-tax-configuration)** - Valores das alíquotas | - | | **first_due_date** | date | Data de vencimento da primeira parcela | - | | **prefixed_interest_rate** | object | **[Objeto Interest Rate](#objeto-interest-rate)** - Taxa de juros Nominal pré-fixada do contrato | - | ### Objeto Fees | Campo | Tipo | Descrição | Máx. Caract. | |-----------------|-------|-----------------------------------------------------------------------------------------------------|--------------| | **amount** | float | Valor do Fee (em percentual ou valor absoluto, a depender do valor informado no campo _amount_type_)| - | | **amount_type** | enum | **[Enumeradores amount_type](#enumerador-amount-type)** - Unidade do valor do Fee | - | | **fee_amount** | float | Valor absoluto do Fee cobrado na operação | - | | **fee_type** | enum | **[Enumerador Fee Type](#enumerador-fee-type)** - Tipo do Fee cobrado na operação | - | | **type** | enum | **[Enumerador Origin Type](#enumerador-origin-type)** - Origem do Fee cobrado na operação | - | ### Objeto Installments Request | Campo | Tipo | Descrição | Máx. Caract. | |-----------------------------------|---------|--------------------------------------------------------------------------------|--------------| | **due_date** | date | Data do vencimento em dia corrido da parcela | - | | **total_amount** | float | Valor total da parcela | - | ### Objeto Installments Response | Campo | Tipo | Descrição | Máx. Caract. | |-----------------------------------|---------|--------------------------------------------------------------------------------|--------------| | **calendar_days** | int | Quantos dias corridos entre uma parcela e outra | - | | **due_date** | date | Data do vencimento em dia corrido da parcela | - | | **due_principal** | float | Principal remanescente na data de vencimento da parcela antes de seu pagamento | - | | **has_interest** | boolean | _true_ - Indicador de incidência de juros na parcela | - | | **installment_number** | int | Número da parcela | - | | **prefixed_amount** | float | Valor de juros pré-fixado pago na parcela | - | | **principal_amortization_amount** | float | Valor de amortização pago na parcela | - | | **tax_amount** | float | IOF Base da parcela | - | | **amount** | float | Valor total da parcela | - | | **due_interest** | float | Juros remanescente após a data de vencimento da parcela antes de seu pagamento | - | | **period** | float | Período da parcela | - | | **period_workdays** | float | Período da parcela em dias úteis | - | | **period_to_disbursement** | float | Período até o desembolso | - | | **period_workdays_to_disbursement**| float | Período em dias úteis até o desembolso | - | | **calendar_days_to_disbursement** | int | Quantos dias corridos até o desembolso | - | | **workdays** | int | Quantos dias úteis entre uma parcela e outra | - | | **workdays_to_disbursement** | int | Quantos dias úteis até o desembolso | - | ### Objeto Interest Rate | Campo | Descrição | Máx. Caract. | |-------------------|---------------------------------------------------------------------------------------|--------------| | **annual_rate** | Taxa de juros pré/pós expressa em decimal ao ano | - | | **daily_rate** | Taxa de juros pré/pós expressa em decimal ao dia | - | | **interest_base** | **[Enumerador Interest Base](#enumerador-interest-base)** - Base de cálculo de juros | - | | **monthly_rate** | Taxa de juros pré/pós expressa em decimal ao mês | - | ### Objeto Tax Configuration | Campo | Descrição | Máx. Caract. | |-----------------------|---------------------------------------------------------------------------------------|--------------| | **base_rate** | Valor da alíquota base | - | | **additional_rate** | Valor da alíquota adicional | - | # Enumeradores ### Enumerador _Person Type_ | Enumerador | Descrição | |------------------------|-----------------------| | **legal** | Pessoa juridica | | **natural** | Pesso física | ### Enumerador _Account Type_ | Enumerador | Descrição | |------------------------|-----------------------| | **checking_account** | Conta corrente | | **deposit_account** | Conta de depósito | | **guaranteed_account** | Conta de garantia | | **investment_account** | Conta de investimento | | **payment_account** | Conta de pagamento | | **saving_account** | Conta poupança | | **salary_account** | Conta salário | ### Enumerador _Amount Type_ | Enumerador | Descrição | |------------------------|-----------------------| | **absolute** | Valor absoluto | | **percentage** | Valor percentual | ### Enumerador _Interest Type_ | Enumerador | Descrição | |----------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | **pre_price_days** | Método de amortização Price (parcelas iguais) com cálculo do juros pré-fixado ao dia | | **pre_price** | Método de amortização Price (parcelas iguais) com cálculo do juros pré-fixado em períodos fixos (30 dias) | | **pre_sac** | Método de amortização SAC (amortização constante) com cálculo do juros pré-fixado ao dia | | **post_sac** | Método de amortização SAC (amortização constante) com cálculo do juros baseado em uma taxa pré-fixada + indexador pós-fixado (cdi, ipca ou igpm) ao dia | | **post_price** | Método de amortização Price (parcelas iguais) com cálculo do juros baseado em uma taxa pré-fixada + indexador pós-fixado (cdi, ipca ou igpm) em períodos fixos (30 dias) | | **post_price_days** | Método de amortização Price (parcelas iguais) com cálculo do juros baseado em uma taxa pré-fixada + indexador pós-fixado (cdi, ipca ou igpm) ao dia | ### Enumerador _Credit Operation Type_ | Enumerador | Descrição | |---------------|--------------------------------| | **ccb** | Cédula de Crédito Bancário | | **cce** | Cédula de Crédito à Exportação | | **cci** | Cédula de Crédito Imobiliário | | **nce** | Nota de Crédito à Exportação | ### Enumerador _Interest Base_ | Enumerador | Descrição | |-----------------------|---------------------------------------------------------------------------| | **workdays** | Base de cálculo de juros em dias úteis considerando um ano de 252 dias | | **calendar_days** | Base de cálculo de juros em dias corridos considerando um ano de 360 dias | | **calendar_days_365** | Base de cálculo de juros em dias corridos considerando um ano de 365 dias | ### Enumerador _Fee Type_ Cada tipo de fee deve ser previamente habilitado e configurado pela QI Tech | Enumerador | Descrição | |-----------------------|----------------------------------------------------------------------------| | **tac** | Tarifa de abertura de cadastro | | **spread** | Ágio cobrado no valor de aquisição da operação de crédito | | **warranty_analysis** | Tarifa de análise de garantias | | **ted_fee** | Tarifa de TED | | **spread_ted_fee** | Ágio da tarifa de TED cobrado no valor de aquisição da operação de crédito | ### Enumerador _Origin Type_ Cada tipo de fee deve ser previamente habilitado e configurado pela QI Tech | Enumerador | Descrição | |-----------------------|----------------------------------------------------------------------------| | **internal** | Tarifa de origem interna | | **external** | Tarifa de origem externa | --- # Simulando erros em Sandbox URL: /documentation/emissao_de_divida/simulando_erros Esta página vai auxiliar a simular erros em ambiente Sandbox. # Dados para simular erro no desembolso Utilizando os seguintes dados bancários, você consegue simular um erro no desembolso de uma operação para a reapresentação de dados bancários. ```json account_digit: 0 account_number: 11581339 bank_code: 001 branch_number: 2874 document_number: Ajustar conforme documento de tomador Nome: Ajustar conforme nome de tomador ``` # Dados para simular erros utilizando a assinatura no QI Sign Utilizando os seguintes números no início do documento do tomador, você consegue simular erros fluxo de assinatura do QI Sign. Início de documento: ```json 0: Fraude detectada na assinatura 8: Falhou na validação de prova de vida 9: Validação facial não alcançou a pontuação mínima permitida ``` --- # Possíveis status de uma dívida URL: /documentation/emissao_de_divida/status_de_uma_divida ## Máquina de estados Após realizar a emissão do contrato de crédito, o mesmo pode ser acompanhado através dos Webhooks da plataforma QI Tech. Os estados que o contrato passa estão descritos abaixo: **waiting_signature** Após emitido, o primeiro estado em que um contrato se encontra é o de "aguardando assinatura", esse status permanece até a finalização do processo de assinaturas. **signature_finished** Esse é um estado transitório, após receber a última assinatura o contrato passa momentaneamente para o status "signature_finished", quando o webhook é disparado e transita para o próximo estado imediatamente. **signed** Após assinado o contrato fica com status "assinado". **issued** Este é um estado transitório, na data de desembolso de um contrato ele entra no status "issued" aguardando o desembolso para transitar para o próximo estado. **disbursed** Esse é um estado transitório, após o desembolso ser realizado o contrato passa momentaneamente para o status "disbursed", quando o webhook é disparado e transita para o próximo estado imediatamente. **opened** Após desembolsado o contrato fica com status "em aberto" - esse é o último estado caso a QI não seja o agente de cobrança da operação. **settled** Quando a QI Tech é o agente de cobrança da operação de crédito, o contrato é acompanhado até ser quitado, após o pagamento da última parcela seu status muda para "settled" e um Webhook é disparado. **canceled** Este estado, indica que ocorreu algum erro no fluxo da operação, como por exemplo falha no desembolso do crédito ao devedor ou então a não assinatura do contrato em tempo hábil. **canceled_permanently** Quando existir alguma garantia/averbação atrelada ao contrato, este será o estado final, que significará que a garantia/averbação foi liberada e o contrato foi permanentemente cancelado. --- # Reenvio de Notificações URL: /documentation/notificacoes/reenvio_de_notificacoes Aqui demonstramos como realizar o reenvio de callbacks de webhooks no sistema. O reenvio pode ser realizado para qualquer callback, independentemente do seu status atual. ## Fluxo de notificações 1. É necessário primeiro fazer uma consulta dos eventos elegíveis para o reenvio utilizando o método listado no **[Request](#request)** 2. Após a coleta de dados utilizando o método GET, para fazer o reenvio de wenhooks, você deve passar as chaves event_key e callback_key dentro da sua requisição PATCH, conforme apresentado no guia de **[Reenvio de callback](#reenviando-um-callback)** ## Listando eventos elegíveis para reenvio ## Request ENDPOINT /notification/events MÉTODO GET ### Query Parameters | Parâmetro | Tipo | Descrição | |------------------|---------|------------------------------------------------------------------| | event_type | string | Tipo do evento (ex: "debt_disbursed") | | callback_status | string | Status do callback (ex: "failed", "sent", etc.) | | origin_key | uuid | Chave única da origem do evento | | start_datetime | string | Data/hora inicial no formato "YYYY-MM-DDTHH:mm:ssZ" (Fuso Horário UTC) | | end_datetime | string | Data/hora final no formato "YYYY-MM-DDTHH:mm:ssZ" (Fuso Horário UTC) | > **Observação:** > A janela de tempo entre `start_datetime` e `end_datetime` deve ser no máximo 14 dias. Caso contrário, será retornado um erro. ## Response STATUS 200 Response Body ```json { "data": [ { "event_key": "", "event_type": "debt_disbursed", "status": "processed", "origin_enumerator": "account", "origin_key": "", "callbacks": [ { "callback_key": "", "callback_status": "failed" } ], } ], "pagination": { "current_page": 1, "rows_per_page": 25, } } ``` ### Response Parameters | Parâmetro | Tipo | Descrição | |------------------|---------|------------------------------------------------------------------| | event_key | uuid | Chave única do evento | | event_type | string | Tipo do evento (ex: "debt_disbursed") | | status | string | Status do evento (ex: "processed") | | origin_enumerator | string | API de origem do evento (ex: "lego") | | origin_key | uuid | Chave única do recurso da API de origem | | callbacks | list | Lista de objetos Callback | | pagination | object | Objeto Pagination | ### Callback Object | Parâmetro | Tipo | Descrição | |------------------|---------|------------------------------------------------------------------| | callback_key | uuid | Chave única do callback | | callback_status | string | Status do callback (ex: "failed", "sent", etc.) | ### Pagination Object | Parâmetro | Tipo | Descrição | |------------------|---------|------------------------------------------------------------------| | current_page | integer | Número da página atual | | rows_per_page | integer | Quantidade de registros por página | STATUS 400 Response Body: Error ```json { "code": "PMB000032", "title": "Bad Request", "description": "Selected timeframe should have a maximum of 14 days", "translation": "O intervalo de tempo selecionado deve ter no máximo 14 dias", } ``` ## Reenviando um callback ## Request :::important Limite de tempo A janela de tempo para busca de eventos é limitada a 14 dias. ::: :::warning Observações Verifique que está utilizando a event_key e a callback_key obtidas na request feita anteriormente. ::: ENDPOINT `/notification/event/{event_key}/callback/{callback_key}/retry` MÉTODO PATCH ### Path Parameters | Parâmetro | Tipo | Descrição | |--------------|-------|------------------------------------------------| | event_key | uuid | Chave única do evento (obtida na listagem) | | callback_key | uuid | Chave única do callback (obtida na listagem) | **Exemplo de Uso** ```bash curl -X PATCH "https://api-auth.sandbox.qitech.app/notification/event/123e4567-e89b-12d3-a456-426614174000/callback/987fcdeb-51a2-43d7-9012-345678901234/retry" ``` ## Response STATUS 204 Response Body ```json {} ``` ## Troubleshooting Em caso de problemas com o reenvio de callbacks: 1. Verifique se o `event_key` e `callback_key` estão corretos. 2. Confirme se o callback existe. 3. Verifique se a janela de tempo está dentro do limite de 14 dias. 4. Em caso de erro persistente, entre em contato com o suporte técnico. --- # Webhooks de dívida URL: /documentation/webhooks/dividas :::info Informação O timeout para resposta de nosso webhooks é de 5 segundos. ::: :::danger Atenção! Os webhooks da QI Tech não devem ser mapeadas de forma restrita. Campos adicionais podem ser incluídos aos payloads dos webhooks retornados em nossas APIs. ::: :::info Reenvio de Webhooks Você pode consultar e reenviar webhooks seguindo as instruções detalhadas na documentação: [Reenvio de Webhooks](/documentation/notificacoes/reenvio_de_notificacoes). ::: ## Webhook de assinatura finalizada Response Body ```json { "key": "ebe12ca1-ec34-4674-bd62-24c0bc204e81", "status": "signature_finished", "webhook_type": "debt", "event_datetime": "2024-09-02 18:39:49", "signed_contract_url": "https://storage.googleapis.com/live-doc-api/documents/6099edd7-1c83-4890-998e-ce60e218523cb/S_signed.pdf" } ``` ## Webhook de desembolso. Response Body ```json { "key": "bb81d525s-aa4b-4ddf-81d6-aa4b41fd04nb", "data": { "installments": [ { "due_date": "2025-11-24", "total_amount": 8304.16, "installment_key": "7ec2f4d-b21e-4bd5-ahs6-60e998267249", "pre_fixed_amount": 2475.77421509, "installment_number": 1, "principal_amortization_amount": 5828.23857532 }, { "due_date": "2025-12-22", "total_amount": 8304.16, "installment_key": "54g37d78-a9a9-bf82-9f8e-fd3ba123797a", "pre_fixed_amount": 2001.06342502, "installment_number": 2, "principal_amortization_amount": 6303.43346322 } ], "ted_receipt_list": [ { "fee": 0, "url": "https://storage.storage.com/sandbox-doc-api/documents/f9as9329-22bd-4dbg-91a2-f2sdgeth4h04/fheth459-bhrf-4hrt-9hra-fdsfsgehth42.pdf", "amount": 123456.0, "origin": { "name": "QI SOCIEDADE DE CRÉDITO DIRETO S.A.", "type": "payment_account", "branch": "0001", "document": "32402502000777", "bank_code": "329", "account_key": "5d068423-7774-49e4-b15b-7741238df5a8", "branch_digit": null, "account_digit": "5", "account_branch": "0001", "account_number": "00002", "financial_institution_name": "QI SOCIEDADE DE CRÉDITO DIRETO S.A." }, "timestamp": "2025-10-26T17:00:51", "description": "60701190 8615 22110-2 96969879003 - Alan Mathison Turing", "destination": { "name": "Alan Mathison Turing", "type": "checking_account", "branch": "8612", "purpose": "Crédito PIX em Conta", "document": "96972379003", "bank_ispb": "60111190", "branch_digit": null, "account_digit": "2", "account_number": "44110", "financial_institution_name": "BANCO S.A." }, "end_to_end_id": "E32402402200510221300gNgeefVNtVr", "transaction_key": "25044504-1902-412a-a445-23b813bee6c1", "origin_transaction_key": "542224ea-b5ea-49ff-b7b7-673b81af387b" } ], "requester_identifier_key": null }, "status": "disbursed", "webhook_type": "debt", "event_datetime": "2025-10-26 17:00:52" } ``` :::info Importante Quando os boletos de uma dívida são gerados, é enviado outro webhook: [Webhook de parcelas](/documentation/webhooks/parcelas) ::: ## Webhook de cancelamento. Response Body ```json { "webhook_type": "debt", "key":"27a099df-4688-43cb-87fa-515b1cf343a5", "event_datetime": "2022-09-27 07:03:49", "data": { "cancel_reason": "Operacao cancelada manualmente", "cancel_reason_enumerator": "manual" }, "status":"canceled " } ``` ## Webhook de contrato quitado: Response Body ```json { "key": "27a099df-4688-43cb-87fa-515b1cf343a5", "data": { "settlement_amount": 3429.38 }, "status": "settled", "webhook_type": "debt", "event_datetime": "2022-09-27 07:03:49" } ``` ---- ### Motivos de cancelamento | cancel_reason_enumerator | Descrição | |---|---| |disbursing_error|Operação cancelada por erro no momento do desembolso. |waiting_signature | Operação cancelada por falta de assinatura. |is_portability|A operação foi cancelada pois é uma portabilidade que não foi concluída. |not_collateral_constituted | A operação foi cancelada pois as garantias não foram constituídas. |entry_not_paid| A operação foi cancelada pois a entrada não foi paga. |not_assigned |Operação foi cancelada porque o processo de cessão não foi realizado. |pix_max_retry|Operação cancelada pois o banco recebedor não conseguiu receber o desembolso. |lack_of_resource |Operação cancelada por falta de recurso. |manual|Operação cancelada manualmente. |kyc_not_accepted|Operação cancelada pois não foi aprovada no compliance. |not_collateral_fgts|Operação cancelada por erro com FTGS. |agencia_conta_invalida |Agência ou Conta Destinatária do Crédito Inválida. |not_assigned |Operação foi cancelada porque o processo de cessão não foi realizado. |invalid_account| Número da conta de destino é inexistente ou inválido. |invalid_document_number |CPF/CNPJ da conta de destino está incorreto. |unsupported_transaction |A conta de destino não suporta este tipo de transação. |bank_slip_payment |Operação cancelada por erro no pagamento do boleto. |bank_slip_paid |Operação cancelada pois o boleto já está pago. |bank_slip_written_off |Operação cancelada pois o boleto já está baixado. |invalid_ispb |Número ISPB é inválido ou inexistente. |rejected_payment| Ordem de pagamento foi rejeitada pelo banco recebedor. |disbursed_amount_refunded| Operação cancelada devido a devolução do valor de desembolso| --- # Webhooks de gestão de risco URL: /documentation/webhooks/gestao_de_risco O `risk_amount` corresponde ao saldo devedor das operações ainda **não cedidas** — ou seja, a exposição em aberto da carteira que permanece sob risco e que consome o limite (`limit_amount`) disponível para novos desembolsos. Conforme as operações são cedidas ou quitadas, elas deixam de compor o `risk_amount` e liberam limite para novos desembolsos. :::danger Regra de desembolso Se `risk_amount + issue_amount > limit_amount`, a operação não será desembolsada. ::: :::tip Habilitação Entre em contato com o time da QI Tech para configurarmos o envio! ::: ## Webhook de atualização de risco Enviado periodicamente, **a cada hora**, com a atualização do valor de risco acumulado do cliente. Response Body ```json { "key": "b3a7e2c4-9d1f-4e8a-a456-2c3d4e5f6a7b", "data": { "risk_amount": 1500000, "limit_amount": 9000000, "reconciled_at": "2025-09-15T20:24:41" }, "status": "completed", "webhook_type": "risk_management.risk_updated", "event_datetime": "2025-09-15T20:24:41Z" } ``` ## Webhook de atualização de limite Enviado quando o limite de emissão de dívidas do cliente é atualizado. Response Body ```json { "key": "c4b8f3d5-0e2a-5f9b-b567-3d4e5f6a7b8c", "data": { "risk_amount": 0, "limit_amount": 9000000, "reconciled_at": "2025-09-15T18:03:54" }, "status": "completed", "webhook_type": "risk_management.limit_updated", "event_datetime": "2025-09-15T18:03:54Z" } ``` ## Definições ### Objeto callback | Campo | Tipo | Descrição | Obrigatório | |-------|------|-----------|-------------| | **event_datetime** | string | Data e hora do evento no formato ISO 8601 UTC | Sim | | **key** | string | Chave única do evento | Sim | | **status** | string | Status do evento | Sim | | **webhook_type** | string | Tipo do webhook (`risk_management.risk_updated` ou `risk_management.limit_updated`) | Sim | | **data** | object | Dados específicos do evento de gestão de risco | Sim | ### Objeto data | Campo | Tipo | Descrição | Obrigatório | |-------|------|-----------|-------------| | **risk_amount** | number | Saldo devedor das operações ainda não cedidas — exposição em aberto da carteira que consome o limite disponível | Sim | | **limit_amount** | number | Limite total disponível para emissão de novas dívidas | Sim | | **reconciled_at** | string | Data e hora da última reconciliação no formato ISO 8601 | Sim | --- # Webhooks de indevidos URL: /documentation/webhooks/indevidos :::info Informação O timeout para resposta de nossos webhooks é de 5 segundos. ::: :::danger Atenção! Os webhooks da QI Tech não devem ser mapeadas de forma restrita. Campos adicionais podem ser incluídos aos payloads dos webhooks retornados em nossas APIs. ::: :::info Reenvio de Webhooks Você pode consultar e reenviar webhooks seguindo as instruções detalhadas na documentação: [Reenvio de Webhooks](/documentation/notificacoes/reenvio_de_notificacoes). ::: ## Introdução Estes webhooks são disparados automaticamente quando a QI Tech identifica e processa a devolução de um valor indevido. ## Webhook de sucesso na devolução de indevidos Response Body ```json { { "event_datetime": "2024-01-15T14:30:00.000Z", "key": "fb34e0ac-2c98-47e7-9040-406b8c3d80e7", "status": "refunded", "webhook_type": "laas.devolution.refund_receipt", "data": { "origin_key":"b41c63e4-6912-4217-9111-a47dd4da9588", "devolution_key": "336f0e15-e7b8-45a4-8986-5411434be76a", "devolution_amount": 150.75, "devolution_status": "refunded", "devolution_reason_description": "The payment arrived earlier than expected. The difference between the paid amount and the present value should be refund", "receipt_url": "https://storage.googleapis.com/receipts/devolution_receipt_12345.pdf", "document_key": "cd27a0c3-630d-4682-81b2-71b5b325bcde", "transacted_at": "2024-01-15T14:25:30.000Z", "devolution_origin_type":"social_security" } } } ``` ## Webhook de falha na devolução de indevidos Response Body ```json { { "event_datetime": "2024-01-15T14:30:00.000Z", "key": "fb34e0ac-2c98-47e7-9040-406b8c3d80e7", "status": "error", "webhook_type": "laas.devolution.refund_failed", "data": { "origin_key":"b41c63e4-6912-4217-9111-a47dd4da9588", "devolution_key": "336f0e15-e7b8-45a4-8986-5411434be76a", "devolution_amount": 150.75, "devolution_status": "error", "devolution_reason_description": "The payment arrived earlier than expected. The difference between the paid amount and the present value should be refund", "devolution_origin_type":"social_security" } } } ``` # Retentativa de devolução No caso de falha na devolução, é possível realizar uma chamada para retentar a transferência. Enviando os dados bancários, será feita a retentativa inicialmente por pix na conta informada, no caso de falha, será realizada uma segunda tentativa através de chave pix cpf. É possível realizar a retentativa diretamente por chave pix cpf. PATCH /devolution/devolution/DEVOLUTION-KEY/retry **Request Body** **Informando dados bancários** ```json { "issuer_name":"John Doe", "document_number": "14471835092", "bank_account": { "account_branch":"0001", "account_number":"12345", "account_digit":"9", "bank_code":"001", "ispb":"00000000", "account_type":"checking" }, } ``` **Por chave pix cpf** ```json { "use_only_document_number_pix_key": true } ``` # Consulta de devolução ### Query Parameters | Parâmetro | Tipo | Obrigatório | Descrição | Valor Padrão | |----------------- |--------- |-------------|------------------------------------------- |--------------| | document_number | string | Não | documento do tomador da dívida | | | credit_operation_key | uuid | Não | Chave única da operação de crédito | | | origin_key | uuid | Não | Chave de referência do recurso devolvido | | | status | sring | Não | Status da devolução | | | start_date | date | Não | Data de criação da devolução (YYYY-mm-dd) | | | end_date | date | Não | Data de criação da devolução (YYYY-mm-dd) | | | page | integer | Não | Número da página a ser retornada | 1 | | page_size | integer | Não | Quantidade de registros por página | 25 | :::info A paginação é baseada em um, portanto a primeira página é a página 1. ::: GET /devolutions **Request Body** ```json { "data": [ { "devolution_key": "336f0e15-e7b8-45a4-8986-5411434be76a", "document_number": "03047465096", "devolution_amount": 150.75, "status": "refunded", "origin_type": "social_security", "devolution_reason": "The payment arrived earlier than expected. The difference between the paid amount and the present value should be refund", "receipt_url":"https://storage.googleapis.com/receipts/devolution_receipt_12345.pdf", "credit_operation_key": "fb34e0ac-2c98-47e7-9040-406b8c3d80e7", "origin_key": "b41c63e4-6912-4217-9111-a47dd4da9588", "created_at": "2024-01-15T14:30:00.000Z", } ], "pagination": { "current_page": 1, "next_page": 2, "rows_per_page": 100, } } ``` ## Definições ### Objeto callback | Campo | Tipo | Descrição | Obrigatório | |-------|------|-----------|-------------| | **event_datetime** | string | Data e hora do evento no formato ISO 8601 UTC | Sim | | **key** | string | Chave única da operação de crédito | Sim | | **status** | string | Status da devolução | Sim | | **webhook_type** | string | Tipo do webhook | Sim | | **data** | object | Dados específicos da devolução | Sim | ### Objeto data | Campo | Tipo | Descrição | Obrigatório | |-------|------|-----------|-------------| | **origin_key** | string | Chave de referência do recurso devolvido | Sim | | **devolution_key** | string | Chave única da devolução | Sim | | **devolution_amount** | number | Valor da devolução em reais | Sim | | **devolution_status** | string | Status atual da devolução | Sim | | **devolution_reason_description** | string | Descrição do motivo da devolução | Sim | | **receipt_url** | string | URL do comprovante da devolução | Sim | | **document_key** | string | Chave do documento relacionado | Sim | | **transacted_at** | string | Data e hora da transação no formato ISO 8601 UTC | Sim | | **devolution_origin_type** | string | Origem do recurso da devolução, consulte os possíveis enumeradores na tabela [Possíveis enumeradores de devolution_origin_type](#devolution_origin_type) | Sim | ## Possíveis enumeradores de devolution_origin_type {#devolution_origin_type} | Status | Descrição | |--------|-----------| | **fgts_conciliation** | Desconto indevido associado ao repasse de FGTS | | **ss_conciliation** | Desconto indevido associado ao repasse de INSS | | **private_payroll_conciliation** | Desconto indevido associado ao repasse de Consignado Privado | | **military_payroll_conciliation** | Desconto indevido associado ao repasse de Exército | | **federal_payroll_conciliation** | Desconto indevido associado ao repasse de SIAPE | | **payroll_card_discount** | Desconto indevido associado ao repasse de Cartão Consignado | | **renegotiation** | Desconto indevido associado a renegociação | ## Status possíveis | Status | Descrição | |-------- |-----------| | **refunded** | Devolução processada com sucesso | | **error** | Devolução processada sem sucesso | | **pending** | Devolução ainda não processada | | **refund_reversed** | Devolução estornada | --- # Webhooks de pagamento de parcelas URL: /documentation/webhooks/pagamento_de_parcela :::info Informação O timeout para resposta de nosso webhooks é de 10 segundos. ::: :::danger Atenção! Os webhooks da QI Tech não devem ser mapeadas de forma restrita. Campos adicionais podem ser incluídos aos payloads dos webhooks retornados em nossas APIs. ::: :::info Reenvio de Webhooks Você pode consultar e reenviar webhooks seguindo as instruções detalhadas na documentação: [Reenvio de Webhooks](/documentation/notificacoes/reenvio_de_notificacoes). ::: ---- ### Exemplo de webhook de parcela paga ```json { "key": "4219cb7b-32b9-45d1-b19c-24fbca04ca02", "webhook_type": "laas.credit_operation.installment.payment", "event_datetime": "2026-01-14 04:08:30", "data": { "installment_key":"1234cb7b-3329-12d1-429c-24f84975ca02", "reference_date":"2026-02-13", "paid_at":"2026-02-13 20:38:07", "paid_method_type":"pix", "installment_status":"paid_early", "installment_payment_key":"2accee19-ed22-43f9-9573-3b6232658337", "paid_amount":567.73, "total_amount":567.73, "present_total_amount":567.73, "prefixed_interest_payment_amount":556.73948769, "principal_amortization_payment_amount":10.99051231, "resource_account_key":"422cee19-ed22-43f9-9573-3b6111658337", "batch_renegotiation_proposal_key":null, "renegotiation_proposal_key":null, "received_portability_key":null, "refinancing_credit_operation_key":null, "bank_slip_key":null, "pix_qrcode_key":"3b61ee19-ed22-6119-9573-3b6119573337", "paid_in":{ "name": "ITAÚ UNIBANCO S.A.", "code_number": 341, "ispb": 60701190 } }, } ``` ## Anexo ### Descritivo dos campos {#paid_method} |Campo | Tipo | Descrição | |-------------------------------------- |------ |----- | |key |UUID |chave identificadora da dívida (credit_operation_key ou DEBT_KEY)| |installment_key |UUID |chave identificadora da parcela| |reference_date |Date |Data de referência para o cálculo do saldo devedor da parcela| |paid_at |DateTime |Data do pagamento| |paid_method_type |string |Método de pagamento, consulte os possíveis enumeradores na tabela [Enumeradores para paid_method_type](#paid_method)| |installment_status |string |Status da parcela, consulte os possíveis enumeradores na tabela [Enumeradores para installment_status](#installment_status)| |installment_payment_key |UUID |Chave única do pagamento| |paid_amount |decimal |Valor pago| |total_amount |decimal |Valor total da parcela, em caso de pagamento parcial é atualizado com o valor em aberto| |present_total_amount |decimal |Valor presente na data de referência (reference_date)| |prefixed_interest_payment_amount |decimal |Valor do pagamento referente à amortização de juros| |principal_amortization_payment_amount |decimal |Valor do pagamento referente à amortização de principal| |resource_account_key |UUID |Conta de origem do saldo utilizado na liquidação| |batch_renegotiation_proposal_key |UUID |Chave da renegociação em lote, se aplicável| |renegotiation_proposal_key |UUID |Chave da renegociação, se aplicável| |refinancing_credit_operation_key |UUID |Chave da operação de refinanciamento, se aplicável| |received_portability_key |UUID |Chave da portabilidade recebida, se aplicável| |bank_slip_key |UUID |Chave do boleto registrado com a parcela, se aplicável| |pix_qrcode_key |UUID |Chave da pix qr code registrado com a parcela, se aplicável| |paid_in |objeto |Informações do banco pagador, aplicável nos casos de pagamento por pix ou boleto| :::warning Valor de multa e mora do pagamento O valor de multa+mora (fine_amount) do pagamento pode ser identificado através da fórmula: fine_amount = paid_amount - prefixed_interest_payment_amount - principal_amortization_payment_amount. ::: ### Enumeradores para paid_method_type {#paid_method} | Enumerador | Descrição | |-----------------------|-------- | |bankslip | Boleto | |ted | ted | |pix | pix | |refinancing | refinanciamento | |portability | portabilidade | |unmonitored | baixa manual | |collateral | colateral | ### Enumeradores para installment_status {#installment_status} | Enumerador | Descrição | |----------------------- |-------- | |created | aberta | |opened | aberta | |waiting_payment | aberta aguardando pagamento na data de vencimento | |paid_partial | paga parcialmente | |paid | paga | |paid_early | paga adiantada | |overdue | atrasada | |paid_partial_overdue | paga parcialmente atrasada | |paid_overdue | paga atrasada | |canceled | cancelada | |unmonitored | aberta | |waiting_payment_confirmation | aguardando liquidação de refinanciamento | :::warning Pago parcialmente adiantado Repare que não existe o status de pago adiantado parcialmente, caso haja uma baixa parcial com data de referência anterior ao vencimento da parcela, o status anterior se mantém (unmonitored ou opened). ::: --- # Webhooks de parcelas URL: /documentation/webhooks/parcelas :::info Informação O timeout para resposta de nosso webhooks é de 10 segundos. ::: :::danger Atenção! Os webhooks da QI Tech não devem ser mapeadas de forma restrita. Campos adicionais podem ser incluídos aos payloads dos webhooks retornados em nossas APIs. ::: :::info Reenvio de Webhooks Você pode consultar e reenviar webhooks seguindo as instruções detalhadas na documentação: [Reenvio de Webhooks](/documentation/notificacoes/reenvio_de_notificacoes). ::: Essa configuração pode ser habilitada quando a QI Tech é o agente de cobrança da operação, com ela você receberá as mudanças de status nas parcelas da operação. Os status que podem ser configurados são: - **opened** (aberto) - **paid** (pago) - **waiting_payment** (aguardando pagamento) - **paid_early** (pago antecipadamente) - **paid_partial** (pago parcialmente) - **overdue** (vencido) - **paid_partial_overdue** (pago parcialmente após o vencimento) - **paid_overdue** (pago após o vencimento) ---- ### Exemplo de webhook de parcela paga Body.json ```json { "key": "92a05d9c-e457-4f28-9fa8-86be638ee2d0", "data": { "status": "paid", "installment": { "events": [{ "amount": 1009.68, "created_at": "2022-09-27T07:03:35", "event_date": "2022-09-27T07:03:34", "old_due_date": null, "installment_event_type": { "enumerator": "payment", "translation_path": "co.InstallmentEventType.payment" }, "installment_old_status": { "enumerator": "opened", "translation_path": "co.InstallmentStatus.opened" } }], "paid_at": "2022-09-27T07:03:34", "due_date": "2022-10-28", "workdays": 21, "created_at": "2022-08-27T10:54:18", "tax_amount": 5.11785875, "updated_at": "2022-09-27T07:03:35", "fine_amount": null, "paid_amount": 1009.68, "qr_code_key": "92a05d9c-e457-4f28-9fa8-86be638ee2d0", "qr_code_url": "https://qitech.com.br/", "due_interest": 0, "has_interest": true, "payment_type": { "enumerator": "bankslip", "translation_path": "co.PaymentType.bankslip" }, "total_amount": 1009.68, "bank_slip_key": "92a05d9c-e457-4f28-9fa8-86be638ee2d0", "calendar_days": 30, "due_principal": 1006.66428708, "digitable_line": "32990001031000699917042000000200291520000100968", "installment_key": "92a05d9c-e457-4f28-9fa8-86be638ee2d0", "additional_costs": [], "installment_type": { "enumerator": "principal", "translation_path": "co.InstallmentType.principal" }, "pre_fixed_amount": 3.02013568, "business_due_date": "2022-10-31", "cetip_settlements": [], "post_fixed_amount": 0, "total_paid_amount": 0, "installment_number": 3, "installment_status": { "enumerator": "paid", "translation_path": "co.InstallmentStatus.paid" }, "installment_payment": [{ "created_at": "2022-09-27T07:03:35", "installment_payment_key": "f03e1fbc-6d7a-456b-bd6a-db0faac1b481", "paid_at": "2026-02-10T11:39:07", "paid_amount": 1009.68, "total_amount": 1009.68, "due_principal": 1006.66428708, "reference_date": "2022-09-27", "paid_method_type": { "enumerator": "pix", "translation_path": "co.PaymentType.pix" }, "payment_data":{ "resource_account_key": "0fcc076f-f5e4-422c-aabd-67dbb63b7fb0", "paid_in":{ "name": "ITAÚ UNIBANCO S.A.", "code_number": 341, "ispb": 60701190 } }, "pre_fixed_amount": 3.02013568, "advanced_paid_amount": 0, "present_total_amount": 1009.68, "renegotiation_proposal_key": null, "principal_amortization_amount": 1006.65986432, "prefixed_interest_payment_amount": 3.02013568, "principal_amortization_payment_amount": 1006.65986432 }], "advanced_paid_amount": 0, "total_accrual_amount": 0, "original_total_amount": 1009.68, "accrual_reference_date": "2022-09-27", "original_due_principal": 1006.66428708, "original_pre_fixed_amount": 3.02013568, "renegotiation_proposal_key": null, "principal_amortization_amount": 1006.65986432, "original_principal_amortization_amount": 1006.65986432 }, "is_finished": true }, "webhook_type": "installment.status_change" } ``` ### Exemplo de webhook de criação de boletos para pagamento de parcelas Body.json ```json { "key": "96015228-4905-42fc-bda6-e70e0e552b6b", "webhook_type": "installment.status_change", "data": { "status": "update", "installments": [ { "installment_key": "bc60ad8e-4dc1-4edc-8c5b-6df1b5c9415d", "digitable_line": "32990001455000000000503007797909797660000100000", "qr_code_key": "7d20015e-c4ed-4290-b255-33c1c5b56362", "qr_code_url": "00020126580014br.gov.bcb.pix0136dc4a27db-2fe1-474d-aa02-88d6fffb8d0d5204000053039865802BR5921NeymarSportEMarketing6008saopaulo62070503***63040EB2", "principal_amortization_amount": 141.07452576, "pre_fixed_amount": 72.89547424, "bank_slip_key": "5f25e9fd-f612-47a3-acff-be9f29d87f6c", "due_date": "2024-07-17", "total_amount": 216.97 }, { "principal_amortization_amount": 144.84483469, "pre_fixed_amount": 65.12516531, "due_date": "2024-08-19", "digitable_line": "32990001454000000000627007797908997530000500000", "installment_key": "be3f0fde-24ac-42d2-82e9-4b0aa15bf01e", "qr_code_key": "4d696847-73a2-4dba-be9f-218084dff8e7", "qr_code_url": "00020126580014br.gov.bcb.pix0136dc4a27db-2fe1-474d-aa02-88d6fffb8d0d5204000053039865802BR5921NeymarSportEMarketing6008saopaulo62070503***63040EB2", "total_amount": 216.97, "bank_slip_key": "bc1cc18f-2db5-470d-8541-b944e53cb699" }, { "qr_code_url": "00020126580014br.gov.bcb.pix0136dc4a27db-2fe1-474d-aa02-88d6fffb8d0d5204000053039865802BR5921NeymarSportEMarketing6008saopaulo62070503***63040EB2", "digitable_line": "32990001454000000000623007797907697530000500000", "bank_slip_key": "8a00a520-7d49-4f51-9293-9ea26e241338", "principal_amortization_amount": 164.37001228, "installment_key": "3d4b5f21-c0a3-4075-bac2-9086cd90b77e", "due_date": "2024-09-17", "qr_code_key": "4d47528a-167d-41aa-b9da-246d2030af75", "total_amount": 216.97, "pre_fixed_amount": 52.59998772 } ] } } ``` ## Definições ### Objeto Request Body | Campo | Tipo | Descrição | Máx. Caract. | |---------------------------------|--------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------| | **key** * | object | DEBT-KEY da operação de crédito da referida parcela. | - | | **data** * | object | Dados do webhook. | - | | **webhook_type** * | object | Tipo do webhook enviado. | - | ### Objeto data | Campo | Tipo | Descrição | Máx. Caract. | |---------------------------------|--------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------| | **status** * | object | Status da parcela | - | | **installment** * | object | Dados da parcela | - | | **is_finished** * | booleano | Campo booleano indicando se existem novos status para a parcela ou se já esta finalizada. | - | ### Objeto installment | Campo | Tipo | Descrição | Máx. Caract. | |---------------------------------|--------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------| | **events** * | object | Status da parcela | - | | **paid_at** * | object | Dados da parcela | - | | **due_date** * | booleano | Campo booleano indicando se existem novos status para a parcela ou se já esta finalizada. | - | | **workdays** * | booleano | Campo booleano indicando se existem novos status para a parcela ou se já esta finalizada. | - | | **created_at** * | booleano | Campo booleano indicando se existem novos status para a parcela ou se já esta finalizada. | - | | **tax_amount** * | booleano | Campo booleano indicando se existem novos status para a parcela ou se já esta finalizada. | - | | **updated_at** * | booleano | Campo booleano indicando se existem novos status para a parcela ou se já esta finalizada. | - |