Refund Order

This is used to request a refund. All refunds will be handled by the Payment Provider.

post
https://api.qa.optty.com
/orders/[ORDERID]/refund
Request Refund
Parameters
Content Type: application/json
Field
Type
Description
refundReference
required
string 
Unique refund reference for tracking purpose in Optty 
(Use unique id for every refund) 
refundDescription
required
string
Brief description of the refund
refundAmount
required
object 
An object containing the currency and amount to be refunded to the customer.
refundAmount.amount
required
Number 
Order amount to be refunded to the customer
Full Example
Sample Request
{
    "refundReference": "TgEHcPtpN2HSrTMK-0",
    "refundAmount": {
        "amount": 100,
        "currency": "AUD"
    },
    "refundDescription": "Please refund this order"
}

Create Order Response

Next - API References

Create Customer Session

Last modified 1mo ago

Field	Type	Description
refundReference required	string	Unique refund reference for tracking purpose in Optty (Use unique id for every refund)
refundDescription required	string	Brief description of the refund
refundAmount required	object	An object containing the currency and amount to be refunded to the customer.
refundAmount.amount required	Number	Order amount to be refunded to the customer