Refund an order that has previously been captured. Supports partial and multiple refunds until fully refunded. Requires capture_id if multiple captures were performed.
When you want to refund an order, you must specify itsorder_id.
Creating a new refund will refund an order that has previously been captured but not refunded yet. Funds will be refunded via the payment brand originally charged.
You can optionally refund only part of an order. You can do so multiple times, until the order has been completely refunded.
If you have capture the order only partially or trough several capture requests. You will need to specify the capture_id in the refund request.
Once entirely refunded, an order can’t be refunded again. This method will return an error when called on an already-refunded order, or when trying to refund more money than is left on the order.
If you're trying to refund an order with authorized status, then please refer to the cancel request.
Please refer to our Cancel vs Refund documentation to learn which action should be applied depending on the order status and see how partial refunds work.