Unbind Terminal — API

Unbinds a specified terminal from its existing binding through the TMS. Requires a valid API key supplied in the X-API-KEY header and is accessible to SUPER_ADMIN and PARTNER roles.

1. Endpoint Summary

Unbinds a specified terminal through the Terminal Management System (TMS).

AttributeDetails
OperationUnbind Terminal
HTTP MethodPUT
Endpoint/api/v1/tms/terminals/unbind/{trsm}
Access LevelSUPER_ADMIN, PARTNER
Success Status200 OK
Client Error Status400 Bad Request
Request BodyNone documented
AuthenticationAPI Key (X-API-KEY)

2. Endpoint URL

Production

PUT https://app-api.edfapay.com/api/v1/tms/terminals/unbind/{trsm}

Path Parameters

ParameterData TypeRequiredDescription
trsmStringYesIdentifier of the terminal targeted by the unbind operation.

Example:

PUT /api/v1/tms/terminals/unbind/TRSM123456

TRSM123456 is a placeholder for illustration only.

3. Authorization

This endpoint uses API Key authentication through the X-API-KEY request header.

Supported access levels:

  • SUPER_ADMIN
  • PARTNER

The API key must be valid and authorized to access this operation.

4. Request Headers

HeaderRequiredDescription
X-API-KEYYesAPI key used to authenticate the request.
AcceptRecommended*/*, as shown in the Swagger response configuration.

No request body is documented for this operation.

5. cURL Request

curl --request PUT \
  --url 'https://app-api.edfapay.com/api/v1/tms/terminals/unbind/TRSM123456' \
  --header 'X-API-KEY: YOUR_API_KEY' \
  --header 'Accept: */*'

Implementation Notes

  • Replace TRSM123456 with the actual terminal identifier.
  • Replace YOUR_API_KEY with a valid API key.
  • Use the appropriate base URL for the target environment.
  • Do not use Authorization: Bearer for this endpoint unless a separate security configuration explicitly requires it.

6. Response Specification

6.1 HTTP 200 — OK

Indicates that the API returned a successful HTTP response.

Response schema shown in Swagger:

{
  "code": 0,
  "message": "string",
  "errorCode": "string",
  "data": {}
}
FieldTypeDescription
codeIntegerApplication-level response code.
messageStringResponse message returned by the service.
errorCodeStringApplication error identifier, where applicable.
dataObjectAdditional response information.

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

6.2 HTTP 400 — Bad Request

Indicates that the request was rejected as invalid.

Response schema shown in Swagger:

{
  "code": 0,
  "message": "string",
  "errorCode": "string",
  "data": {}
}

Troubleshooting

  1. Verify that trsm is present in the URL.
  2. Confirm that the terminal identifier is correct.
  3. Inspect the response body for the actual message and errorCode.
  4. Confirm that the API key is valid and the caller has the required access level.
  5. Check the terminal's current state if the operation continues to fail.

These are general troubleshooting recommendations; the exact validation rules and error mappings are not specified in the available endpoint schema.

7. Integration Workflow

  1. Obtain a valid API key for the appropriate EdfaPay environment.
  2. Construct the endpoint URL using the target terminal's trsm.
  3. Add the X-API-KEY header.
  4. Submit the PUT request without a request body.
  5. Evaluate the HTTP status and response payload.
  6. Verify the resulting terminal state through the appropriate TMS operation if confirmation is required.

8. Integration Considerations

  • Authentication: Use X-API-KEY for API Key authentication.
  • Access control: The documented access levels are SUPER_ADMIN and PARTNER.
  • Identifier validation: Supply the correct terminal identifier.
  • Error handling: Capture the HTTP status, application response code, message, and error identifier.
  • Environment: Ensure that the request targets the intended environment.
  • Security: Store API keys securely and avoid exposing them in logs, screenshots, or public documentation.

9. API Definition Notes

The available Swagger documentation establishes the endpoint, HTTP method, access levels, required path parameter, and response statuses.

The following details are not established by the displayed endpoint schema:

  • The exact accepted format and validation rules for trsm.
  • The complete application-level success and failure code mappings.
  • Any additional prerequisites or side effects of unbinding.
  • Retry and idempotency guarantees.

Did this page help you?