Get Full Terminal Configuration — API
Retrieves the complete configuration for a specified terminal using its trsm identifier. Returns card scheme settings, public key records, transaction message texts, EMV AID configuration, retailer information, and device-specific parameters. Accessible to SUPER_ADMIN and PARTNER roles using API Key authentication through the X-API-KEY header.
1. Endpoint Summary
The Get Full Terminal Configuration API retrieves the complete configuration associated with a specified terminal. The response includes card scheme settings, public key data, transaction message texts, EMV AID configuration, retailer information, and device-specific parameters.
| Attribute | Details |
|---|---|
| API Name | Get Full Terminal Configuration |
| HTTP Method | GET |
| Endpoint | /api/v1/tms/terminals/{trsm}/full-configuration |
| Access Levels | SUPER_ADMIN, PARTNER |
| Success Response | 200 OK |
| Error Response | 400 Bad Request |
| Request Body | None |
| Response Content Type | */* |
2. Base URL
Production
https://app-api.edfapay.comFull Endpoint
GET https://app-api.edfapay.com/api/v1/tms/terminals/{trsm}/full-configuration3. 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.
4. Path Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
trsm | String | Yes | Terminal identifier used to retrieve the full configuration. |
Example
/api/v1/tms/terminals/TERMINAL_IDENTIFIER/full-configurationReplace TERMINAL_IDENTIFIER with the actual terminal identifier.
5. 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.
6. cURL Example
curl --request GET \
--url 'https://app-api.edfapay.com/api/v1/tms/terminals/TERMINAL_IDENTIFIER/full-configuration' \
--header 'X-API-KEY: YOUR_API_KEY' \
--header 'Accept: */*'Implementation notes:
- Replace
TERMINAL_IDENTIFIERwith the actual terminal identifier. - Replace
YOUR_API_KEYwith a valid API key. - This endpoint does not require a request body according to the provided definition.
7. Successful Response — 200 OK
200 OKThe response uses a standard envelope containing the API result and a data object with the terminal configuration.
Example 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
}
],
"publicKeyDataDtoList": [
{
"rid": "string",
"keyIndex": "string",
"hashId": "string",
"digitalSignatureId": "string",
"publicKey": "string",
"exponent": "string",
"checkSum": "string",
"caPublicKeyLength": "string",
"caPublicKeyExpiryDate": "string"
}
],
"messageTextDtos": [
{
"messageCode": "string",
"displayCode": "string",
"arabicMessageText": "string",
"englishMessageText": "string"
}
],
"aidDataDtoList": [
{
"aid": "string",
"aidLabel": "string",
"terminalAidVersion": "string",
"exactOnlySelection": "string",
"skipEmvProcessing": "string",
"defaultTdol": "string",
"defaultDdol": "string",
"emvAdditionalTags": "string",
"denialActionCode": "string",
"onlineActionCode": "string",
"defaultActionCode": "string",
"thresholdValueForBiasedRandomSelection": "string",
"targetPercentage": "string",
"maximumTargetPercentageForBiasedSelection": "string"
}
],
"retailerData": {
"terminalId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"nextLoad": "string",
"reconciliationTime": "string",
"userReconciliationTime": "string",
"retailerNumberEnglish": "string",
"retailerNameEnglish": "string",
"retailerNameArabic": "string",
"retailerLanguageIndicator": "string",
"terminalCountryCode": "string",
"terminalCurrencyCode": "string",
"transactionCurrencyExponent": "string",
"currencySymbolArabic": "string",
"currencySymbolEnglish": "string",
"arabicReceipt1": "string",
"arabicReceipt2": "string",
"englishReceipt1": "string",
"englishReceipt2": "string",
"retailerAddress1Arabic": "string",
"retailerAddress2Arabic": "string",
"retailerAddress1English": "string",
"retailerAddress2English": "string",
"cityEnglish": "string",
"postalCode": "string",
"regionCode": "string",
"countryCode": "string",
"storeId": "string",
"departmentId": "string",
"terminalFormFactor": "string",
"merchantCategoryCode": "string",
"acquirerId": "string",
"terminalCapability": "string",
"additionalTerminalCapabilities": "string",
"downloadPhoneNumber": "string",
"emvTerminalType": "string",
"automaticLoad": "string",
"safRetryLimit": "string",
"safDefaultMessageTransmissionNumber": "string",
"safMaxDepth": "string",
"safMaxCumulativeAmount": "string",
"idleTime": "string",
"maxReconciliationAmount": "string",
"maxTransactionsProcessed": "string",
"acquirerBank": "string",
"qrCodePrintIndicator": "string",
"providerMid": "string",
"tmsVersion": "string"
},
"deviceSpecific": {
"safMaxDepth": "string",
"safMaxCumulativeAmount": "string",
"idleTime": "string",
"maxReconciliationAmount": "string",
"maxTransactionsProcessed": "string",
"qrCodePrintIndicator": "string",
"deviceSpecificCardSchemeDtos": [
{
"cardScheme": "string",
"terminalContactlessTransactionLimit": "string",
"terminalCVMRequiredLimit": "string",
"terminalContactlessFloorLimit": "string"
}
]
}
}
}The values shown are Swagger example placeholders and do not represent actual terminal configuration values.
8. Response Structure
8.1 Top-Level Fields
| Field | Type | Description |
|---|---|---|
code | Number | API response code. |
message | String | Response message. |
errorCode | String | Error identifier, if applicable. |
data | Object | Full terminal configuration payload. |
8.2 data.cardSchemes
data.cardSchemesContains card scheme configuration records.
| 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. |
8.3 data.publicKeyDataDtoList
data.publicKeyDataDtoListContains public-key configuration records.
| Field | Type | Description |
|---|---|---|
rid | String | RID value. |
keyIndex | String | Public-key index. |
hashId | String | Hash identifier. |
digitalSignatureId | String | Digital signature identifier. |
publicKey | String | Public-key value. |
exponent | String | Public-key exponent. |
checkSum | String | Key checksum. |
caPublicKeyLength | String | Certificate-authority public-key length. |
caPublicKeyExpiryDate | String | Certificate-authority public-key expiry date. |
8.4 data.messageTextDtos
data.messageTextDtosContains terminal message definitions in Arabic and English.
| Field | Type | Description |
|---|---|---|
messageCode | String | Message identifier. |
displayCode | String | Display code associated with the message. |
arabicMessageText | String | Arabic message text. |
englishMessageText | String | English message text. |
8.5 data.aidDataDtoList
data.aidDataDtoListContains Application Identifier (AID) and EMV configuration records.
| Field | Type | Description |
|---|---|---|
aid | String | Application Identifier. |
aidLabel | String | AID display label. |
terminalAidVersion | String | Terminal AID version. |
exactOnlySelection | String | Exact-only selection setting. |
skipEmvProcessing | String | EMV processing skip setting. |
defaultTdol | String | Default Transaction Certificate Data Object List (TDOL). |
defaultDdol | String | Default Dynamic Data Authentication Data Object List (DDOL). |
emvAdditionalTags | String | Additional EMV tags. |
denialActionCode | String | Denial Action Code. |
onlineActionCode | String | Online Action Code. |
defaultActionCode | String | Default Action Code. |
thresholdValueForBiasedRandomSelection | String | Threshold value for biased random selection. |
targetPercentage | String | Target percentage for random selection. |
maximumTargetPercentageForBiasedSelection | String | Maximum target percentage for biased selection. |
8.6 data.retailerData
data.retailerDataContains retailer details, terminal settings, receipt text, currency information, and transaction-processing parameters.
| Field | Type | Description |
|---|---|---|
terminalId | UUID | Terminal identifier. |
id | UUID | Configuration record identifier. |
nextLoad | String | Next-load setting. |
reconciliationTime | String | Reconciliation time. |
userReconciliationTime | String | User-specific reconciliation time. |
retailerNumberEnglish | String | Retailer number in the English configuration. |
retailerNameEnglish | String | Retailer name in English. |
retailerNameArabic | String | Retailer name in Arabic. |
retailerLanguageIndicator | String | Retailer language setting. |
terminalCountryCode | String | Terminal country code. |
terminalCurrencyCode | String | Terminal currency code. |
transactionCurrencyExponent | String | Transaction currency exponent. |
currencySymbolArabic | String | Arabic currency symbol. |
currencySymbolEnglish | String | English currency symbol. |
arabicReceipt1, arabicReceipt2 | String | Arabic receipt text lines. |
englishReceipt1, englishReceipt2 | String | English receipt text lines. |
retailerAddress1Arabic, retailerAddress2Arabic | String | Retailer address lines in Arabic. |
retailerAddress1English, retailerAddress2English | String | Retailer address lines in English. |
cityEnglish | String | City name in English. |
postalCode | String | Postal code. |
regionCode | String | Region code. |
countryCode | String | Country code. |
storeId | String | Store identifier. |
departmentId | String | Department identifier. |
terminalFormFactor | String | Terminal form-factor setting. |
merchantCategoryCode | String | Merchant Category Code (MCC). |
acquirerId | String | Acquirer identifier. |
terminalCapability | String | Terminal capability setting. |
additionalTerminalCapabilities | String | Additional terminal capabilities. |
downloadPhoneNumber | String | Download phone number setting. |
emvTerminalType | String | EMV terminal type. |
automaticLoad | String | Automatic-load setting. |
safRetryLimit | String | Store-and-forward retry limit. |
safDefaultMessageTransmissionNumber | String | Default SAF message transmission number. |
safMaxDepth | String | Maximum SAF depth. |
safMaxCumulativeAmount | String | Maximum cumulative SAF amount. |
idleTime | String | Terminal idle-time setting. |
maxReconciliationAmount | String | Maximum reconciliation amount. |
maxTransactionsProcessed | String | Maximum number of transactions processed. |
acquirerBank | String | Acquirer bank setting. |
qrCodePrintIndicator | String | QR-code printing indicator. |
providerMid | String | Provider merchant identifier. |
tmsVersion | String | Terminal Management System version. |
8.7 data.deviceSpecific
data.deviceSpecificContains device-level configuration and device-specific card scheme limits.
| Field | Type | Description |
|---|---|---|
safMaxDepth | String | Maximum store-and-forward depth. |
safMaxCumulativeAmount | String | Maximum cumulative store-and-forward amount. |
idleTime | String | Device idle-time setting. |
maxReconciliationAmount | String | Maximum reconciliation amount. |
maxTransactionsProcessed | String | Maximum transactions processed. |
qrCodePrintIndicator | String | QR-code printing indicator. |
deviceSpecificCardSchemeDtos | Array | Device-specific card scheme configuration records. |
Each deviceSpecificCardSchemeDtos record contains:
| Field | Type | Description |
|---|---|---|
cardScheme | String | Card scheme identifier or name. |
terminalContactlessTransactionLimit | String | Contactless transaction limit. |
terminalCVMRequiredLimit | String | Cardholder Verification Method (CVM) required limit. |
terminalContactlessFloorLimit | String | Contactless floor limit. |
9. 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.
10. Integration Workflow
- Authenticate using a valid API key and an authorized
SUPER_ADMINorPARTNERaccount. - Obtain the
trsmidentifier of the target terminal. - Construct the endpoint URL using the required path parameter.
- Submit a
GETrequest to retrieve the full terminal configuration. - Check the HTTP status and inspect the response envelope.
- Read the required configuration groups from the
dataobject. - Handle missing or empty configuration sections according to the application's requirements.
11. Important Considerations
- The endpoint uses the
GETmethod. - The required
trsmpath parameter identifies the terminal. - The documented access levels are
SUPER_ADMINandPARTNER. - Authentication uses the
X-API-KEYheader. - No request body or query parameters are defined in the provided API documentation.
- The response includes card schemes, public-key records, message texts, AID settings, retailer data, and device-specific parameters.
- Returned values in the example are placeholders and must not be treated as actual production configuration.
- Exact accepted values and validation rules are not specified for every configuration field and should be confirmed with the responsible technical team where necessary.
Updated 25 days ago