付款記錄的狀態包含 Succeeded、Failed、Unknown(見 Sandbox 與正式環境)。Unknown 一定要用對帳端點確認,不可以直接重試。
GET/api/Payment— 列出付款
| 屬性 | 值 |
|---|
| 所需權限 | payments: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) | |
GET/api/Payment/{paymentId}— 讀取單一付款
| 屬性 | 值 |
|---|
| 所需權限 | payments:read |
| Idempotency-Key | 不需要 |
| 參數 | 位置 | 型別 | 必填 |
|---|
paymentId | path | string | 必填 |
POST/api/Payment/{paymentId}/Attempt— 在 Sandbox 模擬一次扣款嘗試(需要 Idempotency-Key)
| 屬性 | 值 |
|---|
| 所需權限 | payments:write |
| Idempotency-Key | 必填 |
| 財務操作 | 是——會移動款項 |
| 參數 | 位置 | 型別 | 必填 |
|---|
paymentId | path | string | 必填 |
POST/api/Payment/{paymentId}/Reconcile— 確認一筆 unknown 付款的最終結果(需要 Idempotency-Key)
| 屬性 | 值 |
|---|
| 所需權限 | payments:write |
| Idempotency-Key | 必填 |
| 財務操作 | 是——會移動款項 |
| 參數 | 位置 | 型別 | 必填 |
|---|
paymentId | path | string | 必填 |