完整流程見 退款與 Idempotency。
GET/api/Refund— 列出退款
| 屬性 | 值 |
|---|
| 所需權限 | refunds:read |
| Idempotency-Key | 不需要 |
| 參數 | 位置 | 型別 | 必填 |
|---|
page | query | integer (int32) | |
pageSize | query | integer (int32) | |
orderBy | query | string | |
orderDirection | query | string | |
createdFrom | query | string (date-time) | |
createdTo | query | string (date-time) | |
POST/api/Refund— 對一筆付款申請退款(需要 Idempotency-Key)
| 屬性 | 值 |
|---|
| 所需權限 | refunds:write |
| Idempotency-Key | 必填 |
| 財務操作 | 是——會移動款項 |
| 參數 | 位置 | 型別 | 必填 |
|---|
amount | body | integer (int32) | |
paymentId | body | string | |
reason | body | string | |
GET/api/Refund/{refundId}— 讀取單一退款
| 屬性 | 值 |
|---|
| 所需權限 | refunds:read |
| Idempotency-Key | 不需要 |
| 參數 | 位置 | 型別 | 必填 |
|---|
refundId | path | string | 必填 |