Pular para o conteúdo principal

Emissão de dívida 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.

Atenção!

A QI Tech oferece uma solução de Oboarding de novos clientes e Anti-fraude.

Confira aqui a documentação das APIs deste serviço.

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). O formato de assinatura do header e do body desta requisição é descrito em detalhes aqui.

Request

ENDPOINT
/debt
MÉTODO
POST
Request Body
{
"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": {
"amount": 123456,
"interest_type": "pre_price_days",
"credit_operation_type": "ccb",
"annual_interest_rate": 2.32,
"disbursement_date": "2023-03-01",
"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"
}

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
{
"data": {
"additional_iof": 469.1328,
"annual_cet": "283,3821%",
"assignment_amount": 124690.56,
"base_iof": 473.6829374063069,
"borrower": {
"document_number": "96969879003",
"name": "Alan Mathison Turing"
},
"cet": "11,8500%",
"collaterals": [],
"contract": {
"number": "0000067563/AMT",
"signature_information": [
{
"signature_url": null,
"signer_document_number": "15627918004",
"signer_email": "alan.turing@email.com",
"signer_external_key": null,
"signer_name": "Alan Mathison Turing",
"signer_role": "issuer"
}
],
"urls": [
"https://storage.googleapis.com/sandbox-doc-api/documents/5af36fcd-8e4c-4421-ad45-7bcba899c0d3/SYNGENTASANDBOX-ALAN_MATHISON_TURING-CCB-0000067563-20230302234816.pdf"
]
},
"contract_fee_amount": 1234.56,
"contract_fees": [
{
"fee_amount": 1234.56,
"fee_type": "tac"
}
],
"external_contract_fee_amount": 1234.56,
"external_contract_fees": [
{
"fee_amount": 1234.56,
"fee_type": "spread",
"net_fee_amount": 1120.36,
"tax_amount": 114.2
}
],
"installments": [
{
"accrual_reference_date": null,
"additional_costs": [],
"advanced_paid_amount": 0,
"bank_slip_key": null,
"business_due_date": "2023-04-03",
"calendar_days": 31,
"digitable_line": null,
"due_date": "2023-04-02",
"due_interest": 0,
"due_principal": 123456,
"fine_amount": null,
"has_interest": true,
"installment_history": [],
"installment_key": "da264e95-2bbd-47de-876b-bfea7d25e266",
"installment_number": 1,
"installment_payment": [],
"installment_status": "created",
"installment_type": "principal",
"original_due_principal": 123456,
"original_pre_fixed_amount": 13245.468714162304,
"original_principal_amortization_amount": 58473.151285837695,
"original_total_amount": 71718.62,
"paid_amount": 0,
"paid_at": null,
"post_fixed_amount": 0,
"pre_fixed_amount": 13245.468714162304,
"principal_amortization_amount": 58473.151285837695,
"qr_code_key": null,
"qr_code_url": null,
"renegotiation_proposal_key": null,
"tax_amount": 148.63875056859942,
"total_accrual_amount": null,
"total_amount": 71718.62,
"total_paid_amount": 0,
"workdays": 21
},
{
"accrual_reference_date": null,
"additional_costs": [],
"advanced_paid_amount": 0,
"bank_slip_key": null,
"business_due_date": "2023-05-02",
"calendar_days": 30,
"digitable_line": null,
"due_date": "2023-05-02",
"due_interest": 0,
"due_principal": 64982.848714162305,
"fine_amount": null,
"has_interest": true,
"installment_history": [],
"installment_key": "cac7064b-2310-45e1-a91f-5e8f39f0f0ea",
"installment_number": 2,
"installment_payment": [],
"installment_status": "created",
"installment_type": "principal",
"original_due_principal": 64982.848714162305,
"original_pre_fixed_amount": 6735.77577015044,
"original_principal_amortization_amount": 64982.84422984956,
"original_total_amount": 71718.62,
"paid_amount": 0,
"paid_at": null,
"post_fixed_amount": 0,
"pre_fixed_amount": 6735.77577015044,
"principal_amortization_amount": 64982.84422984956,
"qr_code_key": null,
"qr_code_url": null,
"renegotiation_proposal_key": null,
"tax_amount": 325.0441868377075,
"total_accrual_amount": null,
"total_amount": 71718.62,
"total_paid_amount": 0,
"workdays": 19
}
],
"iof_charge_method": "financed",
"issue_amount": 123456,
"net_external_contract_fee_amount": 1120.36,
"number_of_installments": 2,
"prefixed_interest_rate": {
"annual_rate": 2.32,
"created_at": "2023-03-02T23:48:15",
"daily_rate": 0.00329298,
"interest_base": "calendar_days_365",
"monthly_rate": 0.10516767
},
"requester_identifier_key": "1c2ca4dc-2a20-4dd4-bd5f-af143fadadf4",
"total_iof": 942.82,
"total_pre_fixed_amount": 19981.244484312745
},
"event_datetime": "2023-03-02 23:48:20",
"key": "1c2ca4dc-2a20-4dd4-bd5f-af143fadadf4",
"status": "waiting_signature",
"webhook_type": "debt"
}

Definições

Objeto Request Body

CampoTipoDescriçãoMáx. Caract.
borrower *objectObjeto Borrower - Devedor da operação de crédito-
disbursement_bank_account *objectObjeto Disbursement Bank Account - Dados da conta bancária para desembolso da operação-
financial *objectObjeto 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 *stringCNPJ do cessionário (comprador) da operação de crédito-

Objeto Borrower

CampoTipoDescriçãoMáx. Caract.
name *stringNome do devedor100
emailstringEmail do devedor254
phoneobjectObjeto Phone - Telefone de contato do devedor-
is_pep *booleanIndicador de PEP (http://www.portaldatransparencia.gov.br/download-de-dados/pep)-
address *objectObjeto Address - Endereço do devedor-
role_type *enumdefault: issuer-
birth_date *dateData de nascimento do devedor (formato "AAAA-MM-DD")-
mother_name *stringNome da mãe do devedor100
nationalitystringNacionalidade do devedor50
person_type *stringIndicador de pessoa física - default: natural-
individual_document_number *stringCPF do devedor (apenas números)11
document_identification *stringDOCUMENT_KEY do PDF do documento de identificação do devedor com foto (RG ou CNH)-
document_identification_backstringDOCUMENT_KEY do PDF da parte de trás do documento de identificação da pessoa com foto (RG ou CNH) (enviado previamente).11
wedding_certificatestringDOCUMENT_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 *stringDOCUMENT_KEY do PDF do comprovante de endereço do endereço enviado (enviado previamente).11

Objeto Address

CampoTipoDescriçãoMáx. Caract.
city *stringCidade do endereço100
state *stringEstado do endereço (com dois caracteres maiúsculos)2
number *stringNúmero do endereço10
street *stringRua do endereço100
complement *stringComplemento do endereço (texto livre)100
postal_code *stringCEP do endereço (http://www.buscacep.correios.com.br/sistemas/buscacep/)8
neighborhood *stringBairro do endereço100

Objeto Phone

CampoDescriçãoExemploMáx. Caract.
number *stringNúmero de telefone10
area_code *stringCódigo DDD do telefone (https://ddd.guiamais.com.br/)2
country_code *stringCó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.

CampoTipoDescriçãoMáx. Caract.
namestringNome do titular da conta50
document_numberstringCPF do titular da conta11
bank_code *stringCódigo COMPE da instituição financeira (https://www.bcb.gov.br/pom/spb/estatistica/port/ASTR003.pdf)3
branch_number *stringNúmero da agência (não informar o dígito verificador da agência!)4
account_number *stringNúmero da conta (sem o dígito verificador da conta!)10
account_digit *stringDígito verificador da conta (informar zero no lugar de letras)1
account_typeenumEnumerador Account Type Tipo da conta1

Objeto Financial

O objeto financial descreve as informações financeiras da operação de crédito.

CampoTipoDescriçãoMáx. Caract.
amoutfloatValor de emissão/nominal da operação de crédito-
interest_typeobjectEnumerador Interest Type - Método de amortização e forma de cálculo de juros-
credit_operation_typeobjectEnumerador Credit Operation Type - Tipo do contrato de crédito-
annual_interest_ratefloatTaxa de juros pré-fixada expressa em decimal ao ano-
disbursement_datedateData do desembolso da operação-
interest_grace_periodintCarência de juros (em meses)-
principal_grace_periodintPeríodo carência de principal-
number_of_installmentsintNúmero de parcelas da operação de crédito-
fine_configurationobjectObjeto 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.

CampoTipoDescriçãoMáx. Caract.
contract_fine_ratefloatPercentual de multa por atraso-
interest_baseenumEnumerador Interest Base - Base de cálculo de juros-
monthly_ratefloatPercentual de juros de atraso ao mês-

Objeto Rebates

CampoTipoDescriçãoMáx. Caract.
fee_type *enumTipo da tarifa.-
amount_type *objectTipo do valor a ser cobrado.-
amount *objectValor da tarifa. Se o tipo da tarifa for percentual, o valor deverá ser entre 0 e 100.-

Response Body

CampoTipoDescriçãoMáx. Caract.
data[n].dataobjectObjeto Data-
data[n].event_datetimedateMomento da geração da operação de crédito-
data[n].keystringDEBT-KEY - Chave única da operação de crédito dentro da QI-
data[n].statusstringPossívies Status de uma dívida-
data[n].typestringdebt-

Enumeradores

Enumerador Person Type

EnumeradorDescrição
legalPessoa juridica
naturalPesso física

Enumerador Amount Type

EnumeradorDescrição
tacTarifa cobrada do tomador.
spreadTarifa cobrada do fundo adicionada ao preço de cessão da operação.

Enumerador Account Type

EnumeradorDescrição
checking_accountConta corrente
deposit_accountConta de depósito
guaranteed_accountConta de garantia
investment_accountConta de investimento
payment_accountConta de pagamento
saving_accountConta poupança
salary_accountConta salário

Enumerador Interest Type

EnumeradorDescrição
pre_price_daysMétodo de amortização Price (parcelas iguais) com cálculo do juros pré-fixado ao dia
pre_priceMétodo de amortização Price (parcelas iguais) com cálculo do juros pré-fixado em períodos fixos (30 dias)
pre_sacMétodo de amortização SAC (amortização constante) com cálculo do juros pré-fixado ao dia
post_sacMé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_priceMé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_daysMé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

EnumeradorDescrição
ccbCédula de Crédito Bancário
cceCédula de Crédito à Exportação
cciCédula de Crédito Imobiliário
nceNota de Crédito à Exportação

Enumerador Interest Base

EnumeradorDescrição
workdaysBase de cálculo de juros em dias úteis considerando um ano de 252 dias
calendar_daysBase de cálculo de juros em dias corridos considerando um ano de 360 dias
calendar_days_365Base 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

EnumeradorDescrição
tacTarifa de abertura de cadastro
spreadÁgio cobrado no valor de aquisição da operação de crédito
warranty_analysisTarifa de análise de garantias
ted_feeTarifa de TED
spread_ted_feeÁgio da tarifa de TED cobrado no valor de aquisição da operação de crédito