POST /orders/{reference}/refunds

Process a refund for an order ---- [auth scope: api-user]

post

Authorizations

Path parameters

orderReferencestringRequired

Order Reference for order

Body

refundReferencestringRequired

Order reference for tracking refund in optty

refundAmountall ofRequired

The currency and amount to be refunded to the customer

refundDescriptionstringRequired

Brief description of the refund

Responses

200Success

application/json

400Error

application/json

401Error

application/json

404Error

application/json

post

HTTPcURLJavaScriptPython

POST /orders/{orderReference}/refund HTTP/1.1
Host: 
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 99

{
  "refundReference": "text",
  "refundAmount": {
    "amount": 1,
    "currency": "text"
  },
  "refundDescription": "text"
}

{
  "refundReference": "586901000",
  "bnplProvider": "AFFIRM_US",
  "refundedAmount": 150,
  "refundStatus": "SUCCESSFUL",
  "description": "Initial Refund",
  "refundDate": "2024-07-01T06:10:18Z",
  "bnplRefundId": "OUOACYVMR79788VS",
  "callbackUrl": "text"
}

Example Request/Response

Sample Request

{
    "refundReference": "TgEHcPtpN2HSrTMK-0",
    "refundAmount": {
        "amount": 100,
        "currency": "AUD"
    },
    "refundDescription": "Please refund this order"
}

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