Refunds
The refund object and the allowed CRUD operations on the related resource endpoint
A captured payment can be refunded, either totally or partially. The total refund amount cannot exceed the amount captured — if it’s equal to the amount captured the refund will be full, if it’s less the refund will be partial:
In case of a partial refund, the related order's payment status is moved to
partially_refunded
and a new successful refund transaction is created.In case of a full refund, the order status is moved to
cancelled
, its payment status torefunded
, and a new successful refund transaction is created.
A refund process can be initiated via trigger attribute either from an order or from a return. The response you get when you fetch a refund contains all the information and messages provided by the payment gateway.
If a refund gets stuck (for any reason) on our platform but succeeds on the payment gateway, you can unblock it by passing the _forward
trigger attribute.
This is an immutable API, meaning that create, update, and delete operations are not allowed on this endpoint, with the exception of the _forward
trigger attribute. You can only fetch a list of refunds or a specific single one.
Last updated