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).
| Attribute | Details |
|---|---|
| Operation | Unbind Terminal |
| HTTP Method | PUT |
| Endpoint | /api/v1/tms/terminals/unbind/{trsm} |
| Access Level | SUPER_ADMIN, PARTNER |
| Success Status | 200 OK |
| Client Error Status | 400 Bad Request |
| Request Body | None documented |
| Authentication | API Key (X-API-KEY) |
2. Endpoint URL
Production
PUT https://app-api.edfapay.com/api/v1/tms/terminals/unbind/{trsm}Path Parameters
| Parameter | Data Type | Required | Description |
|---|---|---|---|
trsm | String | Yes | Identifier of the terminal targeted by the unbind operation. |
Example:
PUT /api/v1/tms/terminals/unbind/TRSM123456TRSM123456 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_ADMINPARTNER
The API key must be valid and authorized to access this operation.
4. Request Headers
| Header | Required | Description |
|---|---|---|
X-API-KEY | Yes | API key used to authenticate the request. |
Accept | Recommended | */*, 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
TRSM123456with the actual terminal identifier. - Replace
YOUR_API_KEYwith a valid API key. - Use the appropriate base URL for the target environment.
- Do not use
Authorization: Bearerfor 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": {}
}| Field | Type | Description |
|---|---|---|
code | Integer | Application-level response code. |
message | String | Response message returned by the service. |
errorCode | String | Application error identifier, where applicable. |
data | Object | Additional 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
- Verify that
trsmis present in the URL. - Confirm that the terminal identifier is correct.
- Inspect the response body for the actual
messageanderrorCode. - Confirm that the API key is valid and the caller has the required access level.
- 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
- Obtain a valid API key for the appropriate EdfaPay environment.
- Construct the endpoint URL using the target terminal's
trsm. - Add the
X-API-KEYheader. - Submit the
PUTrequest without a request body. - Evaluate the HTTP status and response payload.
- Verify the resulting terminal state through the appropriate TMS operation if confirmation is required.
8. Integration Considerations
- Authentication: Use
X-API-KEYfor API Key authentication. - Access control: The documented access levels are
SUPER_ADMINandPARTNER. - 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.
Updated 25 days ago