Search

Are you looking for test card numbers?

Would you like to contact support?

Online-payment icon

Capture

Complete an authorised payment.

Payments lifecycle

Capturing a payment transfers its status from Authorised to SentForSettle. For more information, refer to Payments lifecycle.

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 also have the option to capture the payment later, for example only after the goods have been shipped. This allows you to cancel the payment in case of any issues with the shipment. 

To capture payments, you can use either:   

  • Automatic capture – payments are captured automatically after authorisation. This is the default setting. You can optionally specify a delay between authorisation and automatic capture.
  • Manual capture – capture each payment manually by making a request to the /capture endpoint, or in your Customer Area. You can also schedule a capture by specifying  captureDelayHours in your payment request.

Open invoice payment methods (Klarna, AfterPay, and RatePay) are set to manual capture by default. For more information about capturing open invoice payments, refer to Open invoice modifications.

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. You can specify the capture delay in your Customer Area:

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 with your merchant-level account. 
  2. Go to  Account > Settings
  3. In the Capture Delay drop-down menu, 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. 
  4. Click 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 enable manual capture: 

  1. Log in to your Customer Area with your merchant-level account. 
  2. Go to Account > Settings
  3. In the Capture Delay  drop-down menu, select manual.
  4. Click Submit.

Once you've enabled manual capture, you have the following ways to capture a payment: 

  • Click the Capture link on the Payment Details screen in your Customer Area. To find the Payment Details screen, go to Transactions > Payments, and click on the payment that you wish to capture.
  • Make an API call.
  • Specify captureDelayHours in your  payment request. The payment will be captured after the number of hours that you specify here. 

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

    A payment captured by using captureDelayHours does not trigger a separate CAPTURE notification.

Make an API call to capture a payment

Make a request to the /capture endpoint, specifying: 

  • merchantAccount: The name of your merchant account that is used to process the payment.
  • modificationAmount: This must be the same as the amount of the original payment. 
  • originalReference: The original 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":"YourMerchantAccount",
   "modificationAmount":{  
      "value":500,
      "currency":"EUR"
   },
   "originalReference":"8313547924770610"
}

You will receive a /capture response containing: 

  • pspReference: The PSP reference associated with this /capture request. Note that this is different from the PSP reference associated with the original payment request.
{
   "pspReference":"8825408195409505",
   "response":"[capture-received]"
}   

CAPTURE notification

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

  • eventCodeCAPTURE
  • pspReference: Same as the pspReference in the /capture response. 
  • 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 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":"8313547924770610",
            "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":"8313547924770610",
            "paymentMethod":"mc",
            "pspReference":"8825408195409505",
            "reason":"Insufficient balance on payment",
            "success":"false"
         }
      }
   ]
}

For more information about the fields included in the CAPTURE notification, refer to Notifications API

Partial capture

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

Single partial capture

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

To partially capture a payment, specify the value that you want to capture in your call to the /capture endpoint (this must be smaller than the authorised value). 

For some schemes, you can flag each payment request as either a pre-authorisation or a final authorisation. If you want to perform a partial capture, 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. 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, the capture might fail even after you received a CAPTURE notification with success: true. The successful CAPTURE notification means that the capture request has been sent to the bank/third-party processor. The capture might still fail at this point, for example if:

  • there was a technical issue with the request, 
  • or if the shopper asked to revoke the authorisation.

When a capture fails, you will receive a notification with: 

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

You can receive a CAPTURE_FAILED notification even a few days after you submitted the original capture request. 

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

Where possible, Adyen will try to fix the issue and resubmit the capture request, so that you will eventually receive the funds. In some scenarios, however, for example if the cardholder's account has been closed, it is not possible to capture the payment anymore. 

If we recapture the payment, you will receive a notification with: 

  • eventCodeCAPTURE
  • successtrue
  • reasonTransaction Recaptured

See also