Get Terminal Details — API
Retrieves detailed information for a specified terminal using its terminalId UUID. Returns card scheme configurations, merchant information, and terminal features with their activation status. Accessible to SUPER_ADMIN, PARTNER, and MERCHANT roles using API Key authentication through the X-API-KEY header.
1. Overview
The Get Terminal Details API retrieves detailed information for a specific terminal using its unique terminal ID. The response includes card scheme configurations, merchant information, and terminal features with their activation status.
Access Levels: SUPER_ADMIN, PARTNER, MERCHANT
2. Endpoint Details
| Property | Value |
|---|---|
| API Name | Get Terminal Details |
| HTTP Method | GET |
| Endpoint | /api/v1/tms/terminals/terminal-detail/{terminalId} |
| Access Levels | SUPER_ADMIN, PARTNER, MERCHANT |
| 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-detail/{terminalId}4. Authorization
This endpoint is available to the following access levels:
SUPER_ADMINPARTNERMERCHANT
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 details are requested. |
Example
/api/v1/tms/terminals/terminal-detail/3fa85f64-5717-4562-b3fc-2c963f66afa6Replace 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-detail/TERMINAL_UUID' \
--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 terminal details and does not modify the terminal configuration.
8. Successful Response — 200 OK
200 OKExample Response
{
"code": 0,
"message": "string",
"errorCode": "string",
"data": {
"cardSchemes": [
{
"cardSchemeId": "string",
"cardSchemeNameAr": "string",
"cardSchemeNameEn": "string",
"cardSchemeAcquirerId": "string",
"enableEmv": "string",
"checkServiceCode": "string",
"offlineRefundIndicator": "string",
"transactionAllowed": "string",
"cardholderAuthentication": "string",
"supervisorFunctions": "string",
"manualEntryAllowed": "string",
"floorLimitIndicator": "string",
"terminalFloorLimit": "string",
"terminalFloorLimitFallback": "string",
"maxCashback": "string",
"maxTransactionAmountIndicator": "string",
"maxAmount": "string",
"luhanCheck": "string",
"expiryDatePosition": "string",
"delayCallSetup": "string",
"cardRanges": "string",
"cardPrefixSequenceIndicator": "string",
"terminalCvmRequiredLimit": "string",
"terminalContactlessTransactionLimit": "string",
"active": true
}
],
"merchantDto": {
"merchantName": "string",
"merchantAddress": "string",
"providerMid": "string"
},
"terminalFeatures": [
{
"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"type": "string",
"active": true
}
]
}
}The values shown are Swagger example placeholders and do not represent actual terminal data.
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 | Object | Contains card scheme, merchant, and terminal feature details. |
9.2 data.cardSchemes
data.cardSchemesAn array of card scheme configuration records associated with the terminal.
| Field | Type | Description |
|---|---|---|
cardSchemeId | String | Card scheme identifier. |
cardSchemeNameAr | String | Card scheme name in Arabic. |
cardSchemeNameEn | String | Card scheme name in English. |
cardSchemeAcquirerId | String | Acquirer identifier associated with the card scheme. |
enableEmv | String | EMV configuration setting. |
checkServiceCode | String | Service-code checking setting. |
offlineRefundIndicator | String | Offline refund configuration. |
transactionAllowed | String | Transaction permission setting. |
cardholderAuthentication | String | Cardholder authentication configuration. |
supervisorFunctions | String | Supervisor function settings. |
manualEntryAllowed | String | Manual card entry setting. |
floorLimitIndicator | String | Floor-limit indicator. |
terminalFloorLimit | String | Terminal floor limit. |
terminalFloorLimitFallback | String | Fallback floor-limit setting. |
maxCashback | String | Maximum cashback configuration. |
maxTransactionAmountIndicator | String | Maximum transaction amount indicator. |
maxAmount | String | Maximum amount setting. |
luhanCheck | String | Configuration field returned under this exact name. |
expiryDatePosition | String | Card expiry-date position setting. |
delayCallSetup | String | Delay call setup configuration. |
cardRanges | String | Card range configuration. |
cardPrefixSequenceIndicator | String | Card prefix sequence indicator. |
terminalCvmRequiredLimit | String | Terminal CVM-required limit. |
terminalContactlessTransactionLimit | String | Contactless transaction limit. |
active | Boolean | Indicates whether the card scheme record is active. |
9.3 data.merchantDto
data.merchantDtoContains merchant information associated with the terminal.
| Field | Type | Description |
|---|---|---|
merchantName | String | Merchant name. |
merchantAddress | String | Merchant address. |
providerMid | String | Provider merchant identifier. |
9.4 data.terminalFeatures
data.terminalFeaturesAn array of terminal feature records.
| Field | Type | Description |
|---|---|---|
id | UUID | Unique identifier of the terminal feature record. |
type | String | Feature type or name. |
active | Boolean | Indicates whether the feature is active. |
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_ADMIN,PARTNER, orMERCHANTaccount. - Obtain the UUID of the target terminal.
- Submit a
GETrequest to the terminal details endpoint. - Inspect the HTTP status and response payload.
- Read the
cardSchemesarray to review the returned card scheme configurations. - Read
merchantDtoto access the merchant information returned for the terminal. - Review
terminalFeaturesand each feature'sactivestatus.
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_ADMIN,PARTNER, andMERCHANT. - Authentication uses the
X-API-KEYheader. - No request body or query parameters are defined.
- The response contains card scheme configurations, merchant details, and terminal feature activation statuses.
- The complete set of possible card scheme values and terminal feature types is not specified in the provided schema.
Updated 25 days ago