跳到主要内容

退款列表

返回指定交易的退款列表。

GEThttps://api.efundpay.com/v4/transactions/{transaction_id}/refunds
This endpoint requires the transactions.read scope.

Authorizations

Authorizationstringheaderrequired

认证请求头,格式为 `Bearer <token>`,`<token>` 为您的认证令牌。

Headers

x-merchant-account-idstringrequired

用于本次请求的商户账户ID。

Examples:""default""

Path Parameters

transaction_idstringrequired

要查询退款的交易唯一标识。

Examples:"7099948d-7286-47e4-aad8-b68f7eb44591"
cursorstring

分页游标,用于指定要返回的结果页。

Examples:"0"
limitinteger

每页返回的最大条目数,默认为20,最大为100。

Examples:"20"

Response

application/json

Successful Response

itemsRefund · object[]required

该交易下的退款对象列表。

limitinteger

本页返回的退款数量。

Default:20
Required range:1 <= x <= 100
Examples:"20"
next_cursorstring | null

下一页的游标。

Required string length:1 - 1000
Examples:"2"
previous_cursorstring | null

上一页的游标。

Required string length:1 - 1000
Examples:"0"
curl --request GET \
--url https://api.efundpay.com/v4/transactions/{transaction_id}/refunds \
--header 'Authorization: Bearer <token>' \
--header 'x-merchant-account-id: <x-merchant-account-id>'
{
"items": [
{
"type": "refund", // 资源类型,固定为 "refund"
"id": "7099948d-7286-47e4-aad8-b68f7eb44591", // 退款唯一标识
"transaction_id": "45455948d-7286-47e4-aad8-b68f7eb22391", // 关联交易ID
"currency": "EUR", // 货币代码
"amount": 1299, // 退款金额(最小货币单位)
"status": "authorization_succeeded", // 退款状态
"external_identifier": "refund-12345", // 退款外部标识符
"transaction_external_identifier": "transaction-12345", // 原交易外部标识符
"reason": "用户申请退款", // 退款原因
"created_at": "2013-07-16T19:23:00.000+00:00" // 创建时间
}
],
"limit": 20, // 本页返回的退款数量
"next_cursor": "3", // 下一页游标
"previous_cursor": "1" // 上一页游标
}
Powered by Docusaurus