Pesquisar

Are you looking for test card numbers?

Would you like to contact support?

Atenção, esta página não se encontra disponível em Português
Default icon

Capture

Complete an authorised payment.

Capture in Customer Area

You can also capture payments in your Customer Area. For more information, refer to Manage payments.

For some payment methods, the payment is completed in two steps:

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

By default, payments are captured immediately after authorisation. For payment methods that support separate authorisation and capture, you can also capture the payment later, for example after the goods have been shipped. This allows you to cancel the payment in case of any issues with the shipment. 

To learn if a payment method supports separate captures, refer to the payment method page such as Cards or Klarna.

To capture payments, you can use either:   

Automatic capture

With automatic capture, payments are captured automatically, using the capture delay that you specify.

Capture delay

Capture delay is the time between payment authorisation and capture. By default, payments are captured immediately after authorisation. Setting up a delay between authorisation and capture allows you to cancel the authorisation, for example when it turns out that an item is out of stock.

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

  • Merchant admin

To set up a capture delay:

Account structure

Capture delay is configured at the merchant account level. For more information, refer to Company and merchant accounts.

  1. Log in to your Customer Area.
  2. Switch to your merchant account.
  3. Go to  Account > Account settings
  4. In the Capture Delay drop-down list, select the capture delay that you want to use. Possible values: 
    • immediate – Capture is performed immediately after authorisation.
    • [N] days –  Capture is performed N (between 1 and 7) days after authorisation. 
  5. Select Submit.

A payment that is automatically captured does not trigger a separate CAPTURE notification. If you are using delayed automatic capture (by having a Capture Delay of a fixed number of days), you can optionally receive CAPTURE notifications. To enable this functionality, contact our Support Team.

Manual capture

With manual capture, you need to explicitly request a capture for each payment.

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

  • Merchant admin

To enable manual capture:

  1. Log in to your Customer Area.
  2. Switch your merchant account.
  3. Go to Account > Account settings.
  4. In the Capture Delay list, select manual.
  5. Select Submit.

Once you've enabled manual capture, you need to capture each payment by making an API request.

Alternatively, you can include in your payment request captureDelayHours, specifying a number of hours after which the payment will be captured.

For example, to have the payment captured two hours after authorisation, include in your payment request:

{
  "amount": {
    "currency": "EUR",
    "value": 1000
  },
  "captureDelayHours": 2,
...
}

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

Capture a payment

Make a POST request to the /payments/{paymentPspReference}/captures endpoint, specifying:

  • paymentPspReference: The pspReference of the payment that you want to capture. This reference is returned in the response to your payment request, and in the AUTHORISATION notification.
  • merchantAccount: The name of your merchant account that is used to process the payment.
  • amount.value: This must be the same as or, in case of a partial capture, less than the authorised amount.
  • amount.currency: This must match the currency of the payment you're capturing.
  • reference: Optional. Specifies a unique identifier for payment modification. The reference field is useful to tag a partial capture for future reconciliation.
/captures request
curl https://checkout-test.adyen.com/v67/payments/{paymentPspReference}/captures \
-H "x-API-key: YOUR_X-API-KEY" \
-H "content-type: application/json" \
-d '{
  "merchantAccount": "YOUR_MERCHANT_ACCOUNT",
  "amount": {
    "value": 2500,
    "currency": "EUR"
  },
  "reference": "YOUR_UNIQUE_REFERENCE"
}'

You will receive a response containing: 

  • pspReference: The PSP reference associated with the capture request. Note that this is different from the PSP reference of the payment you're capturing.
/captures response
{
  "merchantAccount": "YOUR_MERCHANT_ACCOUNT",
  "paymentPspReference": "981517998282382C",
  "pspReference": "8825408195409505",
  "reference": "YOUR_UNIQUE_REFERENCE",
  "status": "received",
  "amount": {
    "currency": "EUR",
    "value": 2500
  }
}

CAPTURE notification

When we have processed your capture request, we send you a 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. For information on exceptions, refer to Failed capture.
    • 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":"981517998282382C",
            "paymentMethod":"mc",
            "pspReference":"8825408195409505",
            "reason":"",
            "success":"true"
         }
      }
   ]
}
{
   "live":"false",
   "notificationItems":[
      {
         "NotificationRequestItem":{
            "amount":{
               "currency":"EUR",
               "value":500
            },
            "eventCode":"CAPTURE",
            "eventDate":"2018-22T15:54:01+02:00",
            "merchantAccountCode":"YourMerchantAccount",
            "originalReference":"981517998282382C",
            "paymentMethod":"mc",
            "pspReference":"8825408195409505",
            "reason":"Insufficient balance on payment",
            "success":"false"
         }
      }
   ]
}

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

Partial capture

With some payment methods, you can also partially capture a payment. For partial captures, your account can be set to perform either:

In both cases, to partially capture a payment:

  • Make a call to the /payments/{paymentPspReference}/captures endpoint 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 Card 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 some businesses models such as an ecommerce site where capture takes place upon shipment, or in 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.

Failed capture

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 does not contain the reason why the capture failed. To find out why the capture failed, see 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":"981517998282382C",
             "paymentMethod":"mc",
             "pspReference":"8825408195409505",
             "reason":"Capture Failed",
             "success":"true"
          }
       }
    ]
 }

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

Testing failed captures

In our test environment, you can check how your integration handles failed captures:

  1. Make a card payment, specifying:

    • holderName: capture failed
    {
      "amount": {
        "currency": "EUR",
        "value": 500
      },
      "reference": "Capture failed test",
      "paymentMethod": {
        "type": "scheme",
        "encryptedCardNumber": "test_4111111111111111",
        "encryptedExpiryMonth": "test_03",
        "encryptedExpiryYear": "test_2030",
        "encryptedSecurityCode": "test_737",
        "holderName": "capture failed"
      },
      "returnUrl": "https://your-company.com/...",
      "merchantAccount": "YOUR_MERCHANT_ACCOUNT"
    }
  2. Capture this payment, using either automatic or manual capture.

Once we have processed the capture request, we send you a CAPTURE_FAILED notification.

This request may take several hours to process.

See also