Capture

Captures the payment. If confirmation and payment confirmation are separated and a payment confirmation has been made, the merchant must call this API to execute the capture and complete the payment.

POST /v3/payments/authorizations/{transactionId}/capture

The captured amount may differ from the payment amount entered when calling the payment request API.

Set the read timeout to at least 60 seconds.

Request

Response

Path

Name	Description	Required
`transactionId`	Payment transaction ID. For more information, see the Transaction ID.

Query

None

Body

Name	Type	Description	Required
`amount`	number	Payment amount
`currency`	string	Payment currency code (ISO 4217). Supported currency codes are as follows. `"USD"` `"TWD"` `"THB"`

Name

Type

Description

Required

amount

number

Payment amount

currency

string

Payment currency code (ISO 4217). Supported currency codes are as follows.

"USD"
"TWD"
"THB"

Headers

Content-Type
X-LINE-Authorization
X-LINE-Authorization-Nonce
X-LINE-ChannelId
X-LINE-MerchantDeviceProfileId

For more information, see Request header.

Request examples

bash

curl -X POST \
     -H "Content-Type: application/json" \
     -H "X-LINE-ChannelId: YOUR_CHANNEL_ID" \
     -H "X-LINE-Authorization-Nonce: GENERATED_NONCE" \
     -H "X-LINE-Authorization: PROCESSED_SIGNATURE" \
     -H "X-LINE-MerchantDeviceProfileId: YOUR_DEVICE_PROFILE_ID" \
     -d '{
           "amount": 1000,
           "currency": "TWD"
         }' \
     https://sandbox-api-pay.line.me/v3/payments/authorizations/2018082512345678910/capture

Name	Type	Description
`info`	Object	Result information
`returnCode`	String	Result code. When the API call is successful, the value `0000` is returned. The other result codes are error codes, and if the codes `1199` and `1280`–`1298` are returned, the payment is automatically canceled. For more information, see Result code.
`returnMessage`	String	Result message. For more information on result messages, see Result code.