Terminal Initialization — API
Initializes a specified web terminal through the TMS using its trsm identifier. Accessible to SUPER_ADMIN and PARTNER roles and authenticated using the X-API-KEY header. No request body is specified in the API definition.
1. Endpoint Summary
The Terminal Initialization API initiates the initialization process for a specified web terminal.
| Attribute | Details |
|---|---|
| API Name | Initialize Web Terminal |
| HTTP Method | POST |
| Endpoint | /api/v1/tms/terminals/web/{trsm}/initialize |
| Access Levels | SUPER_ADMIN, PARTNER |
| Success Response | 200 OK |
| Error Response | 400 Bad Request |
| Request Body | Not specified in the provided Swagger definition |
2. Base URL
Production
https://app-api.edfapay.comFull Endpoint
POST https://app-api.edfapay.com/api/v1/tms/terminals/web/{trsm}/initialize3. 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.
4. Path Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
trsm | String | Yes | Identifier of the web terminal to be initialized. |
Example
/api/v1/tms/terminals/web/TERMINAL_IDENTIFIER/initializeReplace TERMINAL_IDENTIFIER with the actual terminal identifier.
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 request body is specified in the provided Swagger definition.
6. cURL Example
curl --request POST \
--url 'https://app-api.edfapay.com/api/v1/tms/terminals/web/TERMINAL_IDENTIFIER/initialize' \
--header 'X-API-KEY: YOUR_API_KEY' \
--header 'Accept: */*'Implementation notes:
- Replace
TERMINAL_IDENTIFIERwith the target terminal's identifier. - Replace
YOUR_API_KEYwith a valid API key. - No request body is included because none is specified in the provided Swagger definition.
7. Response Specification
7.1 HTTP 200 — OK
Indicates that the request completed with a successful HTTP status.
The exact success response schema is not available in the provided definition and therefore cannot be documented reliably here.
7.2 HTTP 400 — Bad Request
Indicates that the request was rejected as invalid.
Example response structure:
{
"code": 0,
"message": "string",
"errorCode": "string",
"data": {}
}| Field | Type | Description |
|---|---|---|
code | Number | Application-level response code. |
message | String | Message describing the result or error. |
errorCode | String | Application error identifier, where applicable. |
data | Object | Additional response information. |
The values shown above are Swagger example placeholders, not confirmed runtime response values.
8. Integration Workflow
- Authenticate using a valid API key and an authorized
SUPER_ADMINorPARTNERaccount. - Obtain the target web terminal's
trsmidentifier. - Construct the endpoint URL using the
trsmpath parameter. - Submit a
POSTrequest to the initialization endpoint. - Inspect the HTTP status and any returned response payload.
- Verify the terminal's initialization or registration status using the appropriate TMS status endpoint, if available.
The exact initialization steps and resulting terminal state are not specified in the available endpoint definition.
9. Error Handling and Troubleshooting
If the API returns 400 Bad Request, consider checking the following:
- Confirm that the
trsmpath parameter is supplied. - Verify that the terminal identifier is correct.
- Confirm that the request targets the intended environment.
- Ensure that the
X-API-KEYheader contains a valid API key. - Check the response's
messageanderrorCodefields for additional diagnostic information.
These are general troubleshooting recommendations. The endpoint's exact validation rules are not specified in the provided definition.
10. Important Considerations
- The endpoint uses the
POSTmethod. - The terminal identifier is supplied through the
trsmURL path parameter. - The documented access levels are
SUPER_ADMINandPARTNER. - Authentication uses the
X-API-KEYheader. - No request body is specified.
- The exact HTTP 200 response schema is not available in the provided definition.
- Repeat-initialization behavior and initialization prerequisites are not documented and should be verified before relying on them in production.
Updated 25 days ago