Update RefNo

Purpose: Updates the reference number used for identifying the order in merchant accounting reports.

---

Endpoint Details

• HTTP Verb: PATCH
• URL Segment: /v3/order/{orderId}/refno
• OpenAPI Spec: View in Swagger UI
• Notes: Allowed if status is Created, Initiated, Approved, UnderReview, or ReadyForCapture.

---

Path Parameters

Field Name	Description	Type	Additional Information
orderId	The unique ID of the order to update.	string ($uuid)	Required.

---

Request Body (UpdateRefNoRequest)

This method requires a JSON body containing the new reference number.

Field Name	Description	Type	Additional Information
refNo	The new reference number for the order.	string	Required. Min 1, Max 14 characters.

---

Example Request

{
  "refNo": "NEW-REF-2025"
}

---

Successful Response (200 OK)

The API returns an OrderResponse object containing the updated Order.

For schema and examples, see the OrderResponse Schema page.

---

Error Responses

Status Code	Description
400 Bad Request	The request was invalid (e.g., refNo length/format error or order status does not allow updates).
401 Unauthorized	Authentication failure (e.g., missing or invalid API key/credentials).
404 Not Found	The specified orderId does not exist.