Get Order
Purpose: Retrieves the current, complete details and status of a specific order using its unique ID.
Endpoint Details
- HTTP Verb: GET
- URL Segment: /v3/order/{orderId}
- OpenAPI Spec: View in Swagger UI
- Notes:
Path Parameters
This method uses a parameter passed directly in the URL path.
| Field Name | Description | Type | Additional Information |
|---|---|---|---|
orderId | The unique ID of the order to retrieve. | string ($uuid) | Required. This is the orderId returned from Create Order. |
Request Body
No Request Body Required.
Successful Response (200 OK)
The API returns an OrderResponse object containing the retrieved Order.
For schema and examples, see the OrderResponse Schema page.
Error Responses
The following HTTP status codes are explicitly documented for this method:
| Status Code | Description |
|---|---|
| 400 Bad Request | The request was invalid, or the order is in a state that prevents cancellation (e.g., already captured or completed). The response body may contain a message like "Failed validation context". |
| 401 Unauthorized | Authentication failure (e.g., missing or invalid API key/credentials). |
| 404 Not Found | The specified orderId does not exist. |