{"title":"Capture","category":"default","creationDate":1672054680,"content":"

By default, payments are captured<\/a> automatically without a delay, immediately after authorization<\/a> of the payment request.<\/p>\n

For some payment methods, you can capture a payment separately from authorization. We refer to this as manual capture. The authorization reserves the funds on the shopper's bank account. Then, when you send a request to capture the payment, the reserved funds are transferred from the shopper's bank account to your account.<\/p>\n

For point-of-sale payments, it is usually recommended to set up a delay between authorization and capture. In case of a mistake, you can then cancel the authorization instead of having to issue a refund.<\/p>\n

Requirements<\/h2>\n

Before you begin, take into account the following requirements, limitations, and preparations.<\/p>\n\n\n\n\n\n\n\n\n\n
Requirement<\/th>\nDescription<\/th>\n<\/tr>\n<\/thead>\n
Integration type<\/strong><\/td>\nA Terminal API<\/a> integration<\/td>\n<\/tr>\n
Customer Area roles<\/a><\/strong><\/td>\nTo edit capture settings, make sure that you have the following roles:
  • Merchant admin<\/strong><\/li>
  • View Payments<\/strong><\/li>
  • Merchant manage payments<\/strong><\/li><\/ul><\/td>\n<\/tr>\n
Webhooks<\/a><\/strong><\/td>\nListen to the following webhook events:
Limitations<\/strong><\/td>\nMost wallet payment methods do not support separate capture of in-person payments.
Alipay and WeChat Pay are always captured immediately; these wallets do not support delayed capture.<\/td>\n<\/tr>\n
Setup steps<\/strong><\/td>\nIf you intend to use multiple partial captures<\/a>, ask our Support Team<\/a> to enable that feature.<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n

Types of capture<\/h2>\n

For payments that support separate capture, you can set up one of the following, so that payments do not automatically get captured immediately after authorization:<\/p>\n\n\n\n\n\n\n\n
Type of capture<\/th>\nDescription<\/th>\n<\/tr>\n<\/thead>\n
Automatic capture<\/td>\nCapture happens automatically without a delay. This is the default.<\/td>\n<\/tr>\n
Delayed automatic capture<\/a><\/td>\nSet an amount of time between authorization and capture. The capture happens automatically after the time delay that you set.

The delay gives you time to cancel the authorization<\/a> when a mistake was made or the shopper changed their mind after the payment terminal approved the transaction. Without capture delay, you would need to issue a refund. <\/td>\n<\/tr>\n
Manual capture<\/a><\/td>\nSet a separate capture that does not happen automatically. After a payment is authorized, you must manually capture the payment.

Manual capture lets you settle funds on fulfillment, for example, when customers close their bar tab or check out of a hotel. It is also part of flows like authorization adjustment<\/a> and tipping on the receipt<\/a>.

Some payment methods also allow partial manual capture<\/a>.<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n

Partial manual capture<\/h3>\n\n\n\n\n\n\n
Type of partial capture<\/th>\nDescription<\/th>\n<\/tr>\n<\/thead>\n
Single partial capture<\/td>\nAny unclaimed amount that is left over after partially capturing a payment is automatically cancelled.

With some schemes, you can flag each payment request as either a pre-authorization or a final authorization. For partial captures, we recommend that you flag the payment request as a pre-authorization. For more information, refer to Authorization types<\/a>.<\/td>\n<\/tr>\n
Multiple partial captures<\/td>\nThe unclaimed amount after an initial partial capture is not automatically cancelled. This is useful in omnichannel scenarios where the shopper orders items in a physical store. If you have an order with multiple items to ship separately, each shipment correlates to a partial capture.

Multiple partial capture is disabled by default, so you need to contact our Support Team<\/a> to enable this feature.<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n

Delayed automatic capture<\/h2>\n

When you set up delayed automatic capture, you specify the amount of time between authorization and capture. You can enable it in your Customer Area for every payment, or in the API request for an individual payment. The setting in the API request for an individual payment overrides the setting in the Customer Area.<\/p>\n\n

\n
\n \n <\/tabs>\n <\/div>\n<\/div>\n\n
\n

A payment that is automatically captured does not<\/em> trigger a separate CAPTURE webhook. If you are using delayed automatic capture, consider enabling a CAPTURE webhook<\/a>. To do this, enable the default event codes<\/a> CAPTURE<\/code> and CAPTURE_FAILED<\/code> in the Standard webhook, and turn on Delayed Capture<\/strong> in the webhook settings<\/a>.<\/p>\n<\/div><\/div>\n

Manual capture<\/h2>\n

When you set up manual capture, you must send a capture request after the payment is authorized. After capturing, the funds for the payment get transferred to your account.<\/p>\n

To use manual capture:<\/p>\n

    \n
  1. Enable manual capture<\/a>, either for every payment or for an individual payment.<\/li>\n
  2. Capture the payment<\/a>.<\/li>\n<\/ol>\n

    Enable manual capture<\/h3>\n

    You can enable manual capture in your Customer Area for every payment, or in the API request for an individual payment. The setting in the API request for an individual payment overrides the setting in the Customer Area.<\/p>\n\n

    \n
    \n \n <\/tabs>\n <\/div>\n<\/div>\n\n

    Capture a payment<\/h3>\n

    When you have enabled manual capture<\/a>, either for your account or for an individual transaction, you need to capture the payment as follows:<\/p>\n

      \n
    1. \n

      From the \n transactionID<\/code>\n<\/a> field in the payment response<\/a> , get the pspReference<\/code> of the authorization you want to capture.<\/p>\n

        \n
      1. \n

        Make a POST request to the \/payments\/{paymentPspReference}\/captures<\/a> endpoint, where paymentPspReference<\/code> is the pspReference<\/code> of the authorization you want to capture.
        <\/p>\n

        In your request, include:<\/p>\n\n\n\n\n\n\n\n\n
        Parameter<\/th>\nRequired<\/th>\nDescription<\/th>\n<\/tr>\n<\/thead>\n
        merchantAccount<\/code><\/td>\n\"-white_check_mark-\"<\/td>\nThe name of your merchant account that is used to process the payment.<\/td>\n<\/tr>\n
        amount.value<\/code><\/td>\n\"-white_check_mark-\"<\/td>\nThe amount in minor units<\/a> (without a decimal point) being captured.
        To capture the full amount, specify a value<\/code> equal to the requestedAmount<\/code> you authorized in the         payment request<\/a>.
        To make a partial capture, specify a value<\/code> less than the requestedAmount<\/code> you authorized in the         payment request<\/a>. The remainder is released back to the shopper's card. <\/td>\n<\/tr>\n
        amount.currency<\/code><\/td>\n\"-white_check_mark-\"<\/td>\nThis must match the currency of the payment you are capturing.<\/td>\n<\/tr>\n
        reference<\/code><\/td>\n<\/td>\nYour unique identifier for the capture operation. The reference<\/code> field is useful to tag a partial capture for future reconciliation.<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n<\/li>\n<\/ol>\n

        The following example shows how to capture a EUR 25.00 payment authorization that has the pspReference<\/code> WNS7WQ756L2GWR82<\/strong>.<\/p>\n

        \n

        The request header must include the x-api-key<\/code> parameter set to your API key<\/a>.
        \n<\/div><\/div> <\/p>\n

        \n<\/code-sample>\n<\/div>\n<\/li>\n
      2. \n

        In the capture response, note the following:<\/p>\n