跳轉至主體

付款請求

使用合作商店終端機傳遞的訊息向LINE Pay伺服器請求付款。付款訊息中請註明顧客要付款的產品訊息和顧客向合作商店終端機提供的我的條碼(oneTimeKey)訊息以及合作商店訊息。付款請求處理完畢即完成付款。

如果分開付款授權和請款，即使呼叫此API，也不會完成付款，後續要請款或取消授權。

交易ID傳回回應，可以使用該交易ID請求取消授權、請款、退款。若發生Read逾時，無法接收回應，可查詢付款狀態確認結果，並確保交易ID。

POST /v2/payments/oneTimeKeys/pay

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

若已完成付款，請務必確認回應中的付款總金額(info.payInfo[].amount)與所要求的付款金額一致。若金額不一致，需在LINE Pay請求退款。

Path

None

Query

None

Body

Name
TypeLengthDescription
Required
amountnumber

付款金額

captureboolean

是否自動請款。請求付款後，決定同時處理付款授權與請款或分開處理。預設值為true。

  • true: 同時處理。
  • false: 分開處理。
currencystring3

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

  • "USD"
  • "TWD"
  • "THB"
extrasobject

付款附加訊息

oneTimeKeystring18 (TW), 12 (TH and Global)

LINE Pay用戶的我的條碼。合作商店的終端機掃描顧客的我的條碼所獲得的值。該值在顧客生成我的條碼後5分鐘內有效。

orderIdstring100

訂單號碼。輸入商家生成的用於管理訂單的ID。

productNamestring4000

產品名稱

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

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

Request examples

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 '{
          "productName": "test product",
          "amount": 100,
          "currency": "THB",
          "orderId": "merchant_test_order_1",
          "oneTimeKey": "123456789012",
          "extras" : {
            "addFriends" : [
              {
                "type" : "LINE_AT",
                "idList" : ["@aaa"]
              }
            ],
            "branchName" : "test_branch_1",
            "branchId" : "branch1"
          }
        }' \
      https://sandbox-api-pay.line.me/v2/payments/oneTimeKeys/pay