Get Qattah Pay order payment status

Order payment status request is sent through an HTTPS API accepting a JSON object as order details

API call

GET https://staging-api.qattahpay.sa/api/v1/merchant-integration/orders/{order_id}

api_token is provided by QattahPay for each integration

Headers

Name	Type	Description
Content-Type*	String	header must be set to application/json
Accept*	String	header must be set to application/json
Authorization*	String	header must be the api_token

200 The request had been properly processed

{
    "successful": true,
    "data": {
        "order": {
            "id": "ord_o9MmBw6vowxrR",
            "merchant_id": "mer_o9MmBQ6VQxrRe",
            "merchant_name": "ShgardiTest",
            "reference": "unique_order_reference",
            "amount": "100.00",
            "started_at": "2024-02-26T02:22:53.000000Z",
            "is_expired": true,
            "is_timed_out": true,
            "remaining_time": {
                "min": 0,
                "sec": 0
            },
            "activity_status": "TIMEOUT",
            "payment_status": "EXPIRED",
            "callback_url": "https://testing-callback.qattahpay.sa",
            "success_url": null,
            "failure_url": null,
            "invoices": [
                {
                    "id": "inv_kRjqlXxpLX9WN",
                    "order_id": "ord_o9MmBw6vowxrR",
                    "reference": "ecf4c494-1185-4417-b8a9-1e22083e6c65",
                    "name": "شخص 1",
                    "amount": "50.00",
                    "payment_status": "EXPIRED",
                    "payment_brand": null,
                    "applepay_checkout_id": null,
                    "mada_checkout_id": null,
                    "session_id": "ecf4c494-1185-4417-b8a9-1e22083e6c65",
                    "session_country_code": "KWT",
                    "external_payment_link": null,
                    "external_status": null,
                    "results": null
                },
                {
                    "id": "inv_j8BrzXok3XMkR",
                    "order_id": "ord_o9MmBw6vowxrR",
                    "reference": "2656e5ed-cf91-4733-9132-61b5efdd18c3",
                    "name": "شخص 2",
                    "amount": "50.00",
                    "payment_status": "EXPIRED",
                    "payment_brand": null,
                    "applepay_checkout_id": null,
                    "mada_checkout_id": null,
                    "session_id": "2656e5ed-cf91-4733-9132-61b5efdd18c3",
                    "session_country_code": "KWT",
                    "external_payment_link": null,
                    "external_status": null,
                    "results": null
                }
            ]
        }
    }
}

401 Unauthorized

Responses body

successful	boolean	Refers to if the request has been created successfully or not
data	object	Data object
data.order	object	Order object
data.order.id	string	Unique order id (starts with “ord_”)
data.order.merchant_id	string	Your merchant id (starts with “mer_”)
data.order.reference	string	If you send a reference id this will be returned to this key's value, if not, we will generate one for you and return it to this key too
data.order.amount	string	The total order amount which needs to be spliced into multiple users’ invoices
data.order.started_at	string	When the Qattah session started, and this must be “null” at the beginning because no user started the payment session yet
data.order.is_expired	boolean	Refers to if the Qattah session expired or not, it must be “false” at the beginning because it’s just created
data.order.is_time_out	boolean	Refers to if the Qattah session last for 15 min and timed out or not, it must be “false” at the beginning because it’s just created
data.order.remaining_time.min	int	Refers to how many minutes before this Qattah order expires.
data.order.remaining_time.sec	int	Refers to how many seconds after minutes before this Qattah order expires.
data.order.activity_status	string	This is the activity status of the order, which refers to if the order is created, started, paid, or time out. It must be “created” at the beginning because the end-user didn't add any users, yet.
data.order.payment_status	string	This is the payment status of the order, which refers to if the order is paid or still pending. It must be “pending” at the beginning because no user started the payment session yet.
data.order.invoices	array	This is the array of invoices, each user has a separated invoice to pay. It must be empty array at the beginning because the creator user did not add anyone yet.
data.order.callback_url	string	This URL will be called back when the Qattah order is paid successfully
data.order.success_url	string	Redirects the user to this "success" URL when payment is successful. Note: if this is a null or empty string, the user will be redirected to the success screen of Qattah Pay
data.order.failur_url	string	Redirects the user to this "failure" URL when payment is expired (timed-out). Note: if this is a null or empty string, the user will be redirected to the failure screen of Qattah Pay
links	object	This is the array of invoices, each user has a separated invoice to pay. It must be empty array at the beginning because the creator user did not add anyone yet.
links,redirect_to	string	This is where the user must be redirected to continue payment cycle

Order payment statuses

Read more about order payment statuses from the below link

🚉Order payment statuses

Rate limit: The rate limit is set to prevent malicious behaviour and poor user experiences. The per-hour rate limit per channel token is 20000 requests. You can contact your QattahPay representative if a higher limit is necessary.