Skip to main content
DELETE
/
stores
/
{storeId}
/
orders
/
{orderId}
/
refund
Refund order
curl --request DELETE \
  --url https://api.komerza.com/stores/{storeId}/orders/{orderId}/refund \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "reason": 0
}'
{
  "success": true,
  "message": "<string>",
  "code": "<string>",
  "data": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "dateCreated": "2023-11-07T05:31:56Z",
    "userId": "<string>",
    "ipAddress": "<string>",
    "reason": 0,
    "amount": 123,
    "orderId": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
  }
}

Authorizations

​
Authorization
string
header
required

Your API key goes here

Path Parameters

​
storeId
string<uuid>
required

The ID of the store the order will be refunded in.

​
orderId
string<uuid>
required

The ID of the order to refund

Body

application/json

The form containing the reason for the refund

Represents the form used to process a refund for an order.

​
reason
enum<integer>
required

Indicates a duplicate transaction or order as the reason for a refund.

Available options:
0,
1,
2,
3

Response

The object was successfully created.

Represents a default generic response for API endpoints.

​
success
boolean
required

Indicates whether the operation or response was successful.

​
message
string | null

A descriptive message providing additional context or information about the response.

​
code
string | null

The error code (if there was an error) to use when referencing the error

​
data
object

Represents a refund associated with a specific user, order, and reason for payment adjustment.