Visão Geral da Security

A security representa os dados da dívida, independente de sua origem (loan, cartão de crédito e etc)

Objeto

{
	"type": "Credit",
	"external_reference": "jqt2drby2q452nkfk8vqh4ghn",
	"is_overdue": false,
	"installment_plan": {
		"amount": 390.8082369791,
		"count": 6,
		"total_sum": 2344.8494218746,
		"payment_reference_date": "2023-03-13"
	},
	"rate": {
		"tax_amount": 24.99,
		"annual_interest_rate": 0.1942,
		"annual_total_effective_cost_rate": 0.242,
		"retention_rate": 0.1954,
		"interest_rate": 0.0149,
		"iof_rate": 0.000041
	},
	"summary": {
		"total_paid": 0,
		"current_debt_amount": 2244.7799639741,
		"number_of_open_installments": 6,
		"due_date": "2023-09-13",
		"days_overdue": 40
	},
	"last_update_date": "2023-05-23T19:48:28Z"
}

Campos

Campo	Descrição	Tipo
type	Tipo da security	String
external_reference	Identificador externo da dívida	String
is_overdue	Indica se a dívida encontra-se em estado de inadimplência	Boolean
installment_plan.amount	Valor de cada parcela da dívida	Decimal
installment_plan.count	Quantidade de parcelas da dívida	Integer
installment_plan.total_sum	Soma total de todas as parcelas	Decimal
installment_plan.payment_reference_date	Data de referência para o pagamento das parcelas	Date
rate.tax_amount	Valor dos impostos da dívida	Decimal
rate.annual_interest_rate	Taxa de juros anual	Decimal
rate.annual_total_effective_cost_rate	Taxa de custo efetivo total anual	Decimal
rate.retention_rate	Taxa de retenção da dívida	Decimal
rate.interest_rate	Taxa de juros da dívida	Decimal
rate.iof_rate	Taxa de iof	Decimal
summary.total_paid	Valor quitado	Decimal
summary.current_debt_amount	Saldo devedor atual	Decimal
summary.number_of_open_installments	Número de parcelas abertas	Integer
summary.due_date	Data de vencimento da dívida	Date
summary.days_overdue	Dias de atraso no pagamento	Integer
last_update_date	Horário de última atualização dos dados da security	DateTime

Tipos de Securities

Tipo	Descrição
Credit	Representa um empréstimo