Voids

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

Before being approved an order can be cancelled. On successful cancellation, the order's payment status becomes voided and a new void transaction is created.

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

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

Data model

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

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