No momento, esta página não está disponível em português

Manually capture a payment

Update the original authorized amount, for overcapture or after pre-authorization.

With a manual capture request, you can update the initially authorized amount, or split a payment. Manual capture is required when you want to:

Pre-authorize payments, with or without authorization adjustment.
Overcapture payments.
Make partial captures.
If you use Adyen for Platforms, split payments at capture.

Requirements

Take into account the following requirements, limitations, and preparations.

Requirement	Description
Integration type	A host-to-host integration.
Setup steps	Before you begin: Set the default capture method to manual, or in the completion requests set the `captureDelay` parameter to manual. To enable Level 2/3 data for your account, contact your Adyen account manager.

Partial manual capture

Some payment methods also allow partial manual capture.

Type of partial capture	Description
Single partial capture	Any 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
Multiple partial captures	The 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 to enable this feature.

Make a capture request

After you have made an authorization request and a completion request (see Make a payment), proceed as follows to capture the payment manually:

From the authorization response, get the pspReference of the authorization you want to capture.

Make a POST request to the /payments/{paymentPspReference}/captures endpoint, where paymentPspReference is the pspReference of the authorization you want to capture.

In your request, include:

Parameter	Required	Description
`merchantAccount`		The name of your merchant account that is used to process the payment.
`amount.value`		The amount in minor units (without a decimal point) being captured. If you specify a `value` less than the authorized amount, the remainder is released back to the shopper's card.
`amount.currency`		This must match the currency of the payment you are capturing.
`reference`		Your unique identifier for the capture operation. The `reference` field is useful to tag a partial capture for future reconciliation.

The following example shows how to capture a EUR 25.00 payment authorization that has the pspReference WNS7WQ756L2GWR82.

In the capture response, note the following:
- paymentPspReference: the PSP reference of the authorization.
- pspReference: the PSP reference associated with this capture request. This is different from the PSP reference of the authorization.
- status: received. Your capture request will be processed asynchronously. You will receive the result in a webhook.
Wait for the CAPTURE webhook to learn the outcome of the request.

Split at capture

You can only split at capture if you have an Adyen for Platforms integration.

When you process split payments for your users, the split amounts are not always known or decided at the time of authorization. In such cases, you can provide the split instructions in a /payments/{paymentPspReference}/captures request instead.

To split a payment at capture, you need to add a splits array to the manual capture request, with instructions on how to split the funds. For more information, refer to the Platforms documentation.

Webhooks for captures

Manual capture is an asynchronous process. To keep you informed, we send webhook event messages:

CAPTURE: Indicates if the capture request was valid. There are several reasons why a capture request can fail. If the request was valid, we send it to the issuing bank through the card scheme, and this usually means the funds will be transferred to your account.
CAPTURE_FAILED: Indicates that the card scheme or issuing bank rejected the capture. This happens only in rare cases.

CAPTURE webhook

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

eventCode: CAPTURE.
originalReference: The PSP reference of the authorization.
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 authorization 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 webhook event includes a reason field with a short description of the problem. Review the reason, fix the issue if possible, and resubmit the capture request.

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

Reasons for an unsuccessful capture 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. You provided an incorrect `merchantAccount`. Check that the `reference` you provided is unique and matches exactly one `pspReference`.
`Transaction is expired`	The authorization 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 authorization. For example, if a transaction is authorized for EUR 10 but not captured, the balance on the payment is EUR 10. If the full amount is cancelled, or if the authorization expired, the remaining balance on the payment is EUR 0. If a transaction is authorized for EUR 50, and then partially captured for EUR 30, the remaining balance on the payment is EUR 20.

CAPTURE_FAILED webhook

In rare cases, a capture fails even after you received a CAPTURE webhook with success: true. The successful webhook event 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 webhook event with:

eventCode: CAPTURE_FAILED
originalReference: The pspReference of the authorization.
pspReference: The pspReference of the capture request.

The webhook event 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.

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

Adding Level 2/3 data at capture

Level 2/3 enhanced scheme data (ESD) is for US domestic payments with Mastercard and Visa, and lets companies track how much is spent on their corporate cards and the amount of sales tax:

Level 2 data is purchase and tax details for the payment.
Level 3 data is level 2 data plus line item details such as product quantity and product description.

We recommend including Level 2/3 data in your initial authorization request.

It is possible to send Level 2/3 data in your capture request. However, that is not supported using the /payments/{paymentPspReference}/captures endpoint as described above. Instead, you need to use the /capture endpoint and include the Level 2/3 data fields in additionalData object. Before you start, ask your Adyen account manager to enable sending Level 2/3 data enhanced scheme data (ESD) in your capture request. For detailed instructions, refer to Include level 2/3 data in your request.