Request Fields

These fields are used to Create and Query Requests.

Field name	Path	Description
Taker	borrower.id	Unique Identifier of the Borrower of this Loan
Creation Date	created_at	Request creation timestamp
Signature Method	signature_collect_method	Signature method being used. One of EMAIL, SMS, PHYSICAL, SMS
Custom variables	custom_variables	Custom variable values, in key-value format.
Disbursement/Import Date	disbursement_date	Date of submission of the request to the Issuer for disbursement
Other costs	finance_fee	Demais custos de financiamento
First Installment Due Date	first_payment_date	First payment date
Financiador	funding.id	Unique identifier of the Financier of this operation (Assignee, Creditor)
Identifier	id	Unique identifier for this request
Interest rate	interest_rate	Interest Rate, in decimals (1% = 0.01)
Date of issue	issue_date	Loan Issue Date (Import Date at the Issuer)
Loan Details	loan_details	Loan Details
Annual CET	loan_details.annual_effective_interest_rate	Total Annual Effective Cost, in decimal percentage points (1% am = 0.01)
Annual Interest Rate	loan_details.annual_interest_rate	Annual Interest Rate, in decimal percentage points (1% am = 0.01)
Amount disbursed	loan_details.disbursement_amount	Amount disbursed
Valor Financiado	loan_details.financed_amount	Financed amount in reais. Nominal (face value of the loan). Includes the Requested Amount, Registration Fees (TAC), IOF and Other Fees (finance_fee)
Total IOF	loan_details.iof_amount	Total IOF, in reais
Taxa Base IOF	loan_details.iof_base_rate	Basic IOF rate. Fixed, applied to the total financed once only.
Daily IOF Rate	loan_details.iof_daily_rate	Daily IOF rate. Applied to each installment on the amortized amount compounded in calendar days
Date of issue	loan_details.issue_date	Loan Issue Date (Import Date at the Issuer)
Due Date Last Installment	loan_details.last_payment_date	Data do último pagamento
Monthly CET	loan_details.monthly_effective_interest_rate	Total Monthly Effective Cost, in decimal percentage points (1% am = 0.01)
Installment Value	loan_details.payment_amount	Installment Value
Total Due	loan_details.total_amount_owed	Total Due. Sum of all installments on due dates. Expectation of receipt.
Total Processing Cost	loan_details.total_processing_cost	Total cost of ballot processing
Installment Balance	loan_details.schedule[i].balance	Balance before payment of the ith installment
Interest Installment	loan_details.schedule[i].interest	Interest on the i-th installment
IOF Installment	loan_details.schedule[i].iof	IOF of the i-th installment (disregarding Basic IOF)
Installment Value	loan_details.schedule[i].payment	Value of the ith installment, on the due date
Installment Due Date	loan_details.schedule[i].payment_date	Due date of the ith installment
Installment Order	loan_details.schedule[i].period	Order of the ith installment
Installment Amortization	loan_details.schedule[i].principal	Amortization of the i-th installment
Running days Installment	loan_details.schedule[i].running_day	Calendar days since origination on the due date of the ith installment
Quantity Installments	num_payments	Term
Originator	originator.id	Unique identifier of the Originator that opened the request
Payment Method	payment_method	Método de Pagamento (BANK_ACCOUNT_DEDUCTION, BOLETO, PAYROLL_DEDUCTION, PIX, RECEIVABLES)
Product	product.id	Unique identifier of the Product linked to the request
Requested amount	requested_amount	Requested amount
Id Sequencial	sequential_id	Unique sequential identifier for reconciliation with issuer.
Status	status	Request Status. See docs about the lifecycle of a request .
Reason for Cancellation	status_description	Indicates the reason for canceling a request, if caused by the system
Pix Payment Proof	disbursement.receipt	Proof of payment to the beneficiary for Managed Disbursement users, in the BACEN standard, preformatted, with line breaks in UNIX format.
Disbursement date	disbursement.processed_at	Date and time of confirmation of payment to the beneficiary for Managed Disbursement users, in ISO format, in UTC. Example: "2023-06-01T18:57:56.851"
TAC	tac_amount	Registration fee, in reais