Payment Link 與 Checkout

分享式收款連結,以及後端直接結帳。

檢視 Markdown

完整說明見 Hosted Checkout 與 Payment Link。

POST/api/Checkout— 後端直接完成一筆結帳(需要 Idempotency-Key)
屬性值
所需權限payment_links:write
Idempotency-Key必填
財務操作是——會移動款項
參數位置型別必填
customerEmailbodystring (email)
customerIdbodystring
customerNamebodystring
paymentLinkTokenbodystring
paymentMethodRefIdbodystring
priceIdbodystring
promotionCodebodystring
quantitybodyinteger (int32)
tokenRefbodystring
GET/api/Checkout/{checkoutId}— 查詢一筆結帳與它的付款狀態(App 收款後由後端確認用,paid 為 true 才算付款成功)
屬性值
所需權限payment_links:read
Idempotency-Key不需要
參數位置型別必填
checkoutIdpathstring必填
GET/api/PaymentLink— 列出 Payment Link
屬性值
所需權限payment_links:read
Idempotency-Key不需要
參數位置型別必填
pagequeryinteger (int32)
pageSizequeryinteger (int32)
orderByquerystring
orderDirectionquerystring
createdFromquerystring (date-time)
createdToquerystring (date-time)
POST/api/PaymentLink— 建立一個新的 Payment Link
屬性值
所需權限payment_links:write
Idempotency-Key不需要
參數位置型別必填
amountbodyinteger (int32)
currencybodystring
descriptionbodystring
designIdbodystring
expiresAtbodystring (date-time)
maxCompletionsbodyinteger (int32)
metadatabodyobject
namebodystring
priceIdbodystring
quantitybodyinteger (int32)
singleUsebodyboolean
successUrlbodystring (uri)
unitAmountbodyinteger (int32)
GET/api/PaymentLink/{paymentLinkId}— 讀取單一 Payment Link
屬性值
所需權限payment_links:read
Idempotency-Key不需要
參數位置型別必填
paymentLinkIdpathstring必填
PUT/api/PaymentLink/{paymentLinkId}— 更新付款連結。
屬性值
所需權限payment_links:write
Idempotency-Key不需要
參數位置型別必填
paymentLinkIdpathstring必填
designIdbodystring
expiresAtbodystring (date-time)
maxCompletionsbodyinteger (int32)
namebodystring
quantitybodyinteger (int32)
successUrlbodystring (uri)
POST/api/PaymentLink/{paymentLinkId}/Archive— 付款連結:Archive。
屬性值
所需權限payment_links:write
Idempotency-Key不需要
參數位置型別必填
paymentLinkIdpathstring必填
POST/api/PaymentLink/{paymentLinkId}/Complete— 付款連結:Complete。
屬性值
所需權限payment_links:write
Idempotency-Key必填
財務操作是——會移動款項
參數位置型別必填
paymentLinkIdpathstring必填
customerEmailbodystring (email)
customerIdbodystring
customerNamebodystring
paymentMethodRefIdbodystring
priceIdbodystring
promotionCodebodystring
tokenRefbodystring
POST/api/PaymentLink/{paymentLinkId}/Disable— 付款連結:Disable。
屬性值
所需權限payment_links:write
Idempotency-Key不需要
參數位置型別必填
paymentLinkIdpathstring必填
POST/api/PaymentLink/{paymentLinkId}/Duplicate— 付款連結:Duplicate。
屬性值
所需權限payment_links:write
Idempotency-Key不需要
參數位置型別必填
paymentLinkIdpathstring必填
POST/api/PaymentLink/{paymentLinkId}/Enable— 付款連結:Enable。
屬性值
所需權限payment_links:write
Idempotency-Key不需要
參數位置型別必填
paymentLinkIdpathstring必填