Comment on page
5⃣
Refund Order
This method is used to request a refund for an order paid via an Optty integrated APM. The request is passed through to and handled by the appropriate APM provider.
post
/orders/[ORDERID]/refund
Refund Order
Use this method to execute a refund for an order that has been paid via a payment method that has been integrated through Optty
Parameters
Header
Authorization*
Bearer <token>
Body
refundReference*
string
Unique refund reference for tracking purposes in Optty. Use a unique ID for every refund
refundAmount*
object
An object containing the currency and amount to be refunded to the customer
refundAmount.amount*
number
Amount to refund
eg: 100
refundAmount.currency
string
The currency in which the refund amount is in, using ISO 4217 format
eg: USD, AED, GBP
refundDescription
string
Brief description of the refund
Responses
200: OK
Successful Refund
400: Bad Request
Over refund limit / parameter error
401: Unauthorized
Check your credentials and accessToken / Environment Live or Staging.
404: Not Found
Original OrderID doesn't exist, check the orderID that was sent to us
500: Internal Server Error
Internal Server Error (Contact [email protected] for further investigation)
Last modified 5mo ago