Captures

The capture object and the allowed CRUD operations on the related resource endpoint

When an order is approved the associated payment can be captured. On successful capture, the order's payment status becomes paid and a new capture transaction is created.

Fetching a capture returns all the information and messages provided by the payment gateway. You can update a capture to refund it.

If a capture gets stuck (for any reason) on our platform but succeeds on the payment gateway, you can unblock it by passing the _forward trigger attribute.

If a capture associated with a still pending order succeeded and the order is updated (introducing an amount mismatch scenario), you can reset the transaction by passing the _cancel trigger attribute.

Commerce Layer handles the capture step of the payment process separately from the authorization one so that users can have full control over every single stage of the payment flow. In this regard, you can configure the API to behave differently by setting one of the capture options provided at the payment method level.

Data model

Check the related ER diagram and explore the flowchart that illustrates how the capture resource relates to the order and the other transaction APIs.

How-to

Check the related guide for any additional info on how to set up auto-capture for your orders.

Create and delete operations are not allowed on this endpoint. You can only fetch a list of captures or a specific single one, which can also be updated in order to mark it as succeeded, pass specific trigger attributes, or add/change common attributes (metadata, references, etc.).