取消退款请求

间接参与者可在必要时取消退款请求。

只有创建退款请求的参与者（直接或间接）才能取消它。

取消时，状态必须为 OPEN。

重要

巴西中央银行规定，间接参与者收到退款请求后 1 天内，退款请求必须被关闭。

如果间接参与者出现延误，QI Tech 将以 totally_accepted 状态关闭退款请求，以避免机构受到巴西中央银行的处罚。

请求

ENDPOINT

/pix/refund_request/REFUND_REQUEST_KEY

MÉTODO

PATCH

请求体

{
    "refund_request_status": "cancelled",
    "request_control_key": "e09aba97-0051-4c18-b645-1cb3c2581c34"
}

路径参数

字段	类型	描述	字符数
`refund_request_key` *	string	已创建退款的 UUID4。	36

请求体参数

字段	类型	描述	字符数
`refund_request_status` *	string	退款更新状态。	36
`request_control_key` *	uuidv4	用于查询所发起请求的 UUID4。	36

响应

STATUS

200

响应体

{
  "refund_request_key": "47633091-7d44-4d10-9d00-1f937104e537",
  "pix_transfer_key": "2bcbfd65-8660-4cb0-8ae4-4c4b327b32be",
  "end_to_end_id": "E73856642202407011350E8cnA3Ae7r3",
  "requested_amount": 10,
  "refund_request_status": "cancelled",
  "refund_request_type": "operational_flaw",
  "infraction_report_key": null,
  "refund_request_details": "Foi identificada uma fraude na transação.",
  "requesting_participant": "73856642",
  "contested_participant": "99999999",
  "analysis_result": null,
  "analysis_details": null,
  "reject_reason": null,
  "refund_transfer_key": null,
  "refunded_amount": 0.00,
  "refund_request_direction": "outgoing",
  "created_at": "2024-07-01T13:50:30Z"
}

响应体参数

字段	类型	描述	字符数
`pix_transfer_key`*	string	PIX 交易唯一标识符。	36
`refund_request_key`*	string	退款唯一标识符。	36
`infraction_report_key`*	string	与退款相关的违规唯一标识符。仅当类型为欺诈时。	36
`refund_request_type`	enum	退款请求类型。	refund_request_type 枚举值
`requested_amount`*	float	退款金额。	-
`refund_request_status`*	enum	状态。	refund_request_status 枚举值
`contested_participant`*	string	被贷记参与者（被争议方）的 ISPB。	8
`requesting_participant`*	string	被借记参与者（请求方，即提出退款请求的一方）的 ISPB。	8
`refund_request_details`*	string	退款详情。	-
`analysis_result`*	enum	退款关闭分析结果。	analysis_result 枚举值
`analysis_details`*	string	退款关闭分析详情。	-
`reject_reason`*	string	退款被拒绝时的拒绝原因（以 REJECTED 关闭时）。	reject_reason 枚举值
`refund_transfer_key`*	string	退款交易的 pix_transfer_key（接受关闭时）。	-
`refunded_amount`*	float	退款交易中已退还的金额。	-
`refund_request_direction`*	string	退款请求方向。	refund_request_direction 枚举值
`created_at` *	string	退款请求创建日期。	24

refund_request_status 枚举值

字段	描述
`open`	退款请求已创建并在 BACEN 中开放。
`cancelled`	退款请求在 BACEN 中已取消。
`closed`	退款请求在 BACEN 中已关闭。

refund_request_type 枚举值

字段	描述
`fraud`	退款请求源于欺诈行为。
`operational_flaw`	退款请求源于内部错误。

analysis_result 枚举值

字段	描述
`totally_accepted`	退款请求已完全接受。
`partially_accepted`	退款请求已部分接受。
`rejected`	退款请求已被拒绝。

reject_reason 枚举值

字段	描述
`no_balance`	账户余额不足以进行退款。
`account_closure`	账户已关闭，因此无法进行退款。
`other`	其他原因。

refund_request_direction 枚举值

字段	描述
`outgoing`	参与者是退款请求的发起方。
`incoming`	参与者是退款请求的目标方。

请求​

路径参数​

请求体参数​

响应​

响应体参数​

refund_request_status 枚举值​

refund_request_type 枚举值​

analysis_result 枚举值​

reject_reason 枚举值​

refund_request_direction 枚举值​

请求