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

PropertyValue
API NameGet Terminals Summary
HTTP MethodGET
Endpoint/api/v1/tms/terminals/summary
Access LevelsSUPER_ADMIN, PARTNER, MERCHANT
Request ParametersNone
Request BodyNone
Success Response200 OK
Error Response400 Bad Request

3. Base URL

Production

https://app-api.edfapay.com

Full Endpoint

GET https://app-api.edfapay.com/api/v1/tms/terminals/summary

4. Authorization

This endpoint is available to the following access levels:

  • SUPER_ADMIN
  • PARTNER
  • MERCHANT

Authentication uses an API key supplied through the X-API-KEY request header.

5. Request Headers

HeaderValueDescription
X-API-KEYYOUR_API_KEYAuthenticates 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_KEY with a valid API key.
  • This is a read-only endpoint and does not modify terminal records.

7. Successful Response — 200 OK

Example 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

FieldTypeDescription
codeNumberAPI response code.
messageStringResponse message.
errorCodeStringError identifier, if applicable.
dataObjectContains terminal summary counts.
data.activeNumberCount of active terminals.
data.inactiveNumberCount of inactive terminals.
data.suspendedNumberCount of suspended terminals.
data.freeNumberCount of terminals classified as free by the system.
data.registeredNumberCount of registered terminals.
data.notRegisteredNumberCount of terminals that are not registered.

9. Error Response — 400 Bad Request

The endpoint documents 400 Bad Request as a possible response.

Example Response

{
  "code": 0,
  "message": "string",
  "errorCode": "string",
  "data": {}
}
FieldTypeDescription
codeNumberAPI response code.
messageStringError or response message.
errorCodeStringError identifier.
dataObjectAdditional error details; empty in the documented example.

The values shown are Swagger example placeholders, not confirmed runtime response values.

10. Integration Workflow

  1. Authenticate using a valid API key and an authorized SUPER_ADMIN, PARTNER, or MERCHANT account.
  2. Submit a GET request to the terminal summary endpoint.
  3. Inspect the HTTP status and response payload.
  4. Read the data object to retrieve the terminal counts.
  5. 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-KEY header contains a valid API key.
  • Inspect message and errorCode for 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 GET method.
  • No path parameters, query parameters, or request body are required.
  • The documented access levels are SUPER_ADMIN, PARTNER, and MERCHANT.
  • Authentication uses the X-API-KEY header.
  • The response includes six summary counts: active, inactive, suspended, free, registered, and notRegistered.
  • The Swagger example does not specify whether status categories overlap or are mutually exclusive.
  • The exact business definition of free should be confirmed with the API implementation if required for reporting.

Did this page help you?