Cancelar uma Solicitação

Esse endpoint permite a realização do cancelamento de uma solicitação realizada.

Parâmetros da URL

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

Resposta

Se a requisição for processada com sucesso será retornado um status 200 e um JSON com os detalhes da solicitação que foi cancelada.

Exemplo de JSON:
{ "id": "", "product": { "id": "" }, "borrower": { "id": "" }, "requested_amount": "", "interest_rate": "", "tac_amount": "", "finance_fee": "", "num_payments": "", "first_payment_date": "", "disbursement_date": "", "issue_date": "", "status": "PENDING_QUALIFICATION", "status_description": "", "loan_details": { "total_processing_cost": "", "annual_interest_rate": "", "annual_effective_interest_rate": "", "monthly_effective_interest_rate": "", "total_amount_owed": "", "disbursement_amount": "", "financed_amount": "", "iof_daily_rate": "", "iof_amount": "", "iof_base_rate": "", "payment_amount": "", "issue_date": "", "schedule": [ { "payment": "", "iof": "", "balance": "", "interest": "", "principal": "", "period": "", "running_day": "", "payment_date": "" }, { "payment": "", "iof": "", "balance": "", "interest": "", "principal": "", "period": "", "running_day": "", "payment_date": "" } ], "last_payment_date": "" }, "custom_variables": { "values": { "enim_8f": "" } }, "canceled_at": "", "sequential_id": "", "funding": { "id": "", "legal_name": "", "alias": "", "metadata": { "values": { "culpa4": { "value": [ "", "" ], "sensitive": "" }, "cupidatat_a": { "value": [ "", "" ], "sensitive": "" } } } }, "payment_method": "RECEIVABLES", "backoffice_import_status": "PROCESSING", "guarantors": [ { "guarantor_id": "", "type": "BUSINESS" }, { "guarantor_id": "", "type": "PERSON" } ], "co_signers": [ { "co_signer_id": "", "type": "BUSINESS" }, { "co_signer_id": "", "type": "BUSINESS" } ], "signature_collect_method": "WHATSAPP", "issuer_disbursement_type": "BENEFICIARY", "signature_collect_options": { "require_self_photo": "", "require_document_photo": "", "require_selfie_validation": "" }, "base_premium_amount": "", "additional_premium_amount": "", "loan": { "id": "" }, "borrower_employer": { "id": "" }, "disbursement": { "requested_at": "", "processed_at": "", "receipt": "" }, "beneficiary_account": { "registered_account_id": "", "holder": { "name": "", "taxpayer_id": "" }, "external_bank_account": { "bank_account": "", "bank_account_digit": "", "bank_branch": "", "bank_code": "", "bank_account_type": "SVGS", "ispb_code": "" }, "pix": { "key": "", "key_type": "PHONE_NUMBER" }, "baas": { "account_number": "" } }, "created_at": "", "updated_at": "", "version": "", "managed_account_for_issuer_disbursement": { "baas": { "account_number": "", "holder_type": "BUSINESS" }, "product_configuration": { "if_existing": "REUSE", "type": "BORROWER_ACOUNT_FOR_ORIGINATOR" } }, "disbursement_attempts": [ { "id": "", "status": "PARTIAL", "status_description": "", "payment_orders": [ { "id": "", "amount": "", "type": "PIX_OUT", "status": "ERROR", "beneficiary_account": { "registered_account_id": "", "holder": { "name": "", "taxpayer_id": "" }, "external_bank_account": { "bank_account": "", "bank_account_digit": "", "bank_branch": "", "bank_code": "", "bank_account_type": "TRAN", "ispb_code": "" }, "pix": { "key": "", "key_type": "EMAIL" }, "baas": { "account_number": "" } }, "beneficiary_type": "EXTERNAL_REGISTERED_ACCOUNT" }, { "id": "", "amount": "", "type": "TED_OUT", "status": "SUCCESS", "beneficiary_account": { "registered_account_id": "", "holder": { "name": "", "taxpayer_id": "" }, "external_bank_account": { "bank_account": "", "bank_account_digit": "", "bank_branch": "", "bank_code": "", "bank_account_type": "TRAN", "ispb_code": "" }, "pix": { "key": "", "key_type": "TAXPAYER_ID" }, "baas": { "account_number": "" } }, "beneficiary_type": "EXTERNAL_REGISTERED_ACCOUNT" } ], "requested_at": "", "processed_at": "", "application_managed_account_for_issuer_disbursement": { "baas": { "account_number": "", "holder_type": "PERSON" }, "product_configuration": { "if_existing": "REUSE", "type": "BORROWER_ACOUNT_FOR_ORIGINATOR" } }, "created_at": "", "updated_at": "", "version": "" }, { "id": "", "status": "PROCESSING", "status_description": "", "payment_orders": [ { "id": "", "amount": "", "type": "TED_OUT", "status": "SUCCESS", "beneficiary_account": { "registered_account_id": "", "holder": { "name": "", "taxpayer_id": "" }, "external_bank_account": { "bank_account": "", "bank_account_digit": "", "bank_branch": "", "bank_code": "", "bank_account_type": "SLRY", "ispb_code": "" }, "pix": { "key": "", "key_type": "EMAIL" }, "baas": { "account_number": "" } }, "beneficiary_type": "BAAS_ACCOUNT" }, { "id": "", "amount": "", "type": "TED_OUT", "status": "PROCESSING", "beneficiary_account": { "registered_account_id": "", "holder": { "name": "", "taxpayer_id": "" }, "external_bank_account": { "bank_account": "", "bank_account_digit": "", "bank_branch": "", "bank_code": "", "bank_account_type": "SLRY", "ispb_code": "" }, "pix": { "key": "", "key_type": "ALEATORY_KEY" }, "baas": { "account_number": "" } }, "beneficiary_type": "BAAS_ACCOUNT" } ], "requested_at": "", "processed_at": "", "application_managed_account_for_issuer_disbursement": { "baas": { "account_number": "", "holder_type": "BUSINESS" }, "product_configuration": { "if_existing": "REUSE", "type": "BORROWER_ACOUNT_FOR_ORIGINATOR" } }, "created_at": "", "updated_at": "", "version": "" } ], "payment_orders": [ { "id": "", "amount": "", "type": "PIX_OUT", "status": "PROCESSING", "beneficiary_account": { "registered_account_id": "", "holder": { "name": "", "taxpayer_id": "" }, "external_bank_account": { "bank_account": "", "bank_account_digit": "", "bank_branch": "", "bank_code": "", "bank_account_type": "SVGS", "ispb_code": "" }, "pix": { "key": "", "key_type": "ALEATORY_KEY" }, "baas": { "account_number": "" } }, "beneficiary_type": "EXTERNAL_UNREGISTERED_ACCOUNT" }, { "id": "", "amount": "", "type": "TED_OUT", "status": "PROCESSING", "beneficiary_account": { "registered_account_id": "", "holder": { "name": "", "taxpayer_id": "" }, "external_bank_account": { "bank_account": "", "bank_account_digit": "", "bank_branch": "", "bank_code": "", "bank_account_type": "SVGS", "ispb_code": "" }, "pix": { "key": "", "key_type": "PHONE_NUMBER" }, "baas": { "account_number": "" } }, "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)