申请退还已收到的 Pix

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

Request

ENDPOINT

/account/ACCOUNT_KEY/pix_transfer/PIX_TRANSFER_KEY/reversal

MÉTODO

POST

路径参数

字段	类型	描述	字符数
`account_key` *	uuidv4	账户唯一标识键。	36
`pix_transfer_key` *	uuidv4	QI 系统中 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_message`	string	退款消息。	140
`tfa_info`*	Object	包含账户审批人文件号码和联系方式的对象。	tfa_info 对象

reversal_reason 枚举值

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

tfa_info 对象

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

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_status`	enumerator	退款交易状态枚举值。	reversal_status 枚举值
`transfer_amount`	number	退款转账金额。	11
`pix_transfer_key`	uuidv4	退款中执行的 Pix 交易键。	36
`request_control_key`	uuidv4	客户使用的请求唯一标识键。	36
`created_at`	string	退款日期和时间。	10

reversal_status 枚举值

枚举值	描述
sent	Pix 转账已成功完成。
pending	Pix 转账待处理。
pending_2fa_approval	Pix 转账待双因素审批
rejected	Pix 转账已拒绝。

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`
400	QIT000001	Bad Request	Schema Error	Erro de Schema
404	PXT000018	Reversal Original Transfer not Found	Reversal original pix transfer not found.	Transferência original da devolução não foi encontrada.
400	PXT000017	Reversal Too Great	Reversal 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.
400	PXT000015	Reversal date expired	Reversal original transaction is older than 90 days	A data de criação da transação original é mais antiga que 90 dias
400	PXT0000127	Invalid Reversal Reason	Reversal reason {reversal_reason} is not valid	Razão de reversão {reversal_reason} não é válida

Request​

路径参数​

请求参数​

reversal_reason 枚举值​

tfa_info 对象​

Response​

Response Body​

reversal_status 枚举值​