Refinancing Creation

Request

ENDPOINT

/debt

METHOD

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

Attention!

The payload used in a refinancing operation is the same used in a simple debt emission, in addition to the operation list which will be settled in the "refinanced_credit_operations"

Body Params

Field	Type	Description	Máx. Caract.
borrower *	object	Object Borrower - Credit Operation borrower information	-
disbursement_bank_account *	object	Object Disbursement Bank Account - Disbursement bank account information	-
financial *	object	Object Financial - Financial information	-
purchaser_document_number *	string	Purchaser document number	-
refinanced_credit_operations *	array of objects	Objects Refinanced Credit Operations Refinanced operations list	-

Definitions

Object Request Body

Field	Type	Description	Máx. Caract.
borrower *	object	Object Borrower - Credit operation borrower information	-
disbursement_bank_account *	object	Object Disbursement Bank Account - Disbursement bank account information	-
financial *	object	Object Financial - Financial information	-
purchaser_document_number *	string	Purchaser document number	-

Object Borrower

Campo	Tipo	Description	Máx. Caract.
name *	string	Creditors name	100
email	string	Creditors email	254
phone	object	Object Phone - Creditors Telefphone	-
is_pep *	boolean	Indicador de PEP (http://www.portaldatransparencia.gov.br/download-de-dados/pep)	-
address *	object	Object Address - Creditors Address	-
role_type *	enum	default: issuer	-
birth_date *	date	Creditors birth date ("AAAA-MM-DD" format)	-
mother_name *	string	Creditors monthers name	100
nationality	string	Creditors nationality	50
person_type *	string	Natural person indicator - default: natural	-
individual_document_number *	string	Creditors document number (apenas números)	11
document_identification *	string	Creditors DOCUMENT_KEY in PDF format (RG ou CNH)	-
document_identification_back	string	Creditors DOCUMENT_KEY (BACK)	11
wedding_certificate	string	Creditors wedding DOCUMENT_KEY. In the case their marital satus is "Single" must be null	11
proof_of_residence *	string	Creditors address DOCUMENT_KEY	11

Object Address

Field	Type	Description	Mx. Charact.
city *	string	Address city	100
state *	string	Address state (2 upper-case letters)	2
number *	string	Address number	10
street *	string	Address street	100
complement *	string	Address complement (free text)	100
postal_code *	string	Address CEP (http://www.buscacep.correios.com.br/sistemas/buscacep/)	8
neighborhood *	string	Address neighborhood	100

Object Phone

Field	Description	Example	Max. Charact.
number *	string	Telephone number	10
area_code *	string	Telefone DDD area code (https://ddd.guiamais.com.br/)	2
country_code *	string	Telefone country code (https://ddi.guiamais.com.br/)	3

Object Disbursement Bank Account

A debt emission must contain disbursement bank account informations in the same titularity as the creditor

Field	Type	Description	Max. Charact.
name	string	Creditor name	50
document_number	string	Creditor document number	11
bank_code *	string	Bank Code (https://www.bcb.gov.br/pom/spb/estatistica/port/ASTR003.pdf)	3
branch_number *	string	Branch number - Do NOT send the verification number	4
account_number *	string	Account number - Do NOT send the verification number	10
account_digit *	string	Account verification number	1
account_type	enum	Enumerator Account Type Account Type	1

Object Financial

The financial object describes the credit operations financial information

Field	Type	Description	Max. Charact.
amout	float	Credit issue amount	-
interest_type	object	Enumerator Interest Type - Interest calculation enumerator	-
credit_operation_type	object	Enumerator Credit Operation Type - credit operation type	-
annual_interest_rate	float	Pre-fixed anual interest rate	-
disbursement_date	date	Operation disbursement date	-
interest_grace_period	int	Interest grace period (in months)	-
principal_grace_period	int	Principal grace period	-
number_of_installments	int	Credit operation installment number	-
fine_configuration	object	Object Fine Configuration - Fine configuration	-

Object Fine Configuration

In the object fine configuration, the interest and fine values are set for this operation

Field	Type	Description	Max. Charact.
contract_fine_rate	float	Default fine configuration	-
interest_base	enum	Enumerator Interest Base - Interest calculation base	-
monthly_rate	float	Monthly default rate	-

Object Refinanced Credit Operations

Field	Type	Description	Characters
`operation_key`	string	Refinanced operation key	uuid key

Enumerators

Enumerator Person Type

Enumerator	Description
legal	Legal person
natural	Natural person

Enumerator Account Type

Enumerator	Description
checking_account	Checking account
deposit_account	Deposit account
guaranteed_account	guaranteed account
investment_account	Investment account
payment_account	Payment account
saving_account	Savings account
salary_account	Salary account

Enumerator Interest Type

Enumerator	Description
pre_price_days	Amortization method: Fixed installments with interest calculated daily
pre_price	Amortization method: Fixed installments with fixed period calculations (30 days)
pre_sac	Amortization method: Constant amortization with pre-fixed daily interest rate
post_sac	Amortization method: Constant amortization with pre-fixed daily interest rate + post-fixed integrated benchmark (IPCA, CBD, ETC) calculated daily
post_price	Amortization method: Fixed installments with pre-fixed daily interest rate + post-fixed integrated benchmark (IPCA, CBD, ETC) with fixed period calculations (30 days)
post_price_days	Amortization method: Fixed installments with pre-fixed daily interest rate + post-fixed integrated benchmark (IPCA, CBD, ETC) calculated daily

Enumerator Credit Operation Type

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

Enumerator Interest Base

Enumerator	Description
workdays	Interest basis: 252 days
calendar_days	Interest basis: 360 days
calendar_days_365	Interest basis: 365 days

Enumerator Fee Type

Each enumerator type must be previously set and configured by QI Tech

Enumerator	Description
tac	Opening fee
spread	Additional fee charged on credit operation
warranty_analysis	Warranty analysis fee
ted_fee	TED fee
spread_ted_fee	TED additional fee charged on credit operation

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

Request​

Body Params​

Definitions​

Object Request Body​

Object Borrower​

Object Address​

Object Phone​

Object Disbursement Bank Account​

Object Financial​

Object Fine Configuration​

Object Refinanced Credit Operations​