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"
},
},
"transaction_key": "4208d7d1-9077-4d00-aa4a-a4368b954867"
}

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 the reversal processing
source_account_keyintUnique identifier key of the reversal source account
source_accountAccountSource account object of the reversal
transaction_key*stringUnique identifier key of the transfer to reverse in the cash system
reference_keystringReference key of the transfer to reverse at the source bank
conciliation_fieldstringField for reconciliation across multiple expectations
end_to_end_idstringIdentifier of the Pix to reverse
external_keystringUnique key of the transaction to reverse at the source bank
bank_slip_settlement_group_keystringUnique key of the bankslip settlement to reverse at the source bank
Attention

The source_account_key and source_account fields identify the source of the amount to be reversed. 1 field of each must be sent; if multiple are sent, a 400 error is returned.

Account

FieldTypeDescriptionCharacters
account_numberstringAccount numberUp to 50
account_digitstringAccount digit1
account_branchstringAccount branchUp to 4
financial_institutionFinancial InstitutionFinancial institution object-
ownerOwnerOwner object-

Financial 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