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.

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.


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

Last updated