Skip to main content
POST
/
orders
/
refund
Refund Order
curl --request POST \
  --url https://api.nuwebgroup.com/v1/orders/refund \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "orderId": 1,
  "restock": true,
  "refundProcessingFee": true,
  "refundResellerFee": true,
  "notifyCustomer": true,
  "online": true
}
'
{
  "currencyId": 1,
  "currencySymbol": "Ā£",
  "currencyCode": "GBP",
  "refundValue": 10403,
  "order": []
}

Authorizations

Authorization
string
header
required

The 'Bearer' token can be obtained from the token management interface or via the login endpoint using your admin user credentials.

Body

application/json

Request body for refunding an order

orderId
integer

Specified the order ID that will be refunded. Basket IDs and Order IDs can be used interchangeably.

restock
boolean

When true, the items will be restocked. If no value is passed, this will always default to true.

refundProcessingFee
boolean

When true, the processing fee will be refunded. If no value is passed, this will always default to true.

refundResellerFee
boolean

When true, the reseller fee will be refunded. If no value is passed, this will always default to true.

notifyCustomer
boolean

When true, the customer will be notified of their refund. If no value is passed, this will always default to true.

online
boolean

True for online refunds, false otherwise. If true is passed here but the transaction has no payment gateway or has a total of zero, it will revert this value to false.

type
enum<string>

Set the type for the refund. If set to balance or cancellation, the online flag will be ignored

Available options:
refund,
balance_refund,
cancellation
uuid
boolean

The uuid to store against the transaction, which allows the existing transaction to be returned if the refund has already been processed. This is ignored for cancellations, as they don't have a transaction

refundSplits
object[]

Where you have a split payment order, you can specify how much to refund to each payment method. If not supplied, the system will refund the original payment methods proportionately according to their original values.

Response

Successfully refunded order.

currencyId
integer
currencySymbol
string
currencyCode
string
refundValue
integer
order
object