v1

latestOpenAPI 3.1.02026-07-2665153355.3 KB

Initiate Refund

Initiates a full refund for a specified order. <br /> <br /> Once the API call is successful, the refund process begins. The result of the refund, whether it succeeds or fails, is communicated asynchronously when the order status updates to Refunded or Refund Failed. You can track the order status in the Orders tab of the Publisher Dashboard. <br /> <br /> If the refund is completed successfully, the total order amount is reimbursed, and the Order Refunded event is triggered. <br /> <br /> Note: This action is final and can't be undone.

post/checkout/api/v1/order/{orderId}/refund

Path parameters

orderIdstring required

Order ID to refund.

Headers

x-publisher-tokenstring required

The publisher token used for authentication.

x-user-idstring required

The user ID initiating the refund for the order.

Response

Refund initiated successfully.

object required

Returns an empty object.