完整說明見 Hosted Checkout 與 Payment Link。
POST/api/Checkout— 後端直接完成一筆結帳(需要 Idempotency-Key)
| 屬性 | 值 |
|---|
| 所需權限 | payment_links:write |
| Idempotency-Key | 必填 |
| 財務操作 | 是——會移動款項 |
| 參數 | 位置 | 型別 | 必填 |
|---|
customerEmail | body | string (email) | |
customerId | body | string | |
customerName | body | string | |
paymentLinkToken | body | string | |
paymentMethodRefId | body | string | |
priceId | body | string | |
promotionCode | body | string | |
quantity | body | integer (int32) | |
tokenRef | body | string | |
GET/api/Checkout/{checkoutId}— 查詢一筆結帳與它的付款狀態(App 收款後由後端確認用,paid 為 true 才算付款成功)
| 屬性 | 值 |
|---|
| 所需權限 | payment_links:read |
| Idempotency-Key | 不需要 |
| 參數 | 位置 | 型別 | 必填 |
|---|
checkoutId | path | string | 必填 |
GET/api/PaymentLink— 列出 Payment Link
| 屬性 | 值 |
|---|
| 所需權限 | payment_links: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/PaymentLink— 建立一個新的 Payment Link
| 屬性 | 值 |
|---|
| 所需權限 | payment_links:write |
| Idempotency-Key | 不需要 |
| 參數 | 位置 | 型別 | 必填 |
|---|
amount | body | integer (int32) | |
currency | body | string | |
description | body | string | |
designId | body | string | |
expiresAt | body | string (date-time) | |
maxCompletions | body | integer (int32) | |
metadata | body | object | |
name | body | string | |
priceId | body | string | |
quantity | body | integer (int32) | |
singleUse | body | boolean | |
successUrl | body | string (uri) | |
unitAmount | body | integer (int32) | |
GET/api/PaymentLink/{paymentLinkId}— 讀取單一 Payment Link
| 屬性 | 值 |
|---|
| 所需權限 | payment_links:read |
| Idempotency-Key | 不需要 |
| 參數 | 位置 | 型別 | 必填 |
|---|
paymentLinkId | path | string | 必填 |
PUT/api/PaymentLink/{paymentLinkId}— 更新付款連結。
| 屬性 | 值 |
|---|
| 所需權限 | payment_links:write |
| Idempotency-Key | 不需要 |
| 參數 | 位置 | 型別 | 必填 |
|---|
paymentLinkId | path | string | 必填 |
designId | body | string | |
expiresAt | body | string (date-time) | |
maxCompletions | body | integer (int32) | |
name | body | string | |
quantity | body | integer (int32) | |
successUrl | body | string (uri) | |
POST/api/PaymentLink/{paymentLinkId}/Archive— 付款連結:Archive。
| 屬性 | 值 |
|---|
| 所需權限 | payment_links:write |
| Idempotency-Key | 不需要 |
| 參數 | 位置 | 型別 | 必填 |
|---|
paymentLinkId | path | string | 必填 |
POST/api/PaymentLink/{paymentLinkId}/Complete— 付款連結:Complete。
| 屬性 | 值 |
|---|
| 所需權限 | payment_links:write |
| Idempotency-Key | 必填 |
| 財務操作 | 是——會移動款項 |
| 參數 | 位置 | 型別 | 必填 |
|---|
paymentLinkId | path | string | 必填 |
customerEmail | body | string (email) | |
customerId | body | string | |
customerName | body | string | |
paymentMethodRefId | body | string | |
priceId | body | string | |
promotionCode | body | string | |
tokenRef | body | string | |
POST/api/PaymentLink/{paymentLinkId}/Disable— 付款連結:Disable。
| 屬性 | 值 |
|---|
| 所需權限 | payment_links:write |
| Idempotency-Key | 不需要 |
| 參數 | 位置 | 型別 | 必填 |
|---|
paymentLinkId | path | string | 必填 |
POST/api/PaymentLink/{paymentLinkId}/Duplicate— 付款連結:Duplicate。
| 屬性 | 值 |
|---|
| 所需權限 | payment_links:write |
| Idempotency-Key | 不需要 |
| 參數 | 位置 | 型別 | 必填 |
|---|
paymentLinkId | path | string | 必填 |
POST/api/PaymentLink/{paymentLinkId}/Enable— 付款連結:Enable。
| 屬性 | 值 |
|---|
| 所需權限 | payment_links:write |
| Idempotency-Key | 不需要 |
| 參數 | 位置 | 型別 | 必填 |
|---|
paymentLinkId | path | string | 必填 |