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
| Property | Value |
|---|---|
| API Name | Get Terminal Initialization Status |
| HTTP Method | GET |
| Endpoint | /api/v1/tms/terminals/web/{trsm}/initialization/status |
| Access Levels | SUPER_ADMIN, PARTNER |
| 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/web/{trsm}/initialization/status4. Authorization
This endpoint is available to the following access levels:
SUPER_ADMINPARTNER
Authentication uses an API key supplied through the X-API-KEY request header.
5. Path Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
trsm | String | Yes | Terminal identifier used to retrieve the initialization status. |
Example
/api/v1/tms/terminals/web/TERMINAL_IDENTIFIER/initialization/statusReplace TERMINAL_IDENTIFIER with the actual terminal identifier.
6. 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 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_IDENTIFIERwith the actual terminal identifier. - Replace
YOUR_API_KEYwith a valid API key. - This endpoint retrieves status information; it does not initiate the initialization process.
8. Successful Response — 200 OK
200 OKExample 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
| Field | Type | Description |
|---|---|---|
code | Number | API response code. |
message | String | Response message. |
errorCode | String | Error identifier, if applicable. |
data | Object | Terminal initialization status details. |
data.trsm | String | Terminal identifier. |
data.lastRecordCreatedAt | String (date-time) | Timestamp of the last record created. |
data.startedAt | String (date-time) | Timestamp indicating when initialization started. |
data.totalRecords | Number | Total number of records involved in the process. |
data.currentRecord | Number | Current record number or processing position reported by the API. |
data.status | String | Current initialization or configuration-download status. Exact supported values are not specified in the provided schema. |
data.isRegistered | Boolean | Indicates whether the terminal is registered. |
data.failedMessage | String | Failure message, if one is reported. |
10. 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.
11. Integration Workflow
- Authenticate using a valid API key and an authorized
SUPER_ADMINorPARTNERaccount. - Obtain the target terminal's
trsmidentifier. - Submit a
GETrequest to the initialization status endpoint. - Inspect the HTTP status and response payload.
- Review
isRegisteredandstatusto understand the state reported by the API. - Use
currentRecordandtotalRecordsto review the reported processing progress. - Inspect
failedMessageif a failure is reported.
12. Error Handling and Troubleshooting
If the API returns 400 Bad Request, consider checking the following:
- Confirm that the
trsmpath parameter is present. - Verify that the terminal identifier is correct.
- Ensure that the request targets the intended environment.
- Confirm 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 schema.
13. Important Considerations
- The endpoint uses the
GETmethod. - The required
trsmpath parameter identifies the terminal. - The documented access levels are
SUPER_ADMINandPARTNER. - Authentication uses the
X-API-KEYheader. - 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
statusand 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.
Updated 25 days ago