Criar um refinanciamento

Request

ENDPOINT

/debt

MÉTODO

POST

Request Body

{
    "borrower": {
        "address": {
            "city": "Bauru",
            "neighborhood": "Centro",
            "number": "343",
            "postal_code": "17057770",
            "state": "SP",
            "street": "Av Um"
        },
        "birth_date": "1998-03-21",
        "document_identification": "2f7bfc50-d7c0-4d4e-a5ce-d8bba2aeb348",
        "document_identification_number": "432202821",
        "email": "victor.moura@qitech.com.br",
        "individual_document_number": "37197645832",
        "name": "Urich Oliveira",
        "person_type": "natural",
        "phone": {
            "area_code": "14",
            "country_code": "055",
            "number": "936180265"
        }
    },
    "disbursement_bank_account": {
        "account_digit": "2",
        "account_number": "63755",
        "bank_code": "329",
        "branch_number": "0001"
    },
    "financial": {
        "disbursed_amount": 5000.0
        "monthly_interest_rate": 0.0175,
        "credit_operation_type": "ccb",
        "disbursement_date": "2022-04-25",
        "fine_configuration": {
            "contract_fine_rate": 0.02,
            "interest_base": "calendar_days",
            "monthly_rate": 0.01
        },
        "first_due_date": "2022-06-07",
        "interest_grace_period": 0,
        "interest_subsidy_percentage": 0,
        "interest_type": "pre_price_days",
        "issue_date": "2022-04-25",
        "number_of_installments": 84,
        "principal_grace_period": 0,
        "payment_type": "bankslip"
    },
    "simplified": true,
    "refinanced_credit_operations": [
            {
                "operation_key": "d897f8fa-30d0-4a25-b7e5-5daa61c7480d"
            },
            {
                "operation_key": "f8f0d7a9-4f0c-426c-ac50-33a09d4a0d78"
            }
    ],
  "purchaser_document_number": "32402502000135"
}

Atenção!

O payload ultilizado na emissão de um refinanciamento é o mesmo ultilizado na emissão de uma divida simples, com a adição da lista de operações que serão quitadas em "refinanced_credit_operations".

Body Params

Campo	Tipo	Descrição	Máx. Caract.
borrower *	object	Objeto Borrower - Devedor da operação de crédito.	-
disbursement_bank_account *	object	Objeto Disbursement Bank Account - Dados da conta bancária para desembolso da operação.	-
financial *	object	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.	-
refinanced_credit_operations *	array of objects	Lista de Objetos Refinanced Credit Operations contendo as operações refinanciadas.	-

Definições

Objeto Request Body

Campo	Tipo	Descrição	Máx. Caract.
borrower *	object	Objeto Borrower - Devedor da operação de crédito	-
disbursement_bank_account *	object	Objeto Disbursement Bank Account - Dados da conta bancária para desembolso da operação	-
financial *	object	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 - Telefone de contato do devedor	-
is_pep *	boolean	Indicador de PEP (http://www.portaldatransparencia.gov.br/download-de-dados/pep)	-
address *	object	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 ou CNH)	-
document_identification_back	string	DOCUMENT_KEY do PDF da parte de trás do documento de identificação da pessoa com foto (RG ou CNH) (enviado previamente).	11
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

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 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 - Método de amortização e forma de cálculo de juros	-
credit_operation_type	object	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 - 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 - Base de cálculo de juros	-
monthly_rate	float	Percentual de juros de atraso ao mês	-

Objeto Refinanced Credit Operations

Campo	Tipo	Descrição	Caracteres
`operation_key`	string	key da operação a ser refinanciada	chave uuid

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 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

Response

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

STATUS

400

Response Body

{
  "data": "{\"title\": \"Bad Request\", \"description\": \"Invalid request body.\", \"translation\": \"Corpo da requisição inválido.\", \"extra_fields\": {}, \"code\": \"LEG000069\"}"
}

Criar um refinanciamento

Request​

Body Params​

Definições​

Objeto Request Body​

Objeto Borrower​

Objeto Address​

Objeto Phone​

Objeto Disbursement Bank Account​

Objeto Financial​

Objeto Fine Configuration​

Objeto Refinanced Credit Operations​