Query Specific Request Within a Batch

When managing large batches of payouts, you might need to track the status or details of a specific deposit request. This manual we will guide you on how to query a single request within a batch using our API through the below points:

• How to query individual requests within a batch by their unique request ID
• Retrieving beneficiary details, amounts, and the status of the request
• How to use this information for reconciliation or troubleshooting issues

This will give you better control and insight into individual requests, helping you ensure that each payout reaches its intended destination.

---

The Endpoint and Related Postman Collection

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

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/request/query

UAE

https://secure.paytabs.com/payout/batch/request/query

Egypt

https://secure-egypt.paytabs.com/payout/batch/request/query

Oman

https://secure-oman.paytabs.com/payout/batch/request/query

Jordan

https://secure-jordan.paytabs.com/payout/batch/request/query

Kuwait

https://secure-kuwait.paytabs.com/payout/batch/request/query

Global

https://secure-global.paytabs.com/payout/batch/request/query

---

Request Parameters

To initiate a query batch request searching by for a specific request( entry ) using this API Endpoint, there are specific parameters that need to be passed with valid information. The specification of these 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 }
entry_id	INT	Unique ID for a batch request entry. a batch may have many request if created. note : Key is received in response only.		✔
	{ "entry_id": 960 }

---

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",
  "entry_id": 961
}

Sample Response Payload

{
  "batch_id": 441,
  "entry_id": 961,
  "merchant_reference": "Delivery Fee",
  "merchant_reference2": "",
  "merchant_reference3": "",
  "amount": "97.25",
  "fee": "3.5",
  "total": "100.75",
  "beneficiary_account_number": "BH29BMAG1299123456BH00",
  "method": "Iban",
  "status": "Rejected",
  "protocol_message": ""
}