跳到主要内容

创建退款申请


Request

ENDPOINT
/transaction_reversal/fund_class/FUND_CLASS_KEY/transaction_reversal
MÉTODO
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

字段类型描述
fund_class_keystringQI CTVM 中基金唯一标识键

Body Params

字段类型描述
amount*float待退款金额
description*string退款描述
reversal_type*string退款类型
reference_date*string退款处理的参考日期
source_account_keyint退款来源账户唯一标识键
source_accountAccount退款来源账户对象
target_accountAccount退款目标账户对象
transaction_keystring现金系统中待退款转账的唯一标识键
target_pix_keystring目标账户的 PIX 密钥
注意

source_account_keysource_account 字段以及 target_accounttransaction_keytarget_pix_key 字段分别是待退款金额来源和退款目标的标识符。每组各发送1个字段,若发送多个,将返回400错误。

Account

字段类型描述字符数
account_numberstring账户号码最多50
account_digitstring账户校验位1
account_branchstring支行编号最多4
financial_institutionJSON金融机构对象-
ownerJSON持有人对象-

Financial institution

字段类型描述字符数
ispbstring巴西支付系统标识符8
codestring金融机构代码3
namestring金融机构名称最多255

Owner

字段类型描述字符数
namestring持有人姓名最多255
document_numberstring持有人证件号14或18