Get Terminals Summary Statistics — API
Retrieves terminal summary statistics, including active, inactive, suspended, free, registered, and unregistered terminal counts. Requires no parameters or request body and is accessible to SUPER_ADMIN, PARTNER, and MERCHANT roles using API Key authentication through the X-API-KEY header.
1. Overview
The Get Terminals Summary API retrieves summary statistics for terminals, grouped by status and registration state. The response provides counts of active, inactive, suspended, free, registered, and unregistered terminals.
Access Levels: SUPER_ADMIN, PARTNER, MERCHANT
2. Endpoint Details
| Property | Value |
|---|---|
| API Name | Get Terminals Summary |
| HTTP Method | GET |
| Endpoint | /api/v1/tms/terminals/summary |
| Access Levels | SUPER_ADMIN, PARTNER, MERCHANT |
| Request Parameters | None |
| Request Body | None |
| Success Response | 200 OK |
| Error Response | 400 Bad Request |
3. Base URL
Production
https://app-api.edfapay.comFull Endpoint
GET https://app-api.edfapay.com/api/v1/tms/terminals/summary4. Authorization
This endpoint is available to the following access levels:
SUPER_ADMINPARTNERMERCHANT
Authentication uses an API key supplied through the X-API-KEY request header.
5. Request Headers
| Header | Value | Description |
|---|---|---|
X-API-KEY | YOUR_API_KEY | Authenticates the API request. |
Accept | */* | Specifies the response media types accepted by the client. |
No path parameters, query parameters, or request body are required.
6. cURL Example
curl --request GET \
--url 'https://app-api.edfapay.com/api/v1/tms/terminals/summary' \
--header 'X-API-KEY: YOUR_API_KEY' \
--header 'Accept: */*'Implementation notes:
- Replace
YOUR_API_KEYwith a valid API key. - This is a read-only endpoint and does not modify terminal records.
7. Successful Response — 200 OK
200 OKExample Response
{
"code": 0,
"message": "string",
"errorCode": "string",
"data": {
"active": 0,
"inactive": 0,
"suspended": 0,
"free": 0,
"registered": 0,
"notRegistered": 0
}
}The values shown are Swagger example placeholders and do not represent actual terminal statistics.
8. Response Fields
| Field | Type | Description |
|---|---|---|
code | Number | API response code. |
message | String | Response message. |
errorCode | String | Error identifier, if applicable. |
data | Object | Contains terminal summary counts. |
data.active | Number | Count of active terminals. |
data.inactive | Number | Count of inactive terminals. |
data.suspended | Number | Count of suspended terminals. |
data.free | Number | Count of terminals classified as free by the system. |
data.registered | Number | Count of registered terminals. |
data.notRegistered | Number | Count of terminals that are not registered. |
9. Error Response — 400 Bad Request
400 Bad RequestThe endpoint documents 400 Bad Request as a possible response.
Example Response
{
"code": 0,
"message": "string",
"errorCode": "string",
"data": {}
}| Field | Type | Description |
|---|---|---|
code | Number | API response code. |
message | String | Error or response message. |
errorCode | String | Error identifier. |
data | Object | Additional error details; empty in the documented example. |
The values shown are Swagger example placeholders, not confirmed runtime response values.
10. Integration Workflow
- Authenticate using a valid API key and an authorized
SUPER_ADMIN,PARTNER, orMERCHANTaccount. - Submit a
GETrequest to the terminal summary endpoint. - Inspect the HTTP status and response payload.
- Read the
dataobject to retrieve the terminal counts. - Use the returned statistics for dashboards, monitoring, or reporting as required.
11. Error Handling and Troubleshooting
If the API returns 400 Bad Request, consider checking the following:
- Confirm that the request URL is correct.
- Ensure that the request targets the intended environment.
- Verify that the
X-API-KEYheader contains a valid API key. - Inspect
messageanderrorCodefor additional diagnostic information.
These are general troubleshooting recommendations. The endpoint's exact validation rules and error mappings are not specified in the provided definition.
12. Important Considerations
- The endpoint uses the
GETmethod. - No path parameters, query parameters, or request body are required.
- The documented access levels are
SUPER_ADMIN,PARTNER, andMERCHANT. - Authentication uses the
X-API-KEYheader. - The response includes six summary counts:
active,inactive,suspended,free,registered, andnotRegistered. - The Swagger example does not specify whether status categories overlap or are mutually exclusive.
- The exact business definition of
freeshould be confirmed with the API implementation if required for reporting.
Updated 25 days ago