Terminal Stock Report

The "Terminal Stock Report" endpoint allows customers to retrieve a summary of terminal stock per merchant, showing how many terminals are whitelisted, mapped, and unmapped for each one. This is useful for tracking terminal allocation and deployment status across merchants.

GET /api/terminal/v1/stock-report

To retrieve the stock report, provide PageNumber and PageSize to paginate through the results.

Headers

Name	Value
Content-Type*	application/json
Authorization*	bearer {token}
Request-Reference	{unique_reference}

Query Params

Name	Description
PageNumber	The page number to retrieve.
PageSize	The number of records to return per page.

Here is an example request and response with a sample payload sent to the endpoint in Curl format.

Sample Request

curl --location -g '{{baseurl}}/api/terminal/v1/stock-report?PageNumber=1&PageSize=10' \
--header 'Authorization: bearer {token}' \
--header 'request-reference: {unique_reference}' \
--header 'Content-Type: application/json' \
--data ''

Response: 200

{
  "data": [
    {
      "bankCode": "string",
      "apiClientId": "string",
      "merchantName": "string",
      "totalWhitelisted": 0,
      "totalMapped": 0,
      "totalUnmapped": 0
    }
  ],
  "recordCount": 0
}