Sign in
Refunds

Cancel a refund

Refunding creates a new order linked to the original order. By default, it has the same order_id as the original order. To override this, include in the request refund_order_id.

You can cancel a refund order if it is still in reserved state.

patch/orders/{order_id}/refunds/{refund_id}

Path parameters

order_idstring required

The unique identifier of the original order.

Max length: 50 characters.

refund_idstring required

The unique identifier of the transaction for the refund.

Request body

statusstring required

The refund order status.

To cancel the refund, set to void.

descriptionstring

A variable for storing additional data about the cancellation.

Example request

{
  "status": "void"
}

Response

Request successful

successSuccess — unresolved $ref
dataobject

An empty object.

Changes

No recorded changes to this endpoint across all 1 revision of this API.