Skip to main content

Creating Reversal Request


Request

ENDPOINT
/transaction_reversal/fund_class/FUND_CLASS_KEY/transaction_reversal
METHOD
POST

Response

STATUS
201
Response Body
{
"amount": 125.25,
"description": "Estorno - transferência indevida",
"reversal_type": "pix",
"reference_date": "2025-01-01",
"source_account": {
"owner": {
"name": "Nome do Fundo",
"document_number": "123.805.491-24"
},
"account_digit": "8",
"account_branch": "0001",
"account_number": "1234567",
"financial_institution": {
"ispb": "32402502",
"code": "329",
"name": "QI Sociedade de Crédito Direto"
},
},
"target_pix_key": "exemplo@gmail.com"
}

Path Params

FieldTypeDescription
fund_class_keystringUnique identifier key for the fund at QI CTVM

Body Params

FieldTypeDescription
amount*floatAmount to be reversed
description*stringDescription of the reversal performed
reversal_type*stringType of reversal to be sent
reference_date*stringReference date for reversal processing
source_account_keyintUnique identifier key for the reversal source account
source_accountAccountReversal source account object
target_accountAccountReversal target account object
transaction_keystringUnique identifier key for the transfer to reverse in the cash system
target_pix_keystringPIX key of the target account
Attention

The fields source_account_key and source_account and the fields target_account, transaction_key and target_pix_key are identifier fields for the source of the amount to be reversed and the reversal destination respectively. 1 field from each must be sent, if multiple fields are sent, it will return a 400 error.

Account

FieldTypeDescriptionCharacters
account_numberstringAccount numberUp to 50
account_digitstringAccount digit1
account_branchstringAccount branchUp to 4
financial_institutionJSONFinancial institution object-
ownerJSONOwner object-

Finacial institution

FieldTypeDescriptionCharacters
ispbstringBrazilian Payment System Identifier8
codestringFinancial institution code3
namestringFinancial institution nameUp to 255

Owner

FieldTypeDescriptionCharacters
namestringOwner nameup to 255
document_numberstringOwner document14 or 18