版本:202201
查询退款单列表
GET/openapi/2024-07/shoplazza-payment/refunds
分页返回退款单列表,可按状态和创建时间范围过滤。
请求
Query参数
- succeeded: 退款处理成功。
- failed: 退款失败,未退回资金。
- processing: 退款处理中,最终结果待确认。
cursor string
分页游标。
limit int32
A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
status string
按状态筛选退款单。
created_at_min string
按发起时间过滤的起始值。支持 Unix 时间(如 1730548810)或 ISO 时间字符串(如 2018-11-02T12:30:10Z)。
created_at_max string
按发起时间过滤的结束值。支持 Unix 时间(如 1730548810)或 ISO 时间字符串(如 2018-11-02T12:30:10Z)。
响应
- 200
- 400
OK
- application/json
- 数据结构
- 示例
数据结构
- Array [
- succeeded: 退款成功。
- failed: 退款失败。
- processing: 退款处理中。
- ]
codestring
error code
messagestring
error message
data object
Response: Refund order list
has_moreboolean
list object[]
退款单记录列表。
idstring
退款 ID。
store_idstring
与退款关联的店铺 ID。
balance_currencystring
余额使用的货币。
transaction_order_idstring
与退款关联的交易订单 ID。
statusstring
退款状态。
amountstring
退款金额。
currencystring
退款的货币代码(如 USD)。
original_order_amountstring
退款前的原始订单金额。
created_atstring
退款创建时间(ISO-8601 格式)。
completed_atstring
退款完成时间(ISO-8601 格式)。
cursorstring
分页游标。
{
"code": "string",
"message": "string",
"data": {
"has_more": true,
"list": [
{
"id": "string",
"store_id": "string",
"balance_currency": "string",
"transaction_order_id": "string",
"status": "string",
"amount": "string",
"currency": "string",
"original_order_amount": "string",
"created_at": "string",
"completed_at": "string"
}
],
"cursor": "string"
}
}
InvalidParameter
- application/json
- 数据结构
- 示例
- 示例
数据结构
codestring
error code
messagestring
error message
{
"code": "string",
"message": "string"
}
{
"code": "InvalidParameter",
"message": "wrong cursor"
}