post http://{{auth_server_host}}/banking/originator/applications
Esse endpoint permite a realização de uma nova solicitação de crédito para o originador.
Parâmetros da Requisição
product(object, obrigatório): Objeto contendo os detalhes do produto.
product -> id(string/uuid v4, obrigatório): ID de identificação do produto desejado na solicitação.
borrower(object, obrigatório): Objeto contendo os detalhes da pessoa tomadora do empréstimo.
borrower -> id(string/uuid v4, obrigatório): ID de identificação da pessoa tomadora do empréstimo.
funding(object, obrigatório): Objeto contendo os detalhes do Financiador desta operação (Cessonário, Credor).
funding -> id(string/uuid v4, obrigatório): ID de identificação do Financiador desta operação (Cessonário, Credor).
requested_amount(float, obrigatório): Valor solicitado para o empréstimo.
interest_rate(float, obrigatório): Taxa de Juros a ser aplicada no empréstimo, em decimais (1% = 0.01)
tac_amount(float, obrigatório): Taxa de Cadastro do tomador ou solicitação. Valor em reais.
tac_rate(float, obrigatório): Percentual a ser aplicado como Taxa de Cadastro do tomador ou solicitação. Valor em decimal (1% = 0,01).
finance_fee(float, obrigatório): Demais custos a serem adicionados ao financiamento, por exemplo a inclusão de um seguro prestamista.
num_payments(integer, obrigatório): Prazo, número de parcelas para o empréstimo.
first_payment_date(datetime, obrigatório): Data do primeiro pagamento para o financiamento.
disbursement_date(datetime, obrigatório): Data de desembolso do valor solicitado ao tomador.
payment_method(string): Forma de pagamento desejada. Possíveis valores aceitos: BANK_ACCOUNT_DEDUCTION, BOLETO, PAYROLL_DEDUCTION, PIX, RECEIVABLES.
custom_variables(object): Objeto contendo valores de variáveis personalizadas, no formato "chave-valor".
guarantors(array): Objeto contendo uma lista de avalistas para a Solicitação que está sendo realizada, se aplicável para o tipo da operação.
guarantors -> guarantors_id(string/uuid v4): ID de identificação da Pessoa que será avalista.
guarantors -> type(string): Tipo da Pessoa que será avalista.
co_signers(array): Objeto contendo uma lista de anuentes para a Solicitação que está sendo realizada, se aplicável para o tipo da operação.
co_signers -> co_signers_id(string/uuid v4): ID de identificação da Pessoa que será anuente.
co_signers -> type(string): Tipo da Pessoa que será anuente.
signature_collect_method(string): Método de assinatura a ser utilizado. Possíveis valores aceitos: EMAIL, SMS, PHYSICAL, SMS.
issuer_disbursement_type(string): Tipo de desembolso. Possíveis valores aceitos: ORIGINATOR,.
signature_collect_options(object): Objeto contendo as opções para coleta das assinaturas.
Resposta
A resposta para essa requisição é um JSON no seguinte formato:
{
"id": "<uuid>",
"product": {
"id": "<uuid>"
},
"borrower": {
"id": "<uuid>"
},
"requested_amount": "<number>",
"interest_rate": "<double>",
"tac_amount": "<number>",
"finance_fee": "<number>",
"num_payments": "<integer>",
"first_payment_date": "<date>",
"disbursement_date": "<date>",
"issue_date": "<date>",
"status": "KYC_PROCESSING",
"status_description": "<string>",
"loan_details": {
"total_processing_cost": "<number>",
"annual_interest_rate": "<number>",
"annual_effective_interest_rate": "<number>",
"monthly_effective_interest_rate": "<number>",
"total_amount_owed": "<number>",
"disbursement_amount": "<number>",
"financed_amount": "<number>",
"iof_daily_rate": "<number>",
"iof_amount": "<number>",
"iof_base_rate": "<number>",
"payment_amount": "<number>",
"issue_date": "<date>",
"schedule": [
{
"payment": "<number>",
"iof": "<number>",
"balance": "<number>",
"interest": "<number>",
"principal": "<number>",
"period": "<integer>",
"running_day": "<integer>",
"payment_date": "<date>"
}
],
"last_payment_date": "<date>"
},
"custom_variables": {
"values": {
"essef": "<string>",
"velit_6": "<string>"
}
},
"canceled_at": "<dateTime>",
"sequential_id": "<long>",
"funding": {
"id": "<uuid>",
"legal_name": "<string>",
"alias": "<string>",
"metadata": {
"values": {
"ad_f_": {
"value": [
"<string>",
"<string>"
],
"sensitive": "<boolean>"
}
}
}
},
"payment_method": "BOLETO",
"backoffice_import_status": "NONE",
"guarantors": [
{
"guarantor_id": "<uuid>",
"type": "BUSINESS"
},
{
"guarantor_id": "<uuid>",
"type": "PERSON"
}
],
"co_signers": [
{
"co_signer_id": "<uuid>",
"type": "BUSINESS"
},
{
"co_signer_id": "<uuid>",
"type": "PERSON"
}
],
"signature_collect_method": "WHATSAPP",
"issuer_disbursement_type": "BENEFICIARY",
"signature_collect_options": {
"require_self_photo": "<boolean>",
"require_document_photo": "<boolean>",
"require_selfie_validation": "<boolean>"
},
"base_premium_amount": "<number>",
"additional_premium_amount": "<number>",
"loan": {
"id": "<uuid>"
},
"borrower_employer": {
"id": "<uuid>"
},
"disbursement": {
"requested_at": "<dateTime>",
"processed_at": "<dateTime>",
"receipt": "<string>"
},
"beneficiary_account": {
"registered_account_id": "<uuid>",
"holder": {
"name": "<string>",
"taxpayer_id": "<string>"
},
"external_bank_account": {
"bank_account": "<string>",
"bank_account_digit": "<string>",
"bank_branch": "<string>",
"bank_code": "<string>",
"bank_account_type": "SLRY",
"ispb_code": "<string>"
},
"pix": {
"key": "<string>",
"key_type": "PHONE_NUMBER"
},
"baas": {
"account_number": "<string>"
}
},
"created_at": "<dateTime>",
"updated_at": "<dateTime>",
"version": "<integer>",
"managed_account_for_issuer_disbursement": {
"baas": {
"account_number": "<string>",
"holder_type": "PERSON"
},
"product_configuration": {
"if_existing": "REUSE",
"type": "BORROWER_ACOUNT_FOR_ORIGINATOR"
}
},
"disbursement_attempts": [
{
"id": "<uuid>",
"status": "PROCESSING",
"status_description": "<string>",
"payment_orders": [
{
"id": "<uuid>",
"amount": "<number>",
"type": "TED_OUT",
"status": "SUCCESS",
"beneficiary_account": {
"registered_account_id": "<uuid>",
"holder": {
"name": "<string>",
"taxpayer_id": "<string>"
},
"external_bank_account": {
"bank_account": "<string>",
"bank_account_digit": "<string>",
"bank_branch": "<string>",
"bank_code": "<string>",
"bank_account_type": "SLRY",
"ispb_code": "<string>"
},
"pix": {
"key": "<string>",
"key_type": "ALEATORY_KEY"
},
"baas": {
"account_number": "<string>"
}
},
"beneficiary_type": "EXTERNAL_REGISTERED_ACCOUNT"
},
{
"id": "<uuid>",
"amount": "<number>",
"type": "PIX_OUT",
"status": "READY_FOR_PROCESSING",
"beneficiary_account": {
"registered_account_id": "<uuid>",
"holder": {
"name": "<string>",
"taxpayer_id": "<string>"
},
"external_bank_account": {
"bank_account": "<string>",
"bank_account_digit": "<string>",
"bank_branch": "<string>",
"bank_code": "<string>",
"bank_account_type": "SVGS",
"ispb_code": "<string>"
},
"pix": {
"key": "<string>",
"key_type": "PHONE_NUMBER"
},
"baas": {
"account_number": "<string>"
}
},
"beneficiary_type": "BORROWER"
}
],
"requested_at": "<dateTime>",
"processed_at": "<dateTime>",
"application_managed_account_for_issuer_disbursement": {
"baas": {
"account_number": "<string>",
"holder_type": "BUSINESS"
},
"product_configuration": {
"if_existing": "REUSE",
"type": "BORROWER_ACOUNT_FOR_ORIGINATOR"
}
},
"created_at": "<dateTime>",
"updated_at": "<dateTime>",
"version": "<integer>"
},
{
"id": "<uuid>",
"status": "ERROR",
"status_description": "<string>",
"payment_orders": [
{
"id": "<uuid>",
"amount": "<number>",
"type": "PIX_OUT",
"status": "READY_FOR_PROCESSING",
"beneficiary_account": {
"registered_account_id": "<uuid>",
"holder": {
"name": "<string>",
"taxpayer_id": "<string>"
},
"external_bank_account": {
"bank_account": "<string>",
"bank_account_digit": "<string>",
"bank_branch": "<string>",
"bank_code": "<string>",
"bank_account_type": "CACC",
"ispb_code": "<string>"
},
"pix": {
"key": "<string>",
"key_type": "ALEATORY_KEY"
},
"baas": {
"account_number": "<string>"
}
},
"beneficiary_type": "EXTERNAL_REGISTERED_ACCOUNT"
},
{
"id": "<uuid>",
"amount": "<number>",
"type": "TED_OUT",
"status": "READY_FOR_PROCESSING",
"beneficiary_account": {
"registered_account_id": "<uuid>",
"holder": {
"name": "<string>",
"taxpayer_id": "<string>"
},
"external_bank_account": {
"bank_account": "<string>",
"bank_account_digit": "<string>",
"bank_branch": "<string>",
"bank_code": "<string>",
"bank_account_type": "TRAN",
"ispb_code": "<string>"
},
"pix": {
"key": "<string>",
"key_type": "ALEATORY_KEY"
},
"baas": {
"account_number": "<string>"
}
},
"beneficiary_type": "BORROWER"
}
],
"requested_at": "<dateTime>",
"processed_at": "<dateTime>",
"application_managed_account_for_issuer_disbursement": {
"baas": {
"account_number": "<string>",
"holder_type": "BUSINESS"
},
"product_configuration": {
"if_existing": "REUSE",
"type": "BORROWER_ACOUNT_FOR_ORIGINATOR"
}
},
"created_at": "<dateTime>",
"updated_at": "<dateTime>",
"version": "<integer>"
}
],
"payment_orders": [
{
"id": "<uuid>",
"amount": "<number>",
"type": "PIX_OUT",
"status": "ERROR",
"beneficiary_account": {
"registered_account_id": "<uuid>",
"holder": {
"name": "<string>",
"taxpayer_id": "<string>"
},
"external_bank_account": {
"bank_account": "<string>",
"bank_account_digit": "<string>",
"bank_branch": "<string>",
"bank_code": "<string>",
"bank_account_type": "SLRY",
"ispb_code": "<string>"
},
"pix": {
"key": "<string>",
"key_type": "ALEATORY_KEY"
},
"baas": {
"account_number": "<string>"
}
},
"beneficiary_type": "BAAS_ACCOUNT"
},
{
"id": "<uuid>",
"amount": "<number>",
"type": "PIX_OUT",
"status": "ERROR",
"beneficiary_account": {
"registered_account_id": "<uuid>",
"holder": {
"name": "<string>",
"taxpayer_id": "<string>"
},
"external_bank_account": {
"bank_account": "<string>",
"bank_account_digit": "<string>",
"bank_branch": "<string>",
"bank_code": "<string>",
"bank_account_type": "SLRY",
"ispb_code": "<string>"
},
"pix": {
"key": "<string>",
"key_type": "PHONE_NUMBER"
},
"baas": {
"account_number": "<string>"
}
},
"beneficiary_type": "EXTERNAL_UNREGISTERED_ACCOUNT"
}
]
}