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

Transactions are created during an order lifecycle and determine its payment status changes:

  • Authorizations — when a payment source is authorized. On successful authorization the order's payment status becomes authorized.

  • Captures — when an authorization is captured. On successful capture the order's payment status becomes paid.

  • Voids — when an authorization is voided. On successful void the order's payment status becomes voided.

  • Refunds — when a capture is refunded, either totally or partially. On successful refund the order's payment status becomes refunded or partially_refunded.

Fetching a transaction returns all the information and messages provided by the payment gateway.

This is an immutable API, meaning that create, update, and delete operations are not allowed on this endpoint. You can only fetch a list of transactions or a specific single one.

Last updated