跳到主要内容

申请退还已收到的 Pix

Pix 退款可在收到后 90 天内进行。

Request

ENDPOINT
/account/ACCOUNT_KEY/pix_transfer/PIX_TRANSFER_KEY/reversal
MÉTODO
POST

路径参数

字段类型描述字符数
account_key *uuidv4账户唯一标识键。36
pix_transfer_key *uuidv4QI 系统中 Pix 转账的唯一标识键。36
Request Body
{
"request_control_key": "303393bf-8f2e-4ff0-b326-ee7ad612e8ca",
"reversal_amount": 147,
"reversal_reason": "client_request",
"reversal_message": "Mensagem Pix da Devolução",
"tfa_info": {
"approver_document_number": "98765432100",
"contact_type": "email"
}
}

请求参数

字段类型描述字符数
request_control_key *uuidv4请求唯一性键。36
reversal_amount *number退款金额。11
reversal_reason *string退款原因。reversal_reason 枚举值
reversal_messagestring退款消息。140
tfa_info*Object包含账户审批人文件号码和联系方式的对象。tfa_info 对象

reversal_reason 枚举值

枚举值描述
client_request账户持有人申请的情况。
reconciliation因操作错误进行对账。

tfa_info 对象

字段类型描述字符数
approver_document_number*string账户审批人的文件号码。11
contact_type*string与账户审批人的联系方式,可以是 smsemail

Response

STATUS
202
Response Body: 退款已申请
{
"reversal_status": "pending_2fa_approval",
"end_to_end_id": "E32402502202405081755SxyT2DDcVwc",
"pix_transfer_key": "cdcf0d25-08a1-46e3-902a-6d7ca75e6c48",
"request_control_key": "7c5a1425-73eb-420e-b4fb-0ce3386c7d0c",
"created_at": "2021-10-22T20:30:23.459Z"
}

Response Body

字段类型描述字符数
reversal_statusenumerator退款交易状态枚举值。reversal_status 枚举值
transfer_amountnumber退款转账金额。11
pix_transfer_keyuuidv4退款中执行的 Pix 交易键。36
request_control_keyuuidv4客户使用的请求唯一标识键。36
created_atstring退款日期和时间。10

reversal_status 枚举值

枚举值描述
sentPix 转账已成功完成。
pendingPix 转账待处理。
pending_2fa_approvalPix 转账待双因素审批
rejectedPix 转账已拒绝。
STATUS
4xx
Response Body: 退款已拒绝
{
"title": "titulo",
"description": "description in English",
"translation": "descrição em portugues",
"code": "codigo",
"extra_fields": {
"pix_transfer_data": {
"request_control_key": "b6804f32-101e-4702-8fbc-c2dbc4c2caec",
"pix_transfer_key": "8cb70dea-9fb0-4a68-9572-99a72849c8d6",
"end_to_end_id": "E32402502202405081755SxyT2DDcVwc",
"pix_transfer_status": "rejected",
"created_at": "2021-10-22T20:30:23.459Z"
}
}
}
信息

除了之前列出的 Pix 转账 错误外,Pix 退款还可能返回以下错误。

HTTP 代码
status
QI 代码
code
标题
title
描述(英文)
description
描述(葡文)
translation
400QIT000001Bad RequestSchema ErrorErro de Schema
404PXT000018Reversal Original Transfer not FoundReversal original pix transfer not found.Transferência original da devolução não foi encontrada.
400PXT000017Reversal Too GreatReversal transfers sum amount surpasses that of original pix transfer.A soma das transferências de devolução ultrapassam o valor da transferência pix original.
400PXT000015Reversal date expiredReversal original transaction is older than 90 daysA data de criação da transação original é mais antiga que 90 dias
400PXT0000127Invalid Reversal ReasonReversal reason {reversal_reason} is not validRazão de reversão {reversal_reason} não é válida