列出退款
开放待确认。 查看适用范围。
GET /v1/refunds
查询当前商户的退款列表,按创建时间倒序排列,创建时间相同时按 ID 倒序排列。未提供筛选条件时返回所有状态的退款;同时提供多个筛选条件时,结果须同时满足这些条件。
Attributes
| 属性 | 位置 | 类型 | 必填 | 说明 |
|---|---|---|---|---|
payment_intent | query | string | 否 | 按原收款的唯一标识筛选 |
attempt_id | query | string | 否 | 按付款标识筛选 |
status | query | string | 否 | 按退款状态筛选:requires_action、processing、succeeded、canceled |
page_size | query | integer | 否 | 每页数量,默认 20,范围 1–100 |
page_token | query | string | 否 | 上一页返回的 next_page_token;第一页不传 |
翻页时保持筛选条件不变,分页规则见通用约定。本接口无需 Idempotency-Key,无请求体。
请求示例
GET /v1/refunds?payment_intent=pi_example&status=succeeded&page_size=20
Authorization: Bearer inv_test_...
返回示例
200 OK,data 中的每一项均为完整的 Refund 对象。next_page_token 为空字符串表示没有下一页。
{
"data": [
{
"id": "re_example",
"attempt_id": "8b8fbb6b-4ec7-48d1-92a1-3b20c24b0c21",
"payment_intent": "pi_example",
"amount": "2.5",
"currency": "usdc",
"status": "succeeded",
"payment_method": {
"type": "erc20_transfer",
"erc20_transfer": {
"chain": 56,
"recipient_address": "0x1234567890abcdef1234567890abcdef12345678"
}
},
"next_action": null,
"last_execution_error": null,
"description": "Price adjustment",
"metadata": {
"return_id": "RETURN_001"
},
"created_at": "2026-10-27T08:00:00Z",
"updated_at": "2026-10-27T08:05:00Z"
}
],
"next_page_token": ""
}
没有匹配记录时返回 {"data":[],"next_page_token":""}。