Update Amount

Purpose: Updates the current order amount.

---

Endpoint Details

• HTTP Verb: PATCH
• URL Segment: /v3/order/{orderId}/amount
• OpenAPI Spec: View in Swagger UI
• Notes: Allowed if status is Created, Approved, or ReadyForCapture. The amount can never be set to a value higher than originalAmount or approvedAmount (if set).

---

Path Parameters

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

---

Request Body (UpdateAmountRequest)

This method requires a JSON body containing the new amount.

Field Name	Description	Type	Additional Information
amount	The new, current amount of the order.	double	Required. Non-decimal.

---

Example Request

{
  "amount": 40000
}

---

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., amount exceeds limits 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.