Get Terminal Assignment Details — API
Retrieves assignment history for a specified terminal using its terminalId UUID. Returns previous and new business unit and merchant details, assignment status, record creation timestamp, and creator information. Accessible to SUPER_ADMIN and PARTNER roles using API Key authentication through the X-API-KEY header.
1. Overview
The Get Terminal Assignment Details API retrieves the assignment history and details for a specified terminal. The response includes associated business units and merchants, assignment status, record creation timestamp, and the user who created each assignment record.
Access Levels: SUPER_ADMIN, PARTNER
2. Endpoint Details
| Property | Value |
|---|---|
| API Name | Get Terminal Assignment Details |
| HTTP Method | GET |
| Endpoint | /api/v1/tms/terminals/terminal/{terminalId}/terminal-assignment |
| 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/terminal/{terminalId}/terminal-assignment4. 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 |
|---|---|---|---|
terminalId | UUID | Yes | Unique identifier of the terminal whose assignment details are requested. |
Example
/api/v1/tms/terminals/terminal/3fa85f64-5717-4562-b3fc-2c963f66afa6/terminal-assignmentReplace the example UUID with the actual terminal ID.
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/terminal/TERMINAL_UUID/terminal-assignment' \
--header 'X-API-KEY: YOUR_API_KEY' \
--header 'Accept: */*'Implementation notes:
- Replace
TERMINAL_UUIDwith the actual terminal UUID. - Replace
YOUR_API_KEYwith a valid API key. - This endpoint retrieves assignment records and does not perform an assignment.
8. Successful Response — 200 OK
200 OKExample Response
{
"code": 0,
"message": "string",
"errorCode": "string",
"data": [
{
"id": 0,
"terminalId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"oldBusinessUnitId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"newBusinessUnitId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"oldMerchantName": "string",
"newMerchantName": "string",
"oldMerchantId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"newMerchantId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"createdAt": "2026-10-28T12:09:28.375Z",
"createdBy": "string",
"assign": true
}
]
}The values shown are Swagger example placeholders and do not represent actual assignment records.
9. Response Fields
9.1 Top-Level Fields
| Field | Type | Description |
|---|---|---|
code | Number | API response code. |
message | String | Response message. |
errorCode | String | Error identifier, if applicable. |
data | Array | List of terminal assignment records. |
9.2 Assignment Record — data[]
data[]| Field | Type | Description |
|---|---|---|
id | Number | Assignment record identifier. |
terminalId | UUID | Terminal identifier. |
oldBusinessUnitId | UUID | Previous business unit identifier. |
newBusinessUnitId | UUID | New business unit identifier. |
oldMerchantName | String | Previous merchant name. |
newMerchantName | String | New merchant name. |
oldMerchantId | UUID | Previous merchant identifier. |
newMerchantId | UUID | New merchant identifier. |
createdAt | String (date-time) | Timestamp when the assignment record was created. |
createdBy | String | User or actor recorded as creating the assignment record. |
assign | Boolean | Indicates whether the record represents an assignment (true) or an unassignment (false). |
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 UUID of the target terminal.
- Submit a
GETrequest to the terminal assignment endpoint. - Inspect the HTTP status and response payload.
- Iterate through the
dataarray to review the returned assignment records. - Compare the previous and new business unit or merchant fields where applicable.
- Use
assignto identify whether each record represents an assignment or an unassignment.
12. Error Handling and Troubleshooting
If the API returns 400 Bad Request, consider checking the following:
- Confirm that
terminalIdis supplied in the URL. - Verify that
terminalIdis a valid UUID. - 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
terminalIdpath parameter must be a UUID. - The documented access levels are
SUPER_ADMINandPARTNER. - Authentication uses the
X-API-KEYheader. - The response's
datafield is an array and can contain multiple assignment records. - Previous and new business unit and merchant fields can help identify changes in terminal assignment.
- Sorting, pagination, and the complete set of possible assignment scenarios are not specified in the provided API definition.
Updated 25 days ago