Refund Order

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

Request Refund

POST https://api.qa.optty.com/orders/[orderReference]/refund

Request Refund

POST https://api.qa.optty.com/orders/[orderReference]/refund

For live environment, please update the endpoint to https://api.optty.com

Path Parameters

Name	Type	Description
orderId*	string	The order Id that need to refund /orders/[ORDERID]/refund

Headers

Name	Type	Description
Authentication*	string	Authorization: Bearer <token>

200 Refund Successfully

{
    "refundReference": "TgEHcPtpN2HSrTMK-0-00",
    "bnplProvider": "KLARNA_AU",
    "refundedAmount": 100,
    "refundStatus": "SUCCESSFUL",
    "description": {},
    "refundDate": "Fri, 08 Oct 2021 06:22:20 GMT",
    "bnplRefundId": "8ba78198-bc4c-48ae-9040-57c687bed51d"
}

400 Over Refund Limit / Parameters Error

//OVER REFUND LIMIT
{
    "statusCode": 400,
    "message": "You can only refund amount up to AUD 24.98",
    "error": "Bad Request"
}

//Invalid Parameters/ Value was sent to optty

{
    "statusCode": 400,
    "message": "Unexpected token a in JSON at position 157",
    "error": "Bad Request"
}

401 Check your credentials and accessToken / Environment live or Staging.

{
    "statusCode": 401,
    "message": "Unauthorized"
}

404 Original OrderID doesn't exist, check the orderID that sent to us.

{
    "statusCode": 404,
    "message": "Not Found"
}

500 Internal Server Error

{
    "statusCode": 500,
    "message": "Internal server error"
}

Path Parameters

Name	Type	Description
orderId*	string	hZDPuaSr7qWt

Headers

Name	Type	Description
Authentication*	string	2EO4Do1ZUy3x

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"
}