Refresh Terminal Configuration — API

Triggers a configuration refresh for a specified terminal using its trsm identifier. Accessible to SUPER_ADMIN and PARTNER roles and authenticated through the X-API-KEY header. No request body is required according to the provided API definition.

1. Endpoint Summary

The Refresh Terminal Configuration API triggers a configuration refresh for a specified terminal by requesting the download of its configuration parameters.

AttributeDetails
API NameRefresh Terminal Configuration
HTTP MethodPOST
Endpoint/api/v1/tms/terminals/web/{trsm}/configuration/refresh
Access LevelsSUPER_ADMIN, PARTNER
Success Response200 OK
Error Response400 Bad Request
Request BodyNot required by the provided Swagger definition

2. Base URL

Production

https://app-api.edfapay.com

Full Endpoint

POST https://app-api.edfapay.com/api/v1/tms/terminals/web/{trsm}/configuration/refresh

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

4. Path Parameters

ParameterTypeRequiredDescription
trsmStringYesIdentifier of the terminal whose configuration must be refreshed.

Example

/api/v1/tms/terminals/web/TERMINAL_IDENTIFIER/configuration/refresh

Replace TERMINAL_IDENTIFIER with the actual terminal identifier.

5. Request Headers

HeaderValueDescription
X-API-KEYYOUR_API_KEYAuthenticates 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/configuration/refresh' \
  --header 'X-API-KEY: YOUR_API_KEY' \
  --header 'Accept: */*'

Implementation notes:

  • Replace TERMINAL_IDENTIFIER with the target terminal's identifier.
  • Replace YOUR_API_KEY with 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.

7.2 HTTP 400 — Bad Request

Indicates that the request was rejected as invalid.

Example response structure:

{
  "code": 0,
  "message": "string",
  "errorCode": "string",
  "data": {}
}
FieldTypeDescription
codeNumberApplication-level response code.
messageStringMessage describing the result or error.
errorCodeStringApplication error identifier, where applicable.
dataObjectAdditional response information.

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

8. Integration Workflow

  1. Authenticate using a valid API key and an authorized SUPER_ADMIN or PARTNER account.
  2. Obtain the identifier of the target terminal.
  3. Construct the endpoint URL using the required trsm path parameter.
  4. Submit a POST request to the configuration refresh endpoint.
  5. Inspect the HTTP status and any returned response payload.
  6. Verify the terminal's configuration state using the appropriate TMS operation, if available.

The exact refresh process and the point at which the updated configuration becomes available are not specified in the provided definition.

9. Error Handling and Troubleshooting

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

  • Confirm that the trsm path parameter is supplied.
  • 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 the response's message and errorCode fields 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 POST method.
  • The terminal identifier is supplied through the required trsm path parameter.
  • The documented access levels are SUPER_ADMIN and PARTNER.
  • Authentication uses the X-API-KEY header.
  • No request body is specified.
  • The stated purpose is to trigger a refresh of terminal configuration parameters.
  • The success response schema, synchronous or asynchronous behavior, and retry safety are not documented in the provided definition and should be verified before production integration.

Did this page help you?