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.

AttributeDetails
API NameGet Full Terminal Configuration
HTTP MethodGET
Endpoint/api/v1/tms/terminals/{trsm}/full-configuration
Access LevelsSUPER_ADMIN, PARTNER
Success Response200 OK
Error Response400 Bad Request
Request BodyNone
Response Content Type*/*

2. Base URL

Production

https://app-api.edfapay.com

Full Endpoint

GET https://app-api.edfapay.com/api/v1/tms/terminals/{trsm}/full-configuration

3. Authorization

This endpoint is available to the following access levels:

  • SUPER_ADMIN
  • PARTNER

Authentication uses an API key supplied through the X-API-KEY request header.

4. Path Parameters

ParameterTypeRequiredDescription
trsmStringYesTerminal identifier used to retrieve the full configuration.

Example

/api/v1/tms/terminals/TERMINAL_IDENTIFIER/full-configuration

Replace TERMINAL_IDENTIFIER with the actual terminal identifier.

5. Request Headers

HeaderValueDescription
X-API-KEYYOUR_API_KEYAuthenticates 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_IDENTIFIER with the actual terminal identifier.
  • Replace YOUR_API_KEY with a valid API key.
  • This endpoint does not require a request body according to the provided definition.

7. Successful Response — 200 OK

The 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

FieldTypeDescription
codeNumberAPI response code.
messageStringResponse message.
errorCodeStringError identifier, if applicable.
dataObjectFull terminal configuration payload.

8.2 data.cardSchemes

Contains card scheme configuration records.

FieldTypeDescription
cardSchemeIdStringCard scheme identifier.
cardSchemeNameArStringCard scheme name in Arabic.
cardSchemeNameEnStringCard scheme name in English.
cardSchemeAcquirerIdStringAcquirer identifier associated with the card scheme.
enableEmvStringEMV configuration setting.
checkServiceCodeStringService-code checking setting.
offlineRefundIndicatorStringOffline refund configuration.
transactionAllowedStringTransaction permission setting.
cardholderAuthenticationStringCardholder authentication configuration.
supervisorFunctionsStringSupervisor function settings.
manualEntryAllowedStringManual card entry setting.
floorLimitIndicatorStringFloor-limit indicator.
terminalFloorLimitStringTerminal floor limit.
terminalFloorLimitFallbackStringFallback floor-limit setting.
maxCashbackStringMaximum cashback configuration.
maxTransactionAmountIndicatorStringMaximum transaction amount indicator.
maxAmountStringMaximum amount setting.
luhanCheckStringConfiguration field returned under this exact name.
expiryDatePositionStringCard expiry-date position setting.
delayCallSetupStringDelay call setup configuration.
cardRangesStringCard range configuration.
cardPrefixSequenceIndicatorStringCard prefix sequence indicator.
terminalCvmRequiredLimitStringTerminal CVM-required limit.
terminalContactlessTransactionLimitStringContactless transaction limit.
activeBooleanIndicates whether the card scheme record is active.

8.3 data.publicKeyDataDtoList

Contains public-key configuration records.

FieldTypeDescription
ridStringRID value.
keyIndexStringPublic-key index.
hashIdStringHash identifier.
digitalSignatureIdStringDigital signature identifier.
publicKeyStringPublic-key value.
exponentStringPublic-key exponent.
checkSumStringKey checksum.
caPublicKeyLengthStringCertificate-authority public-key length.
caPublicKeyExpiryDateStringCertificate-authority public-key expiry date.

8.4 data.messageTextDtos

Contains terminal message definitions in Arabic and English.

FieldTypeDescription
messageCodeStringMessage identifier.
displayCodeStringDisplay code associated with the message.
arabicMessageTextStringArabic message text.
englishMessageTextStringEnglish message text.

8.5 data.aidDataDtoList

Contains Application Identifier (AID) and EMV configuration records.

FieldTypeDescription
aidStringApplication Identifier.
aidLabelStringAID display label.
terminalAidVersionStringTerminal AID version.
exactOnlySelectionStringExact-only selection setting.
skipEmvProcessingStringEMV processing skip setting.
defaultTdolStringDefault Transaction Certificate Data Object List (TDOL).
defaultDdolStringDefault Dynamic Data Authentication Data Object List (DDOL).
emvAdditionalTagsStringAdditional EMV tags.
denialActionCodeStringDenial Action Code.
onlineActionCodeStringOnline Action Code.
defaultActionCodeStringDefault Action Code.
thresholdValueForBiasedRandomSelectionStringThreshold value for biased random selection.
targetPercentageStringTarget percentage for random selection.
maximumTargetPercentageForBiasedSelectionStringMaximum target percentage for biased selection.

8.6 data.retailerData

Contains retailer details, terminal settings, receipt text, currency information, and transaction-processing parameters.

FieldTypeDescription
terminalIdUUIDTerminal identifier.
idUUIDConfiguration record identifier.
nextLoadStringNext-load setting.
reconciliationTimeStringReconciliation time.
userReconciliationTimeStringUser-specific reconciliation time.
retailerNumberEnglishStringRetailer number in the English configuration.
retailerNameEnglishStringRetailer name in English.
retailerNameArabicStringRetailer name in Arabic.
retailerLanguageIndicatorStringRetailer language setting.
terminalCountryCodeStringTerminal country code.
terminalCurrencyCodeStringTerminal currency code.
transactionCurrencyExponentStringTransaction currency exponent.
currencySymbolArabicStringArabic currency symbol.
currencySymbolEnglishStringEnglish currency symbol.
arabicReceipt1, arabicReceipt2StringArabic receipt text lines.
englishReceipt1, englishReceipt2StringEnglish receipt text lines.
retailerAddress1Arabic, retailerAddress2ArabicStringRetailer address lines in Arabic.
retailerAddress1English, retailerAddress2EnglishStringRetailer address lines in English.
cityEnglishStringCity name in English.
postalCodeStringPostal code.
regionCodeStringRegion code.
countryCodeStringCountry code.
storeIdStringStore identifier.
departmentIdStringDepartment identifier.
terminalFormFactorStringTerminal form-factor setting.
merchantCategoryCodeStringMerchant Category Code (MCC).
acquirerIdStringAcquirer identifier.
terminalCapabilityStringTerminal capability setting.
additionalTerminalCapabilitiesStringAdditional terminal capabilities.
downloadPhoneNumberStringDownload phone number setting.
emvTerminalTypeStringEMV terminal type.
automaticLoadStringAutomatic-load setting.
safRetryLimitStringStore-and-forward retry limit.
safDefaultMessageTransmissionNumberStringDefault SAF message transmission number.
safMaxDepthStringMaximum SAF depth.
safMaxCumulativeAmountStringMaximum cumulative SAF amount.
idleTimeStringTerminal idle-time setting.
maxReconciliationAmountStringMaximum reconciliation amount.
maxTransactionsProcessedStringMaximum number of transactions processed.
acquirerBankStringAcquirer bank setting.
qrCodePrintIndicatorStringQR-code printing indicator.
providerMidStringProvider merchant identifier.
tmsVersionStringTerminal Management System version.

8.7 data.deviceSpecific

Contains device-level configuration and device-specific card scheme limits.

FieldTypeDescription
safMaxDepthStringMaximum store-and-forward depth.
safMaxCumulativeAmountStringMaximum cumulative store-and-forward amount.
idleTimeStringDevice idle-time setting.
maxReconciliationAmountStringMaximum reconciliation amount.
maxTransactionsProcessedStringMaximum transactions processed.
qrCodePrintIndicatorStringQR-code printing indicator.
deviceSpecificCardSchemeDtosArrayDevice-specific card scheme configuration records.

Each deviceSpecificCardSchemeDtos record contains:

FieldTypeDescription
cardSchemeStringCard scheme identifier or name.
terminalContactlessTransactionLimitStringContactless transaction limit.
terminalCVMRequiredLimitStringCardholder Verification Method (CVM) required limit.
terminalContactlessFloorLimitStringContactless floor limit.

9. Error Response — 400 Bad Request

The endpoint documents 400 Bad Request as a possible response.

Example Response

{
  "code": 0,
  "message": "string",
  "errorCode": "string",
  "data": {}
}
FieldTypeDescription
codeNumberAPI response code.
messageStringError or response message.
errorCodeStringError identifier.
dataObjectAdditional error details; empty in the documented example.

The values shown are Swagger example placeholders, not confirmed runtime response values.

10. Integration Workflow

  1. Authenticate using a valid API key and an authorized SUPER_ADMIN or PARTNER account.
  2. Obtain the trsm identifier of the target terminal.
  3. Construct the endpoint URL using the required path parameter.
  4. Submit a GET request to retrieve the full terminal configuration.
  5. Check the HTTP status and inspect the response envelope.
  6. Read the required configuration groups from the data object.
  7. Handle missing or empty configuration sections according to the application's requirements.

11. Important Considerations

  • The endpoint uses the GET method.
  • The required trsm path parameter identifies the terminal.
  • The documented access levels are SUPER_ADMIN and PARTNER.
  • Authentication uses the X-API-KEY header.
  • 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.

Did this page help you?