付款 (Payments)

付款讀取,以及嘗試/對帳。

檢視 Markdown

付款記錄的狀態包含 Succeeded、Failed、Unknown(見 Sandbox 與正式環境)。Unknown 一定要用對帳端點確認,不可以直接重試。

GET/api/Payment— 列出付款
屬性值
所需權限payments:read
Idempotency-Key不需要
參數位置型別必填
pagequeryinteger (int32)
pageSizequeryinteger (int32)
orderByquerystring
orderDirectionquerystring
createdFromquerystring (date-time)
createdToquerystring (date-time)
GET/api/Payment/{paymentId}— 讀取單一付款
屬性值
所需權限payments:read
Idempotency-Key不需要
參數位置型別必填
paymentIdpathstring必填
POST/api/Payment/{paymentId}/Attempt— 在 Sandbox 模擬一次扣款嘗試(需要 Idempotency-Key)
屬性值
所需權限payments:write
Idempotency-Key必填
財務操作是——會移動款項
參數位置型別必填
paymentIdpathstring必填
POST/api/Payment/{paymentId}/Reconcile— 確認一筆 unknown 付款的最終結果(需要 Idempotency-Key)
屬性值
所需權限payments:write
Idempotency-Key必填
財務操作是——會移動款項
參數位置型別必填
paymentIdpathstring必填