Consultar uma Solicitação

Esse endpoint permite a consulta detalhada de uma determinada solicitação de crédito realizada no produto.

Parâmetros da URL

  • application_id:ID da solicitação a ser consultada.

Parâmetros da Requisição

Não é necessário o envio de nenhum dado no corpo da requisição.

Resposta

Se a requisição for processada com sucesso será retornado um status 200 e um JSON no seguinte formato:

  • id (string/uuid v4):ID da solicitação consultada.
  • sequencial_id (int): ID sequencial de cadastro da solicitação.
  • product (object): Objeto contendo os detalhes do produto.
  • product -> id (string/uuid v4): ID de identificação do produto desejado na solicitação.
  • borrower (object): Objeto contendo os detalhes da pessoa tomadora do empréstimo.
  • borrower -> id (string/uuid v4): ID de identificação da pessoa tomadora do empréstimo.
  • funding (object): Objeto contendo os detalhes do Financiador desta operação (Cessionário, Credor).
  • requested_amount (float): Valor solicitado para o empréstimo.
  • interest_rate (float): Taxa de Juros a ser aplicada no empréstimo, em decimais (1% = 0.01)
  • tac_amount (float): Taxa de Cadastro do tomador ou solicitação. Valor em reais.
  • tac_rate (float): Percentual a ser aplicado como Taxa de Cadastro do tomador ou solicitação. Valor em decimal (1% = 0,01).
  • finance_fee (float): Demais custos a serem adicionados ao financiamento, por exemplo a inclusão de um seguro prestamista.
  • num_payments (integer): Prazo, número de parcelas para o empréstimo.
  • first_payment_date (datetime): Data do primeiro pagamento para o financiamento.
  • disbursement_date (datetime): Data de desembolso do valor solicitado ao tomador.
  • issue_date (datetime): Data da emissão.
  • canceled_at (datetime): Data do cancelamento.
  • status (string): Status da solicitação.
  • cession_status (string): Status da cessão.
  • status_description (string): Descrição do status.
  • loan_details (object): Objeto contendo os detalhes do empréstimo/solicitação realizada.
  • payment_method (string): Forma de pagamento desejada. Possíveis valores aceitos: BANK_ACCOUNT_DEDUCTION, BOLETO, PAYROLL_DEDUCTION, PIX, RECEIVABLES.
  • backoffice_import_status: Status de importação no backoffice.
  • 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.
  • 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.
  • 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.
  • base_premium_amount (float): Valor.
  • additional_premium_amount (float): Valor adicional.
  • borrower_employer (string): ID de relacionamento entre o tomador e financiador.
  • beneficiary_account (object): Objeto contendo os detalhes da conta do beneficiário.
  • created_at (datetime): Data de criação da solicitação.
  • updated_at (datetime): Data da última atualização da solicitação.
  • version (int): Número sequencial de versionamento do registro da solicitação.
  • cession_value (float): Valor da cessão.
  • issue_value (float): Valor de emissão.
  • signature_authentication_options -> mode (string): Modo de autenticação da assinatura.
  • payment_orders (object): Objeto contendo os detalhes das ordens de pagamento da solicitação.
Objeto "funding"
  • id (string/uuid v4, obrigatório): ID de identificação do Financiador desta operação (Cessionário, Credor).
  • legal_name (string): Razão social do Financiador.
  • alias (string): Nome fantasia.
  • metadata (object): Objeto contendo dados cadastrais adicionais do Financiador.
Objeto "guarantors"
  • guarantors_id (string/uuid v4): ID de identificação da Pessoa que será avalista.
  • type (string): Tipo da Pessoa que será avalista.
Objeto "co-signers"
  • co_signers_id (string/uuid v4): ID de identificação da Pessoa que será anuente.
  • type (string): Tipo da Pessoa que será anuente.
Objeto "signature_collect_options"
  • require_self_photo (boolean): Flag para indicar que a foto do tipo selfie é obrigatório.
  • require_document_photo(boolean): Flag para indicar que o envio do documento é obrigatório.
  • require_self_validation(boolean): Flag para indicar se a foto do tipo selfie será validada.
Objeto "loan_details"
  • total_processing_cost: Custo total de processamento da cédula para emissão do empréstimo.
  • annual_interest_rate": Taxa de juros calculada para o formato anual.
  • annual_effective_interest_rate: Custo Efetivo Total Anual (CET), em pontos percentuais decimais (1% a.m = 0.01).
  • monthly_effective_interest_rate: Custo Efetivo Total Mensal, em pontos percentuais decimais (1% a.m = 0.01).
  • iof_amount: Valor total do IOF em reais, calculado para o empréstimo.
  • iof_daily_rate: Taxa de IOF diário. Aplicada sobre cada parcela sobre o valor amortizado composta em dias corridos.
  • iof_base_rate: Taxa de IOF base. Fixa, aplicada sobre o total financiado uma única vez.
  • finance_fee: Demais custos do financiamento que foram adicionados ao valor do empréstimo.
  • total_amount_owed: Valor total devido. Somatório de todas as Parcelas nas datas de vencimento.
  • financed_amount: Valor financiado em reais. Valor nominal (de face do empréstimo). Inclui o Valor Solicitado, Taxas de Cadastro (TAC), IOF e Demais taxas (finance_fee)
  • payment_amount: Valor da parcela.
  • issue_date: Data da realização da simulação/empréstimo.
  • schedule: Objeto contendo os detalhes das parcelas.
  • last_payment_date: Data de vencimento da última parcela.
Objeto "schedule"
  • payment:Valor da parcela na data do vencimento.
  • iof: IOF da parcela (desconsiderando IOF Base).
  • balance: Saldo em aberto da parcela.
  • interest: Valor de juros da parcela.
  • principal: Valor do principal da parcela.
  • period: Número da parcela
  • running_day: Quantidade de dias corridos desde a originação até a data de vencimento da parcela
  • payment_date: Data de vencimento da parcela.
Objeto "beneficiary_account"
  • registered_account_id: ID da conta registrada.
  • holder -> name: Nome da carteira.
  • holder -> taxpayer_id: Número do documento do operador da carteira.
  • external_bank_account: Objeto contendo os dados da conta bancária para depósito.
Objeto "external_bank_account"
  • bank_code (string): Código do banco.
  • bank_account (string): Número da conta
  • bank_account_digit (string): Dígito do número da conta.
  • bank_branch (string): Número da agência.
  • bank_account_type (string): Tipo da conta bancária.
  • ispb_code (string): Código ISPB relacionado ao banco da conta informada.
  • pix (object): Objeto contendo os dados de uma chave PIX.
  • pix -> key (string): Chave PIX.
  • pix -> key_type (string): Tipo da chave PIX. Valores aceitos: ALEATORY_KEY, EMAIL, PHONE_NUMBER, TAXPAYER_ID
  • baas -> account_number: Número da conta bancária no baas
Objeto "payment_orders"
  • id (string/uuid v4): Identificador único da ordem de pagamento.
  • amount (float): Valor a ser pago.
  • type (string): Tipo da ordem de pagamento. Possíveis valores: PIX_OUT, ERROR.
  • status (string): Status do processamento da ordem de pagamento. Possíveis valores: READY_FOR_PROCESSING.
  • beneficiary_account (objeto): Objeto com os dados da conta bancária do beneficiário.
Exemplo de JSON:
{ "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": "PENDING_QUALIFICATION", "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>" }, { "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": { "enim_8f": "<string>" } }, "canceled_at": "<dateTime>", "sequential_id": "<long>", "funding": { "id": "<uuid>", "legal_name": "<string>", "alias": "<string>", "metadata": { "values": { "culpa4": { "value": [ "<string>", "<string>" ], "sensitive": "<boolean>" }, "cupidatat_a": { "value": [ "<string>", "<string>" ], "sensitive": "<boolean>" } } } }, "payment_method": "RECEIVABLES", "backoffice_import_status": "PROCESSING", "guarantors": [ { "guarantor_id": "<uuid>", "type": "BUSINESS" }, { "guarantor_id": "<uuid>", "type": "PERSON" } ], "co_signers": [ { "co_signer_id": "<uuid>", "type": "BUSINESS" }, { "co_signer_id": "<uuid>", "type": "BUSINESS" } ], "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": "SVGS", "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": "BUSINESS" }, "product_configuration": { "if_existing": "REUSE", "type": "BORROWER_ACOUNT_FOR_ORIGINATOR" } }, "disbursement_attempts": [ { "id": "<uuid>", "status": "PARTIAL", "status_description": "<string>", "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": "TRAN", "ispb_code": "<string>" }, "pix": { "key": "<string>", "key_type": "EMAIL" }, "baas": { "account_number": "<string>" } }, "beneficiary_type": "EXTERNAL_REGISTERED_ACCOUNT" }, { "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": "TRAN", "ispb_code": "<string>" }, "pix": { "key": "<string>", "key_type": "TAXPAYER_ID" }, "baas": { "account_number": "<string>" } }, "beneficiary_type": "EXTERNAL_REGISTERED_ACCOUNT" } ], "requested_at": "<dateTime>", "processed_at": "<dateTime>", "application_managed_account_for_issuer_disbursement": { "baas": { "account_number": "<string>", "holder_type": "PERSON" }, "product_configuration": { "if_existing": "REUSE", "type": "BORROWER_ACOUNT_FOR_ORIGINATOR" } }, "created_at": "<dateTime>", "updated_at": "<dateTime>", "version": "<integer>" }, { "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": "EMAIL" }, "baas": { "account_number": "<string>" } }, "beneficiary_type": "BAAS_ACCOUNT" }, { "id": "<uuid>", "amount": "<number>", "type": "TED_OUT", "status": "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": "SLRY", "ispb_code": "<string>" }, "pix": { "key": "<string>", "key_type": "ALEATORY_KEY" }, "baas": { "account_number": "<string>" } }, "beneficiary_type": "BAAS_ACCOUNT" } ], "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": "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": "ALEATORY_KEY" }, "baas": { "account_number": "<string>" } }, "beneficiary_type": "EXTERNAL_UNREGISTERED_ACCOUNT" }, { "id": "<uuid>", "amount": "<number>", "type": "TED_OUT", "status": "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": "EXTERNAL_UNREGISTERED_ACCOUNT" } ] }
Log in to see full request history
timestatususer agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required
Headers
string
string
Responses

Language
URL
Click Try It! to start a request and see the response here! Or choose an example:
application/json
text/plain
English
Powered by Localize
Português (Brasil)