Refund Order (🚧 in development)

POST 
/order/refund

Process a refund for an order. This action is only available for orders with the status 'completed'. Refer to the Order Actions and Conditions. If the order contains more than one payment, the PaymentId of the payment to be refunded must be specified.

Request

application/json

Body

Order parameters

shopId integerrequired

ID of the shop where the order is placed. How to get your shopId

orderNumber stringrequired

Unique code identifying the specific order.

PaymentId string

Identifier for the specific payment that is being refunded. If the order has multiple payments, this must be specified.

cost objectrequired

Object specifying the amount and currency for the refund.

amount string

The specific sum to be refunded, formatted as a decimal string with a period (.) as the decimal separator.

currency string

Currency for the refund, which should match the currency of the original payment. Specifies the currency in ISO 4217 alphabetic code format, consisting of 3 uppercase letters.

Responses

200

Payment refund successful

application/json

Schema

Schema

data object

orderNumber stringrequired

Unique code identifying the specific order.

operationType stringrequired

Possible values: [refund]

Operations type

Example (from schema)

{
  "data": {
    "orderNumber": "OREDER-324234",
    "operationType": "refund"
  }
}

400

Error

application/json

Schema

Schema

code stringrequired

Error code

title stringrequired

Detailed error description

detail string

Additional information about the error

Example (from schema)

{
  "code": "401",
  "title": "Input data validation error",
  "detail": "Parameter AAAA is required"
}

Loading...