创建退款申请
Request
ENDPOINT
/transaction_reversal/fund_class/FUND_CLASS_KEY/transaction_reversalMÉTODO
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
| 字段 | 类型 | 描述 |
|---|---|---|
fund_class_key | string | QI CTVM 中基金唯一标识键 |
Body Params
| 字段 | 类型 | 描述 |
|---|---|---|
amount* | float | 待退款金额 |
description* | string | 退款描述 |
reversal_type* | string | 退款类型 |
reference_date* | string | 退款处理的参考日期 |
source_account_key | int | 退款来源账户唯一标识键 |
source_account | Account | 退款来源账户对象 |
target_account | Account | 退款目标账户对象 |
transaction_key | string | 现金系统中待退款转账的唯一标识键 |
target_pix_key | string | 目标账户的 PIX 密钥 |
注意
source_account_key 和 source_account 字段以及 target_account、transaction_key 和 target_pix_key 字段分别是待退款金额来源和退款目标的标识符。每组各发送1个字段,若发送多个,将返回400错误。
Account
| 字段 | 类型 | 描述 | 字符数 |
|---|---|---|---|
account_number | string | 账户号码 | 最多50 |
account_digit | string | 账户校验位 | 1 |
account_branch | string | 支行编号 | 最多4 |
financial_institution | JSON | 金融机构对象 | - |
owner | JSON | 持有人对象 | - |
Financial institution
| 字段 | 类型 | 描述 | 字符数 |
|---|---|---|---|
ispb | string | 巴西支付系统标识符 | 8 |
code | string | 金融机构代码 | 3 |
name | string | 金融机构名称 | 最多255 |
Owner
| 字段 | 类型 | 描述 | 字符数 |
|---|---|---|---|
name | string | 持有人姓名 | 最多255 |
document_number | string | 持有人证件号 | 14或18 |