Turuq Onboarding

Get Payment Status for Multiple Orders

Retrieve the current payment statuses of multiple orders by submitting an array of order IDs.

Request

Method: POST
Endpoint: orders/integration/paymentStatus
Content-Type: application/json

Request Body

FieldTypeRequiredDescription
orderIdsstring[]Array of order ID strings

Example

{
  "orderIds": ["0000000000262", "0000009829462", "0000000089562"]
}

Response


✅ 200 OK

Payment statuses were successfully retrieved:

{
  "results": [
    {
      "orderId": "ORDER123",
      "paymentStatus": "PAID"
    },
    {
      "orderId": "ORDER456",
      "paymentStatus": "UNPAID"
    },
    {
      "orderId": "ORDER789",
      "error": "Failed to get payment status"
    }
  ]
}

❌ 400 Bad Request

Empty array or too many order IDs:

{
  "error": "orderIds must be a non-empty array and must not exceed 100 orders"
}

Invalid order ID syntax:

{
  "error": "Invalid Order IDs: ORDER$@#, 123"
}

❌ 500 Internal Server Error

{
  "error": "Internal Server Error"
}

Notes

  • Any failure during individual status retrieval will return an object with an error field for that specific order.

On this page