跳到主要内容

列出所有退款

返回现有退款列表,最新的排在前面。默认情况下,响应包含最近 10 笔退款。

GET https://api.stripe.com/v1/refunds

示例​

运行以下 cURL 命令发送请求。

cURL
curl -X GET https://api.stripe.com/v1/refunds \
-u "<YOUR_SECRET_KEY>:"

参数​

查询参数​

参数类型必需说明
charge字符串可选要获取退款的扣款 ID。省略时,Stripe 返回账户的所有退款。
created对象或整数可选返回在日期范围内创建的退款。接受包含 gt、gte、lt 和 lte 键的范围对象,或接受 Unix 时间戳。
ending_before字符串可选分页游标。传入当前页第一个对象的 ID 以获取上一页。如果一次列表调用返回 100 个对象并以 obj_bar 开头,传入 obj_bar。
limit整数可选限制响应中的记录数。输入 1 到 100 的整数,默认值为 10。
payment_intent字符串可选要获取退款的 PaymentIntent ID。省略时,Stripe 返回账户的所有退款。
starting_after字符串可选分页游标。传入当前页最后一个对象的 ID 以获取下一页。如果一次列表调用返回 100 个对象并以 obj_foo 结尾,传入 obj_foo。
expand[]字符串数组可选标识需要补充数据并内联返回的嵌套响应对象。

响应​

响应使用标准状态码:200 表示成功,401 表示 API 密钥无效。完整列表见 Stripe 的错误代码。

200: OK

Response
{
"object": "list",
"url": "/v1/refunds",
"has_more": false,
"data": [
{
"id": "re_1Nispe2eZvKYlo2Cd31jOCgZ",
"object": "refund",
"amount": 212,
"balance_transaction": "txn_1Nispe2eZvKYlo2CYezqFhEx",
"charge": "ch_1NirD82eZvKYlo2CIvbtLWuY",
"created": 1692942318,
"currency": "usd",
"destination_details": {
"card": {
"reference": "123456789012",
"reference_status": "available",
"reference_type": "acquirer_reference_number",
"type": "refund"
},
"type": "card"
},
"metadata": {},
"payment_intent": "pi_1GszsK2eZvKYlo2CfhZyoZLp",
"reason": null,
"receipt_number": null,
"source_transfer_reversal": null,
"status": "succeeded",
"transfer_reversal": null
}
]
}

错误响应​

400: Bad Request

Response
{
"error": {
"code": "resource_missing",
"doc_url": "https://stripe.com/docs/error-codes/resource-missing",
"message": "No such charge: 'ch_1NirD82eZvKYlo2CIvbtLWuY'",
"param": "charge",
"request_log_url": "https://dashboard.stripe.com/test/logs/req_HIH2jWkJGecwCk?t=1754504399",
"type": "invalid_request_error"
}
}

401: Unauthorized

Response
{
"error": {
"type": "invalid_request_error",
"message": "Invalid API Key provided: sk_test_********************1234"
}
}