請款

執行請款。在分開付款授權和請款和請求付款後，合作商店呼叫此API執行請款，方能完成付款。

POST /v2/payments/orders/{orderId}/capture

請款金額可能與請求付款時輸入的付款金額不同。

請將Read逾時設定為至少20秒以上。

Request

Response

Path

Name	Length	Description	Required
`orderId`	100	訂單號碼。輸入商家生成的用於管理訂單的ID。輸入時套用URL編碼。

Query

None

Body

Name	Type	Length	Description
`amount`	number		付款金額
`currency`	string	3	付款貨幣代碼(ISO 4217)。支援貨幣代碼如下。 `"USD"` `"TWD"` `"THB"`
`promotionRestriction`	object		促銷限制訊息。請輸入因法律、規則等原因不適用促銷的產品金額。

Name

Type

Length

Description

Required

amount

number

付款金額

currency

string

付款貨幣代碼(ISO 4217)。支援貨幣代碼如下。

"USD"
"TWD"
"THB"

promotionRestriction

object

促銷限制訊息。請輸入因法律、規則等原因不適用促銷的產品金額。

Headers

Content-Type
X-LINE-ChannelId
X-LINE-ChannelSecret
X-LINE-MerchantDeviceProfileId
X-LINE-MerchantDeviceType

詳細內容請參閱請求標頭。

Request examples

bash

curl -X POST \
     -H "Content-Type: application/json" \
     -H "X-LINE-ChannelId: YOUR_CHANNEL_ID" \
     -H "X-LINE-ChannelSecret: YOUR_CHANNEL_SECRET" \
     -H "X-LINE-MerchantDeviceProfileId: YOUR_DEVICE_PROFILE_ID" \
     -d '{
          "amount": 100,
          "currency": "THB",
          "extras" : {
            "promotionRestriction": {
              "useLimit": 20,
              "rewardLimit": 20
            }
          }' \
      https://sandbox-api-pay.line.me/v2/payments/orders/merchant_test_order_1/capture

Name	Type	Description
`info`	Object	結果訊息
`returnCode`	String	結果程式碼。API呼叫成功時，傳回`0000`代碼。其他結果碼為錯誤碼，如果回傳`1199`、`1280`至`1298`代碼，付款將自動取消。詳細內容請參閱結果程式碼。
`returnMessage`	String	結果訊息。結果訊息請參閱結果程式碼。