Capture an authorised payment

post /payments/{paymentPspReference}/captures

Captures an authorised payment and returns a unique reference for this request. You get the outcome of the request asynchronously, in a CAPTURE webhook.

You can capture either the full authorised amount or a part of the authorised amount. By default, any unclaimed amount after a partial capture gets cancelled. This does not apply if you enabled multiple partial captures on your account and the payment method supports multiple partial captures.

Automatic capture is the default setting for most payment methods. In these cases, you don't need to make capture requests. However, making capture requests for payments that are captured automatically does not result in double charges.

For more information, refer to Capture.

Endpoint destination URL{paymentPspReference}/captures
Click to copy

Header parameters

Idempotency-Key string

A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).

Path parameters

paymentPspReference string Required

The pspReference of the payment that you want to capture.

Request parameters

amount object Required

The amount that you want to capture. The currency must match the currency used in authorisation, the value must be smaller than or equal to the authorised amount.

lineItems array [object]

Price and product information of the refunded items, required for partial refunds.

This field is required for partial refunds with 3x 4x Oney, Affirm, Afterpay, Atome, Clearpay, Klarna, Ratepay, Walley, and Zip.

merchantAccount string Required

The merchant account that is used to process the payment.

platformChargebackLogic object

Defines how to book chargebacks when using Adyen for Platforms.

reference string

Your reference for the capture request. Maximum length: 80 characters.

splits array [object]

An array of objects specifying how the amount should be split between accounts when using Adyen for Platforms. For details, refer to Providing split information.

subMerchants array [object]

A List of sub-merchants.

Response parameters

After submitting a call, you receive a response message to inform you that your request was received and processed.

Depending on the HTTP status code of the response message, it is helpful to build some logic to handle any errors that a request or the system may return.

HTTP Responses

  • 201 - Created

    The request has been fulfilled and has resulted in one or more new resources being created.

    Show more Show less
  • 400 - Bad Request

    A problem reading or understanding the request.

    Show more Show less
  • 401 - Unauthorized

    Authentication required.

    Show more Show less
  • 403 - Forbidden

    Insufficient permissions to process the request.

    Show more Show less
  • 422 - Unprocessable Entity

    A request validation error.

    Show more Show less
  • 500 - Internal Server Error

    The server could not process the request.

    Show more Show less
  • Request
  • Click to copy
  • Response
  • Click to copy