Are you looking for test card numbers?

Would you like to contact support?

Point-of-sale icon

Capture payments

Learn about automatic, delayed, and manual capture of in-person payments.

Capture in Customer Area

You can also capture payments in your Customer Area. See Manage payments.

For payment methods that support separate capture, the payment is completed in two steps:

  1. Authorisation: The payment details of the shopper are verified with the issuer, and the funds are reserved.
  2. Capture: The reserved funds are transferred from the shopper to your account.

By default, payments are captured automatically without a delay, immediately after authorisation.
For payment methods that support separate authorisation and capture, you can also capture the payment later. You can:

  • Set up delayed automatic capture for your merchant account. After a payment is authorised, there is a delay before the payment is captured automatically.
  • Use manual capture: you capture payments individually by making a request to the /payments/paymentPspReference/captures endpoint.
    Before you can use manual capture, you need to enable it at the merchant account level, or at the transaction level. Enabling manual capture at the transaction level lets you use automatic capture (with or without delay) by default for your account, and also manually capture specific payments.
Alipay and WeChat Pay do not support delayed captures or manual captures. With these payment methods, payments are captured immediately.

When you have set up a capture delay or manual capture, you can cancel the authorisation on an uncaptured payment, if necessary. This releases the funds back to the shopper.

Delayed automatic capture

By default, payments are captured immediately after authorisation. Setting up a delay between the authorisation and the automatic capture of the payment gives you time to cancel the authorisation. This is useful when, for example:

  • A shopper changes their mind soon after purchase.
  • Store staff realize they made a mistake after a payment is Approved.
  • The shopper needs to provide a signature and your staff need some time to verify it.

Without capture delay, you would need to issue a refund in some of these situations.

To be able to change capture settings, you need to have the following user role:

  • Merchant admin

To set up a capture delay:

  1. Log in to your Customer Area.
  2. Switch to your merchant account.
  3. Go to Settings > Account settings.
  4. In the General settings, next to POS capture delay, select the edit icon .
  5. From the dropdown list, select a capture delay of minutes, hours, or days before point-of-sale payments are automatically captured.
    We recommend selecting a delay of 2 hours.
    If you no longer want to use delayed capture, select Immediate.
  6. Select Save.

A payment that is automatically captured does not trigger a separate CAPTURE notification webhook. If you are using delayed automatic capture, you can optionally receive CAPTURE webhooks. To enable this functionality, contact our Support Team.

Manual capture

Depending on your business model, you may prefer to manually capture your point-of-sale payments instead of automatically. This lets you settle funds, for example:

  • On fulfillment: You capture the payment when an order is shipped. Or when the customer closes their bar tab or checks out of the hotel.
  • On return: When the shopper returns unwanted items from an order, you capture the payment for the items they keep.

We recommend capturing a payment within 7 days of it being authorised. After this time, an authorisation may be cancelled by the issuer, which releases the funds back to the shopper.

With manual capturing, you can also cancel the authorisation. This releases the funds back to a shopper, and can be used in case of issues shipping an order, or when a shopper returns their whole order.

To use manual capture, you first need to enable it. Then you need to explicitly request a capture for the authorisation.

Partial manual capture

For partial captures, your account can be set to perform either:

In both cases, to partially capture a payment:

  • Make a manual capture request specifying:
    • amount.value: the partial amount that you want to capture. This amount must be smaller than the original authorised amount.

Single partial capture

For single partial captures, any unclaimed amount that is left over after partially capturing a payment is automatically cancelled.

For some schemes, you can flag each payment request as either a pre-authorisation or a final authorisation. For partial captures, we recommend that you flag the payment request as a pre-authorisation. For more information, refer to Authorisation types.

Multiple partial captures

When your account is enabled for multiple partial captures, the unclaimed amount after an initial capture is not automatically cancelled.
This is necessary for Unified Commerce scenarios where the shopper orders items in a physical store. If you have an order with multiple items to ship, each shipment would correlate to a partial capture.
To enable multiple partial captures, contact our Support Team.

Enable manual capture

You can enable manual capture by default for your account, or enable manual capture for an individual transaction.

Enable manual capture at account level

To be able to change capture settings, you need to have the following role:

  • Merchant admin

To enable manual capture:

  1. Log in to your Customer Area.
  2. Switch to your merchant account.
  3. Go to Settings > Account settings.
  4. In the General settings, next to POS capture delay, select the edit icon .
  5. From the dropdown list, select Manual.
  6. Select Save.

    If you no longer want to use manual capture, select Immediate as the POS capture delay, or select a capture delay.

  7. Set up webhook notifications. Manual capture is an asynchronous operation. We inform you whether this is successful with a CAPTURE notification.
  8. Generate an API key. To make manual capture requests, you need to have an API key.

    If you are using cloud-based communications, you can use the existing API key that you use for Terminal API calls.

Enable manual capture at transaction level

In your payment request, you can add a flag to enable manual capture for that transaction without changing the capture settings for your merchant account. After the payment is authorised, the amount is not captured until you send a manual capture request.

To set the capture method for an individual payment to manual:

  1. Make a PaymentRequest that contains a SaletoAcquirerData field with the manualCapture flag in one of the following formats:

    • Option 1: A JSON object converted to a Base64-encoded string.
      JSON object:

      {
          "additionalData": {
              "manualCapture": "true"
          }
      }

      Converted to a Base64-encoded string:
      "SaleToAcquirerData": "ewogICAgImFkZGl0aW9uYWxEYXRhIjogewogICAgICAgICJtYW51YWxDYXB0dXJlIjogInRydWUiCiAgICB9Cn0=

    • Option 2: A key-value pair manualCapture=true:
      "SaleToAcquirerData":"manualCapture=true"

    For instructions, see Option 1: Pass data elements as Base-64 encoded JSON.

    {
        "SaleToPOIRequest":{
            "MessageHeader":{
                "ProtocolVersion":"3.0",
                "MessageClass":"Service",
                "MessageCategory":"Payment",
                "MessageType":"Request",
                "SaleID":"POSSystemID12345",
                "ServiceID":"0207111104",
                "POIID":"V400m-324688179"
            },
            "PaymentRequest":{
                "SaleData":{
                    "SaleTransactionID":{
                        "TransactionID":"27908",
                        "TimeStamp":"2019-03-07T10:11:04+00:00"
                    },
                    "SaleToAcquirerData":"ewogICAgImFkZGl0aW9uYWxEYXRhIjogewogICAgICAgICJtYW51YWxDYXB0dXJlIjogInRydWUiCiAgICB9Cn0="
                },
                "PaymentTransaction":{
                    "AmountsReq":{
                        "Currency":"EUR",
                        "RequestedAmount":10.99
                    }
                }
            }
        }
    }

    The payment request is routed to the terminal, for the shopper to present their card and verify the payment.

  2. After the payment is authorised, perform a manual capture or partial manual capture, or cancel the authorisation.

Capture a payment

When you have enabled manual capture, either for your account or for an individual transaction, you need to capture the payment as follows:

  1. From the transactionID field in the payment response , get the pspReference of the authorisation you want to capture.
  2. Make a POST request to the /payments/paymentPspReference/captures endpoint, where paymentPspReference is the pspReference of the authorisation you want to capture.
    In your request, include:
    Parameter Required Description
    merchantAccount -white_check_mark- The name of your merchant account that is used to process the payment.
    amount.value -white_check_mark- The amount in minor units (without a decimal point) being captured.
    To capture the full amount, specify a value equal to the requestedAmount you authorised in the payment request.
    To make a partial capture, specify a value less than the requestedAmount you authorised in the payment request. The remainder is released back to the shopper's card.
    amount.currency -white_check_mark- This must match the currency of the payment you're capturing.
    reference Your unique identifier for the capture operation. The reference field is useful to tag a partial capture for future reconciliation.
    The next example shows how to capture a 25.00 EUR payment authorisation that has the pspReference WNS7WQ756L2GWR82.
    The request header must include the x-api-key parameter set to your API key.
    curl https://checkout-test.adyen.com/v68/payments/WNS7WQ756L2GWR82/captures \
    -H 'x-api-key: YOUR_API_KEY' \
    -H 'content-type: application/json' \
    -d '{
           "merchantAccount":"YOUR_MERCHANT_ACCOUNT",
           "amount":{
              "currency":"EUR",
              "value":2500
           },
           "reference":"YOUR_UNIQUE_REFERENCE"
    }'
    String xApiKey = "YOUR_X-API-KEY";
    Client client = new Client(xApiKey,Environment.TEST);
    Checkout checkout = new Checkout(client);
    var paymentCaptureRequest = new CreatePaymentCaptureRequest();
    var amount = new Amount();
    amount.setCurrency("EUR");
    amount.setValue(2500L);
    paymentCaptureRequest.setAmount(amount);
    paymentCaptureRequest.setMerchantAccount("YOUR_MERCHANT_ACCOUNT");
    paymentCaptureRequest.setReference("YOUR_UNIQUE_REFERENCE");
    String paymentPspReference = "WNS7WQ756L2GWR82";
    var response = checkout.paymentsCaptures(paymentPspReference, paymentCaptureRequest);
  3. In the capture response, note the following:
    • paymentPspReference: the PSP reference of the authorisation.
    • pspReference: the PSP reference associated with this capture request. This is different from the PSP reference of the authorisation.
    • status: received. Your capture request will be processed asynchronously. You will receive the result in a webhook.
    /captures response
    {
      "merchantAccount": "YOUR_MERCHANT_ACCOUNT",
      "paymentPspReference": "WNS7WQ756L2GWR82",
      "pspReference": "JDD6LKT8MBLZNN84",
      "reference": "YOUR_UNIQUE_REFERENCE",
      "status": "received",
      "amount": {
        "currency": "EUR",
        "value": 2500
      }
    }
  4. Wait for the CAPTURE notification webhook to learn the outcome of the request.

CAPTURE webhook

When we have processed your capture request, we send you a notification webhook with:

  • eventCode: CAPTURE.
  • originalReference: the PSP reference of the authorisation.
  • pspReference: the PSP reference associated with the capture request.
  • success: indicates whether the capture request was successful. Possible values:
    • true: the capture request is valid (for example, the authorisation has not expired, and the balance is available) and has been submitted to the bank/third-party processor. In most cases, this means that the funds will be transferred to your account. In rare cases the card scheme can still reject the capture, and you will receive a CAPTURE_FAILED webhook.
    • false: the capture request failed. The notification includes a reason field with a short description of the problem. Review the reason, fix the issue if possible, and resubmit the capture request.
{
   "live":"false",
   "notificationItems":[
      {
         "NotificationRequestItem":{
            "amount":{
               "currency":"EUR",
               "value":500
            },
            "eventCode":"CAPTURE",
            "eventDate":"2018-22T15:54:01+02:00",
            "merchantAccountCode":"YourMerchantAccount",
            "originalReference":"WNS7WQ756L2GWR82",
            "paymentMethod":"mc",
            "pspReference":"JDD6LKT8MBLZNN84",
            "reason":"",
            "success":"true"
         }
      }
   ]
}

For more information about the included fields, see the CAPTURE notification reference.

Reasons for an unsuccessful request

When a capture request fails, you receive a CAPTURE webhook with success: false and the reason why the request failed. The next table shows the most common reasons.

reason Description
Transaction not found The capture failed because the pspReference is missing or incorrect. Check that the reference you provided is unique and matches exactly one pspReference.
Transaction is expired The authorisation for this payment is expired. You can try to re-authorize the payment in your Customer Area.
This is a sale transaction, not possible to capture a smaller amount This payment method doesn't support separate captures.
Operation maximum period allowed: X days The capture operation can only be performed within X days from the date the payment was authorized.
Only possible to capture the full amount This payment method doesn't support partial captures.
Modification in different currency than authorisation The capture currency does not match the authorized payment currency.
Amount too low to be accepted by Card Network The capture amount is below the threshold permitted by the card scheme rules.
Insufficient balance on payment The requested capture amount is more than the balance on the payment.
Internal error Something unexpected happened on Adyen's end. Contact our Support Team.
Operation not available You do not have the required capture functionality enabled for this payment method. Contact our Support Team.
Operation failed The capture functionality failed for this payment method. Contact our Support Team.

The balance on the payment is the amount that remains from the original authorisation. For example, if a transaction is authorised for 10 EUR but not captured, the balance on the payment is 10 EUR. If the full amount is cancelled, or if the authorisation expired, the remaining balance on the payment is 0 EUR. If a transaction is authorised for 50 EUR, and then partially captured for 30 EUR, the remaining balance on the payment is 20 EUR.

CAPTURE_FAILED webhook

In rare cases, a capture fails even after you received a CAPTURE notification with successtrue. The successful notification means that we sent the request to the card scheme, but the scheme can still reject the request at this point. This can even happen a few days after you submitted the capture request.
Most of the time Adyen can fix the issue, so that you will eventually receive the funds. Sometimes, however, you need to take action yourself. To learn why a capture can fail and what, if anything, you need to do in each case, refer to Reasons for failed capture.
When a capture fails, we inform you of this with a notification containing:

  • eventCode: CAPTURE_FAILED
  • originalReference: the pspReference of the authorisation.
  • pspReference: the pspReference of the capture request.

The notification contains the reason why the card scheme rejected the capture. You can also find the capture failure reason on the Payment details page in your Customer Area.

CAPTURE_FAILED notification
 {
    "live":"false",
    "notificationItems":[
       {
          "NotificationRequestItem":{
             "amount":{
                "currency":"EUR",
                "value":10003
             },
             "eventCode":"CAPTURE_FAILED",
             "eventDate":"2018-05-27T15:42:02+02:00",
             "merchantAccountCode":"YourMerchantAccount",
             "originalReference":"WNS7WQ756L2GWR82",
             "paymentMethod":"mc",
             "pspReference":"VK9DRSLLRCQ2WN82",
             "reason":"Capture Failed",
             "success":"true"
          }
       }
    ]
 }

An overview of failed captures is available in your Payment accounting report.

Cancel an authorisation

Cancel in Customer Area

You can also manually cancel uncaptured payments in your Customer Area. See Manage payments.

When you are using a capture delay or manual capture, you can cancel the authorisation on an uncaptured payment using an API request from your POS app.

But before you can do that, you need to:

To cancel a payment that has been authorised but not captured yet:

  1. From the AUTHORISATION webhook, get the pspReference of the authorisation you want to cancel.
  2. Make a POST request to the /payments/paymentPspReference/cancels endpoint, where paymentPspReference is the PSP reference of the authorisation you want to cancel.
    If you're not sure whether the authorisation has been captured, use the /payments/{paymentPspReference}/reversals endpoint instead.
    In your request, include:
    Parameter Required Description
    merchantAccount -white_check_mark- The name of your merchant account that is used to process the payment.
    reference Your reference for the cancel request.
    The next example shows how to cancel an authorisation that has the pspReference XB7XNCQ8HXSKGK82.
    The request header must include the x-api-key parameter set to your API key.
    curl https://checkout-test.adyen.com/checkout/v68/payments/XB7XNCQ8HXSKGK82/cancels \
    -H 'X-API-Key: YOUR_API_KEY' \
    -H 'Content-Type: application/json' \
    -d '{
        "reference": "YOUR_UNIQUE_REFERENCE",
        "merchantAccount": "YOUR_MERCHANT_ACCOUNT"
    }'
    String xApiKey = "YOUR_X-API-KEY";
    Client client = new Client(xApiKey,Environment.TEST);
    Checkout checkout = new Checkout(client);
    var paymentCancelRequest = new CreatePaymentCancelRequest();
    paymentCancelRequest.setMerchantAccount("YOUR_MERCHANT_ACCOUNT");
    paymentCancelRequest.setReference("YOUR_UNIQUE_REFERENCE");
    String paymentPspReference = "XB7XNCQ8HXSKGK82";
    var response = checkout.paymentsCancels(paymentPspReference, paymentCancelRequest);
  3. When you receive the /payments/paymentPspReference/cancels response, note:
    • paymentPspReference: the PSP reference of the authorisation you want to cancel.
    • pspReference: Adyen's unique reference associated with this cancel request.
    {
        "merchantAccount": "YOUR_MERCHANT_ACCOUNT",
        "paymentPspReference": "XB7XNCQ8HXSKGK82",
        "pspReference" : "JDD6LKT8MBLZNN84",
        "reference": "YOUR_UNIQUE_REFERENCE",
        "status" : "received"
    }
  4. Wait for the CANCELLATION notification webhook to learn the outcome of the cancel request.

CANCELLATION webhook

You receive the outcome of the cancel request asynchronously, in a notification webhook that includes :

  • eventCode: CANCELLATION.
  • originalReference: the PSP reference of the authorisation.
  • pspReference: same as the pspReference in the /payments/paymentPspReference/cancels response.
  • success: indicates whether the cancel request was successful. Possible values:
    • true: the cancel request was successful.
    • false: the cancel request failed. The notification includes a reason field with a short description of the problem. Review the reason, fix the issue if possible, and resubmit the cancel request.
{
   "live":"false",
   "notificationItems":[
      {
         "NotificationRequestItem":{
            "amount":{
               "currency":"EUR",
               "value":500
            },
            "eventCode":"CANCELLATION",
            "eventDate":"2021-03-05T09:08:05+01:00",
            "merchantAccountCode":"YOUR_MERCHANT_ACCOUNT",
            "originalReference":"XB7XNCQ8HXSKGK82",
            "paymentMethod":"mc",
            "pspReference":"JDD6LKT8MBLZNN84",
            "reason":"",
            "success":"true"
         }
      }
   ]
}

For more information about the included fields, see the CANCELLATION notification reference.

See also