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.
Sandbox Testing Environment
Merchant URL | https://api.qa.optty.com |
Production Environment
Merchant URL | https://api.optty.com |
Refund Order
POST
/orders/[ORDERID]/refund
Use this method to execute a refund for an order that has been paid via a payment method that has been integrated through Optty
Headers
Name | Type | Description |
---|---|---|
Authorization* | String | Bearer <token> |
Request Body
Name | Type | Description |
---|---|---|
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 |
Last updated