Once a payment charge has been authenticated and authorized, the movement of funds can be initiated through a capture request.

Separate captures mean that this process can be delayed or voided. By using multiple partial captures, varying amounts can be captured at the time of split shipment.

❗️

Important

Not all payment methods support capture requests, instead the capture step is finalized during authorization. The support for capture is detailed in the properties of each payment method.

Types of Capture

Payment methods that do not support captures are automatically updated from AUTHORIZED to CAPTURED.

Full

When a payment method supports capture requests, after successful authorization the payment charge status updates to CAPTURE_PENDING and can now be captured.

Capture the Payment Charge

In your /v1/payment-charges/{paymentChargeId}/captures request, include:

amount: The amount to be captured in the smallest currency unit. This must not exceed the authorized amount.
merchantCaptureReference: Merchant reference for the capture (optional)

Request

POST /v1/payment-charges/charge_ViwZ6ObcA6GO2V5dS6ssH/captures

{
  "merchantCaptureReference": "YOUR_CAPTURE_REFERENCE",
  "amount": 500
}

Response

{
    "id": "capture_JkgyjVXcTMiwG0E1Bcvr4",
    "amount": 500,
    "status": "CAPTURED",
    "merchantCaptureReference": "YOUR_CAPTURE_REFERENCE",
    "createdAt": "2023-05-09T19:10:14.126Z",
    "updatedAt": "2023-05-09T19:10:14.126Z",
    "_links": {
        "payment_charge": {
            "href": "/v1/payment-charges/charge_ViwZ6ObcA6GO2V5dS6ssH"
        }
    }
}

Whilst the capture is processing the payment charge status will temporarily show as CAPTURE_PROCESSING. Once the total amount has been successfully captured both the payment charge and capture status update to CAPTURED.

Partial

For those payment methods that allow partial captures, it is possible to capture an amount less than the authorized amount. The payment charge status will remain in CAPTURE_PENDING until the full authorized amount has been captured.

Multiple

For those payment methods that allow multiple captures, it is possible to request more than one capture against a single payment charge, provided the total amount does not exceed the authorized amount. Once the total amount has been captured, the payment charge status updates to CAPTURED.

Automatic

To automate the capture request for the full amount, in your payment charge request include autoCapture= true

Failed reasons