Creating Reversal Request
Request
ENDPOINT
/transaction_reversal/fund_class/FUND_CLASS_KEY/transaction_reversalMETHOD
POSTResponse
STATUS
201Response 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
| Field | Type | Description |
|---|---|---|
fund_class_key | string | Unique identifier key for the fund at QI CTVM |
Body Params
| Field | Type | Description |
|---|---|---|
amount* | float | Amount to be reversed |
description* | string | Description of the reversal performed |
reversal_type* | string | Type of reversal to be sent |
reference_date* | string | Reference date for reversal processing |
source_account_key | int | Unique identifier key for the reversal source account |
source_account | Account | Reversal source account object |
target_account | Account | Reversal target account object |
transaction_key | string | Unique identifier key for the transfer to reverse in the cash system |
target_pix_key | string | PIX 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
| Field | Type | Description | Characters |
|---|---|---|---|
account_number | string | Account number | Up to 50 |
account_digit | string | Account digit | 1 |
account_branch | string | Account branch | Up to 4 |
financial_institution | JSON | Financial institution object | - |
owner | JSON | Owner object | - |
Finacial institution
| Field | Type | Description | Characters |
|---|---|---|---|
ispb | string | Brazilian Payment System Identifier | 8 |
code | string | Financial institution code | 3 |
name | string | Financial institution name | Up to 255 |
Owner
| Field | Type | Description | Characters |
|---|---|---|---|
name | string | Owner name | up to 255 |
document_number | string | Owner document | 14 or 18 |