Get Terminal Initialization Status — API

Retrieves the initialization and registration status of a specified terminal using its trsm identifier. Returns processing progress, record counts, timestamps, registration status, and any reported failure message. Accessible to SUPER_ADMIN and PARTNER roles using API Key authentication through the X-API-KEY header.

1. Overview

The Get Terminal Initialization Status API retrieves the registration and configuration-download status for a specified terminal. The response includes registration status, processing progress, record counts, timestamps, and any reported failure message.

Access Levels: SUPER_ADMIN, PARTNER

2. Endpoint Details

PropertyValue
API NameGet Terminal Initialization Status
HTTP MethodGET
Endpoint/api/v1/tms/terminals/web/{trsm}/initialization/status
Access LevelsSUPER_ADMIN, PARTNER
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/web/{trsm}/initialization/status

4. Authorization

This endpoint is available to the following access levels:

  • SUPER_ADMIN
  • PARTNER

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

5. Path Parameters

ParameterTypeRequiredDescription
trsmStringYesTerminal identifier used to retrieve the initialization status.

Example

/api/v1/tms/terminals/web/TERMINAL_IDENTIFIER/initialization/status

Replace TERMINAL_IDENTIFIER with the actual terminal identifier.

6. Request Headers

HeaderValueDescription
X-API-KEYYOUR_API_KEYAuthenticates the API request.
Accept*/*Specifies the response media types accepted by the client.

No request body or query parameters are specified in the provided API definition.

7. cURL Example

curl --request GET \
  --url 'https://app-api.edfapay.com/api/v1/tms/terminals/web/TERMINAL_IDENTIFIER/initialization/status' \
  --header 'X-API-KEY: YOUR_API_KEY' \
  --header 'Accept: */*'

Implementation notes:

  • Replace TERMINAL_IDENTIFIER with the actual terminal identifier.
  • Replace YOUR_API_KEY with a valid API key.
  • This endpoint retrieves status information; it does not initiate the initialization process.

8. Successful Response — 200 OK

Example Response

{
  "code": 0,
  "message": "string",
  "errorCode": "string",
  "data": {
    "trsm": "string",
    "lastRecordCreatedAt": "2026-10-28T12:08:05.807Z",
    "startedAt": "2026-10-28T12:08:05.807Z",
    "totalRecords": 0,
    "currentRecord": 0,
    "status": "string",
    "isRegistered": true,
    "failedMessage": "string"
  }
}

The values shown are Swagger example placeholders and do not represent actual terminal status information.

9. Response Fields

FieldTypeDescription
codeNumberAPI response code.
messageStringResponse message.
errorCodeStringError identifier, if applicable.
dataObjectTerminal initialization status details.
data.trsmStringTerminal identifier.
data.lastRecordCreatedAtString (date-time)Timestamp of the last record created.
data.startedAtString (date-time)Timestamp indicating when initialization started.
data.totalRecordsNumberTotal number of records involved in the process.
data.currentRecordNumberCurrent record number or processing position reported by the API.
data.statusStringCurrent initialization or configuration-download status. Exact supported values are not specified in the provided schema.
data.isRegisteredBooleanIndicates whether the terminal is registered.
data.failedMessageStringFailure message, if one is reported.

10. 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.

11. Integration Workflow

  1. Authenticate using a valid API key and an authorized SUPER_ADMIN or PARTNER account.
  2. Obtain the target terminal's trsm identifier.
  3. Submit a GET request to the initialization status endpoint.
  4. Inspect the HTTP status and response payload.
  5. Review isRegistered and status to understand the state reported by the API.
  6. Use currentRecord and totalRecords to review the reported processing progress.
  7. Inspect failedMessage if a failure is reported.

12. Error Handling and Troubleshooting

If the API returns 400 Bad Request, consider checking the following:

  • Confirm that the trsm path parameter is present.
  • Verify that the terminal identifier is correct.
  • Ensure that the request targets the intended environment.
  • Confirm 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 schema.

13. Important Considerations

  • The endpoint uses the GET method.
  • The required trsm path parameter identifies the terminal.
  • The documented access levels are SUPER_ADMIN and PARTNER.
  • Authentication uses the X-API-KEY header.
  • No request body or query parameters are defined.
  • The response provides registration status, initialization status, record counts, timestamps, and any reported failure message.
  • The exact values supported by status and the detailed processing rules are not defined in the provided Swagger schema.
  • The returned progress fields should be interpreted according to the API's actual implementation.

Did this page help you?