Use the Order management API to check the details of an order.
When you want to check the details of an order, this API call provides you with order information like address, date, amount, purchase country, and status.
To check the order details, send a GET request to the {apiUrl}/ordermanagement/v1/orders/{order_id} endpoint. Provide the order id you want to revise as an {order_id} path parameter. The order_id is the identifier you get in a successful response when placing a new order.
You can check these details for up to three years after an order is created.
In response to your call, you receive a data object containing the order details.
{
"order_id": "7849fd84-47dc-4919-a7ce-xxxxxxxxxx",
"status": "CAPTURED",
"fraud_status": "ACCEPTED",
"order_amount": 200,
"original_order_amount": 200,
"captured_amount": 200,
"refunded_amount": 0,
"remaining_authorized_amount": 0,
"purchase_currency": "PLN",Sample of a successful response to check order details.
If the order id in your request is invalid, you get an error response. Ensure the order_id value you provided is correctly formatted.
You can use the correlation_id and the order_id values to troubleshoot the call in the Merchant portal logs app section.
{
"error_code": "INVALID_ORDER_ID",
"error_messages": [
"Order ID must be a valid UUID."
],
"correlation_id": "dd482985-2e0f-415d-9f30-74ce93e7e68e"
}Sample of an error response to check order details.
Ready to send this request? See the API reference of this call.