Query Batch Requests With Specific Status

When managing multiple payout batch requests, it’s useful to quickly query and view them by their current status—whether they’re pending, processed, or completed. In this guide, we’ll show you how to query batch requests by status using our API through the following steps:

• How to filter your batch requests based on their processing status
• Viewing and tracking the progress of pending, processed, or completed requests
• Using this information to identify which requests need attention

By utilizing these status filters, you can monitor your batch requests more efficiently, addressing any issues promptly to ensure a smooth payout process.

---

The Endpoint and Related Postman Collection

POST	{{domain}}/payout/batch/query/{{status}}

Be Aware Of

Please note that not using the proper endpoint URL {domain} will lead to authentication issues within your responses. To find the your proper domain you can read ourWhat is my (Region)/(endpoint URL)?tutorial article.

KSA

https://secure.paytabs.sa/payout/batch/query/{{status}}

UAE

https://secure.paytabs.com/payout/batch/query/{{status}}

Egypt

https://secure-egypt.paytabs.com/payout/batch/query/{{status}}

Oman

https://secure-oman.paytabs.com/payout/batch/query/{{status}}

Jordan

https://secure-jordan.paytabs.com/payout/batch/query/{{status}}

Kuwait

https://secure-kuwait.paytabs.com/payout/batch/query/{{status}}

Global

https://secure-global.paytabs.com/payout/batch/query/{{status}}

---

Request Parameters

To initiate a payment request using this service, there are minimum required parameters that need to be passed with valid information. The specification of these required parameters is clarified below:

The Minimum Required Parameters

Parameter	Data Type	Min	Max	Required
batch_id	INT	Unique ID of for a batch.		✔
	{ "batch_id": 263 }
profile_id	INT	Unique profile ID associated with the batch.		✔
	{ "profile_id": 47128 }
account_id	INT	Unique ID of the merchant account associated with the batch.		✔
	{ "account_id": 17 }

---

Request & Response Payload Samples

This section is dedicated give you a sample API request payload using the above mentioned required parameters, along with showing you the response payload received upon using each request payload.

Required Parameters Sample Payloads

The below sample request payload will show you how you can pass the above-mentioned required parameter/s, which are needed to be passed with valid values to perform a request. Along with the response payload received after using this request payload.

Sample Request Payload

{
  "batch_id": 441,
  "profile_id": "47128",
  "account_id": "17"
}

Sample Response Payload

{
  "batch_id": 441,
  "profile_id": 47128,
  "account_id": 17,
  "order_id": "Split (2024-09-11)",
  "status": "Rejected",
  "requests": [],
  "trace": "PMNT0001.66E9575C.0000003C"
}