跳到主要内容

列出退款请求

如果间接参与者需要列出退款请求，可通过以下路由实现。

重要

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

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

请求​

ENDPOINT
/pix/refund_requests
MÉTODO
GET

查询参数​

字段类型描述字符数
refund_request_statusenum退款请求状态。refund_request_status 枚举值
refund_request_typeenum退款请求类型。refund_request_type 枚举值
initial_datestring搜索起始日期。日期格式
final_datestring搜索结束日期。日期格式
page_numberinteger当前查询的页码。-
page_sizeinteger每页结果数量。-

refund_request_status 枚举值​

字段类型描述字符数
openstring退款请求已创建并在 BACEN 中开放。4
cancelledstring退款请求在 BACEN 中已取消。9
closedstring退款请求在 BACEN 中已关闭。6

refund_request_type 枚举值​

字段类型描述字符数
fraudstring退款请求源于欺诈行为。5
operational_flawstring退款请求源于内部错误。16

日期格式​

字段类型描述字符数
initial_datestring搜索起始日期，格式为 "%Y-%m-%d"。示例："2023-10-09"。10
final_datestring搜索结束日期，格式为 "%Y-%m-%d"。示例："2023-10-11"。10

响应​

STATUS
200
响应体
{
  "data": [
    {
      "refund_request_key": "817c9331-fe1d-4178-aff2-8bed87ce3099",
      "pix_transfer_key": "029efb4e-ad3b-4ba5-a73c-c724f0d9c02b",
      "end_to_end_id": "E73856642202406282112pEBgwN7kkqD",
      "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-06-28T21:25:20Z",
      "refund_events": [
        {
          "event_type": "open",
          "event_details": "Solicitação de Devolução criada pelo participante indireto",
          "created_at": "2024-06-28T21:25:20Z"
        },
        {
          "event_type": "cancelled",
          "event_details": "Solicitação de Devolução cancelada pelo participante indireto",
          "created_at": "2024-06-28T21:27:19Z"
        }
      ]
    },
    {
      "refund_request_key": "5d174097-3d5c-41a2-a548-b24c41eecfb4",
      "pix_transfer_key": "d5856a5f-378f-43ed-818b-df33b9fae703",
      "end_to_end_id": "E60701190202406281828JCBxFsqssCf",
      "requested_amount": 10,
      "refund_request_status": "closed",
      "refund_request_type": "operational_flaw",
      "infraction_report_key": null,
      "refund_request_details": "Foi identificada uma fraude na transação.",
      "requesting_participant": "99999999",
      "contested_participant": "73856642",
      "analysis_result": "rejected",
      "analysis_details": null,
      "reject_reason": "no_balance",
      "refund_transfer_key": null,
      "refunded_amount": 0.00,
      "refund_request_direction": "incoming",
      "created_at": "2024-07-01T12:47:41Z",
      "refund_events": [
        {
          "event_type": "open",
          "event_details": "Solicitação de Devolução criada por outra instituição financeira",
          "created_at": "2024-07-01T12:47:41Z"
        }
      ]
    }
  ]
}

响应体参数​

字段类型描述字符数
pix_transfer_key*stringPIX 交易唯一标识符。36
refund_request_key*string退款唯一标识符。36
infraction_report_key*string与退款相关的违规唯一标识符。仅当类型为欺诈时。36
refund_request_typeenum退款请求类型。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_events*object退款请求事件对象。refund_events 对象
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_events 对象​

字段描述
event_type退款变更事件类型。refund_request_status 枚举值
event_details事件详情。
created_at事件创建日期。