Key Settings
Settings that may be different for each POS.
Table 4-1 OPI - Key Settings
| Setting | Type | Default | Description |
|---|---|---|---|
| networks | object | __________ | Network-related configuration |
| networks.epsName | string |
An identifiable name for the solution. Typically, the Payment Server Provider’s name is used. For example: "epsName": "myPaymentProvider", |
|
| networks.store | object | __________ | Local store network configuration |
| networks.store.enabled | boolean | true | Enable communication with local LAN network endpoints. |
| networks.store.endPoint | string | The HTTPS address for the network endpoint {format: https://<IP>:<PORT> | |
| networks.store.connectTimeoutMillis | number | 5000 | The connection timeout in milliseconds to the endpoint. |
| networks.store.requestResponseTimeoutMillis | number | 180000 | The timeout, in milliseconds, that specifies how long to wait for the response from the endpoint. It is recommended that this value is greater than the endpoint’s own timeout. |
| networks.store.terminalId | string | The unique Terminal Id which is usually determined by the PSP. | |
| networks.store.enableSettingOfTerminalId | boolean | false | Allows the terminalId to be included in applicable transaction request. |
| networks.store.validateMessaging | boolean | false | If enabled, the request and response messages are validated against XSD’s. Note this does not prevent the messages from being forwarded. Any validation issues are recorded EFTLink log. |
| trustStore | object | __________ | |
| networks.store.trustStore.trustAllServers | boolean | false |
Disable validation of certificates with the truststore on connection between EFTLink and OPI devices. Please note, disabling validation of the trusted certificate is never a recommended practice. Ciphers and protocols restrictions continue to apply even when validation is disabled. |
| networks.store.trustStore.disableHostnameVerification | boolean | true | |
| networks.store.trustStore.useJVMTrustStore | boolean | false | |
| networks.store.trustStore.expiringLogWarningDays | number | 90 | Number of Days prior to TLS certificate expiry that error warnings will be placed in EFTLink log files. |
| networks.store.trustStore.protocolsAllowList | array | TLSv1.3, TLSv1.2 | Restricts the protocols which are permissible in the connection between EFTLink and OPI devices. |
| networks.store.trustStore .cipherAllowList | array | TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256, TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384, TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256, TLS_AES_128_GCM_SHA256, TLS_AES_256_GCM_SHA384, TLS_CHACHA20_POLY1305_SHA256, TLS_AES_128_CCM_SHA256, TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384, TLS_ECDHE_ECDSA_WITH_CHACHA20_POLY1305_SHA256, TLS_ECDHE_RSA_WITH_CHACHA20_POLY1305_SHA256, TLS_ECDHE_ECDSA_WITH_AES_256_CCM, "LS_ECDHE_ECDSA_WITH_AES_128_CCM | Restricts the ciphers which are permissible in the connection between EFTLink and OPI devices. It is recommended that the allow list only include ciphers which are approved under Oracle Approved Technologies: Security Protocols |
| networks.store.trustStore.cipherDenyList | array | SSL_.*, TLS_EMPTY_.*, .*_SHA, .*_3DES_.*, .*_DES_.*, .*_WITH_NULL_.*, .*_anon_.*, .*EXPORT.*, .*LOW.*, .*MD5.*, .*DES.*, .*RC2.*, .*RC4.*, .*PSK.*, TLS_DH_.*, TLS_DHE_.* | Restricts the ciphers which are not permissible in the connection between EFTLink and OPI devices. The deny list by default includes ciphers which are not approved under Oracle Approved Technologies: Security Protocols. |
| networks.cloud | object | __________ | |
| networks.cloud.enabled | boolean | false | Enables communication with cloud-based network endpoints |
| networks.cloud.endPoint | string |
The HTTPS address for the cloud endpoint {format: https://<CLOUD_SERVICE_ENDPOINT>:<PORT>/<MERCHANT_ACCOUNT>/<TERMINAL_ID>} The values stored in terminId and merchantAccount can be inserted automatically using $terminalId and $merchantAccount. |
|
| networks.cloud.connectTimeoutMillis | number | 5000 | The connection timeout in milliseconds to the endpoint. |
| networks.cloud.requestResponseTimeoutMillis | number | 180000 | The timeout, in milliseconds, that specifies how long to wait for the response from the endpoint. It is recommended that this value is greater than the endpoint’s own timeout. |
| networks.cloud.terminalId | string | The unique Terminal Id which is usually determined by the PSP | |
| networks.cloud.enableSettingOfTerminalId | boolean | false | Allows the terminalId to be included in applicable transaction request. |
| networks.cloud.merchantAccount | string | The Merchant Account name. | |
| networks.cloud.apiKeyEncrypted | string | Encrypted API key required for authenticating requests. | |
| networks.cloud.routeAllTransactions | boolean | false | If enabled, routes all transaction types specified in the key “transactionType” to the cloud endpoint. |
| networks.cloud.validateMessaging | boolean | false | If enabled, the request and response messages are validated against XSD’s. Note this does not prevent the messages from being forwarded. Any validation issues are recorded EFTLink log. |
| networks.cloud.transactionType | array | 56,57,58,81 | |
| trustStore | object | __________ | |
| networks.cloud.trustStore.trustAllServers | boolean | false |
Disable validation of certificates with the truststore on connection between EFTLink and the cloud endpoint. Please note, disabling validation of the trusted certificate is never a recommended practice. Ciphers and protocols restrictions continue to apply even when validation is disabled. |
| networks.cloud.trustStore.disableHostnameVerification | boolean | true | |
| networks.cloud.trustStore.expiringLogWarningDays | number | 90 | Number of Days prior to TLS certificate expiry that error warnings will be placed in EFTLink log files. |
| networks.cloud.trustStore.protocolsAllowList | array | TLSv1.3,TLSv1.2 | Restricts the protocols which are permissible in the connection between EFTLink and OPI devices. |
| networks.cloud.trustStore .cipherAllowList | array | TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256, TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384, TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256, TLS_AES_128_GCM_SHA256, TLS_AES_256_GCM_SHA384, TLS_CHACHA20_POLY1305_SHA256, TLS_AES_128_CCM_SHA256, TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384, TLS_ECDHE_ECDSA_WITH_CHACHA20_POLY1305_SHA256, TLS_ECDHE_RSA_WITH_CHACHA20_POLY1305_SHA256, TLS_ECDHE_ECDSA_WITH_AES_256_CCM, "LS_ECDHE_ECDSA_WITH_AES_128_CCM | Restricts the ciphers which are permissible in the connection between EFTLink and OPI devices. It is recommended that the allow list only include ciphers which are approved under Oracle Approved Technologies: Security Protocols |
| networks.cloud.trustStore.cipherDenyList | array | SSL_.*, TLS_EMPTY_.*, .*_SHA, .*_3DES_.*, .*_DES_.*, .*_WITH_NULL_.*, .*_anon_.*, .*EXPORT.*, .*LOW.*, .*MD5.*, .*DES.*, .*RC2.*, .*RC4.*, .*PSK.*, TLS_DH_.*, TLS_DHE_.* | Restricts the ciphers which are not permissible in the connection between EFTLink and OPI devices. The deny list by default includes ciphers which are not approved under Oracle Approved Technologies: Security Protocols. |
| networks.customerFeedbackService | object | __________ | |
| networks.customerFeedbackService.enabled | boolean | false | Enables communication with customer feedback service endpoint. |
| networks.customerFeedbackService.endpoint | string | https://{FEEDBACK_SERVER}:{PORT} | The HTTPS address of the Customer Feedback service, typically hosted in the cloud {format: https://<FEEDBACK_SERVER>:<PORT>} |
| networks.customerFeedbackService.apiKeyEncrypted | string | Encrypted API key required for authenticating requests. | |
| networks.customerFeedbackService.feedbackStatusCheckEnabled | boolean | false | Enables |
| networks.customerFeedbackService.statusTaskIntervalMinutes | number | 10 | Interval (in minutes) between activation status queries sent by OPI. |
| networks.customerFeedbackService.sendItemDetailsOnRequest | boolean | true | Indicates whether item details are included within the `posTransactionDetails` section of the Customer Feedback form request. |
| networks.customerFeedbackService.questionScreenTimeout | number | 60 | Time limit for the question screen when not provided by the web service. |
| networks.customerFeedbackService.displayCustomFormBeforePayment | boolean | true | Determines if the OPI Enhanced form will be displayed before payment process. |
| networks.customerFeedbackService.connectTimeoutMillis | number | 500 | Maximum time that OPI waits to establish a connection with the web service. |
| networks.customerFeedbackService.requestResponseTimeoutMillis | number | 500 | Time limit for OPI to receive a response after sending a request. |
| networks.customerFeedbackService.retries | number | 5 | Number of retry attempts OPI makes to connect to the web service. |
| networks.customerFeedbackService.questionScreenTimeoutSeconds | number | 15 | Time limit for the question screen when not provided by the web service. |
| networks.customerFeedbackService.ackScreenTimeoutSeconds | number | 15 | Time limit for the acknowledgement screen when not provided by the web service. |
| networks.customerFeedbackService.epsTerminalId | string | The termina ID. This is usually provided. | |
| networks.customerFeedbackService.epsManufacturer | string | The terminal manufacturer name. | |
| networks.customerFeedbackService.epsModel | string | The terminal model name. | |
| networks.customerFeedbackService.trustStore | object | __________ | |
| networks.customerFeedbackService.trustStore.trustAllServers | boolean | false |
Disable validation of certificates with the truststore on connection between EFTLink and the cloud endpoint. Please note, disabling validation of the trusted certificate is never a recommended practice. Ciphers and protocols restrictions continue to apply even when validation is disabled. |
| networks.customerFeedbackService.trustStore.disableHostnameVerification | boolean | true | |
| networks.customerFeedbackService.trustStore.expiringLogWarningDays | number | 90 | Number of Days prior to TLS certificate expiry that error warnings will be placed in EFTLink log files. |
| networks.customerFeedbackService.trustStore.protocolsAllowList | array | TLSv1.3,TLSv1.2 | Restricts the protocols which are permissible in the connection between EFTLink and OPI devices. |
| networks.customerFeedbackService.trustStore .cipherAllowList | array | TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256, TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384, TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256, TLS_AES_128_GCM_SHA256, TLS_AES_256_GCM_SHA384, TLS_CHACHA20_POLY1305_SHA256, TLS_AES_128_CCM_SHA256, TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384, TLS_ECDHE_ECDSA_WITH_CHACHA20_POLY1305_SHA256, TLS_ECDHE_RSA_WITH_CHACHA20_POLY1305_SHA256, TLS_ECDHE_ECDSA_WITH_AES_256_CCM, "LS_ECDHE_ECDSA_WITH_AES_128_CCM | Restricts the ciphers which are permissible in the connection between EFTLink and OPI devices. It is recommended that the allow list only include ciphers which are approved under Oracle Approved Technologies: Security Protocols |
| networks.customerFeedbackService.trustStore. cipherDenyList | array | SSL_.*, TLS_EMPTY_.*, .*_SHA, .*_3DES_.*, .*_DES_.*, .*_WITH_NULL_.*, .*_anon_.*, .*EXPORT.*, .*LOW.*, .*MD5.*, .*DES.*, .*RC2.*, .*RC4.*, .*PSK.*, TLS_DH_.*, TLS_DHE_.* | Restricts the ciphers which are not permissible in the connection between EFTLink and OPI devices. The deny list by default includes ciphers which are not approved under Oracle Approved Technologies: Security Protocols. |
| maintenanceTimeout | number | 60 | Timeout in seconds for the maintenance menu/admin menu. |
| partialAuthEnabled | boolean | true | Specifies whether partial authorization is enabled. |
| electronicSignatureEnabled | boolean | true | Specifies whether Electronic Signature processing is enabled. |
| giftCard | object | __________ | |
| giftCard.enabled | boolean | true | Specifies whether Gift Card processing is enabled |
| giftCard.pinEntryOnPosEnabled | boolean | false | Specifies whether to enable processing of Gift Card Pins from the POS. |
| giftCard.pinEntryOnPedEnabled | boolean | false |
Specifies whether to request a PIN for the supplied Gift Card on the PED. Note, if pinEntryOnPosEnabled is enabled then that setting will take priority. |
| giftCard.pinEntryTypes | array | 27,28,29,30 | Specifies which OPI Retail Gift Card Transactions should apply Gift Card PIN processing. |
| giftCard.pinEntryMinimumLength | number | 4 | Specifies the minimum length of the PIN to be entered on the POS. |
| giftCard.pinEntryMaximumLength | number | 4 | Specifies the maximum length of the PIN to be entered on the POS. |
| giftCard.pinEntryRetries | number | 3 | Specifies the maximum amount of retries to attempt on the POS if the default maximum length of the PIN in the OPI specification is exceeded. |
| giftCard.providers | array |
Specifies the gift card provider to use when a single entry is configured. If a list of providers is specified, the cashier will be prompted to select the provider from the list. If no GiftCardProvider is specified, then this entry will not be used, and no value is passed to the EPS in the ProviderId element of the TransactionRequest. |
|
| giftCard.providersPromptTimeout | number | 1200 | Specifies the timeout in seconds, for the Gift Card Provider selection prompt. |
| forms | object | __________ | |
| forms.getPhoneNumberMaxLength | number | 10 | Specifies the maximum number of digits for the phone number capture custom form. |
| forms.getPhoneNumberRegex | string | \\d{3}-\\d{3}-\\d{4} | Specifies the regular expression for the phone number capture custom form. |
| forms.getPhoneNumberUseMaxLength | boolean | true | Specifies whether to use max length instead of the regex for phone number capture custom form. |
| forms.getSSNMaxLength | number | 9 | Specifies the max length of the social security number capture custom form. |
| forms.getSSNRegex | string | \\d{3}-\\d{2}-\\d{4} | Specifies the regular expression for the social security number capture custom form. |
| forms.getSSNUseMaxLength | boolean | false | Specifies whether to use max length instead of the regex for social security number capture custom form. |
| forms.getEmailAddressMaxLength | number | 50 | Specifies the max length of the email address capture custom form. |
| forms.getDriverLicenseMaxLength | number | 20 | Specifies the max length of the driver license capture custom form. |
| forms.getNumericFieldMaxLength | number | 50 | Specifies the max length of the numeric field capture custom form. |
| forms.getNumericFieldRegex | string | Specifies the regular expression for the numeric field custom form. | |
| forms.getNumericFieldUseMaxLength | boolean | true | Specifies whether to use max length instead of a regex for the numeric field custom form. |
| forms.getAlphaNumericFieldMaxLength | number | 50 | Specifies the max length of the alpha numeric field capture custom form. |
| forms.getAlphaNumericFieldRegex | string | Specifies the regular expression for the alpha numeric field custom form. | |
| forms.getAlphanumericFieldUseMaxLength | boolean | true | Specifies whether to use max length instead of a regex for the alpha numeric field custom form |
| forms.displayQRCodeButtonLabel | string | Done | Specifies the label of the button on the QR code custom form. |
| forms.getPhoneUseType63 | boolean | false | Whether to use the transaction type 63 GetAlphaNumeric instead of the GetNumericField when capturing the Phone number from the terminal. |
| forms.customFormsUseSeparateTextLines | boolean | false |
Defines whether the core will move the separate TextLines in the DeviceRequest from PromptText to PromptText2, PromptText3, PromptText4 & PromptText5 Note, when obtaining Signature, these additional fields will be Title2, Title3, Title4 & Title5 |
| forms.getEmailAddressGuidanceText | string | Specifies the guidance text when capturing an email address. | |
| forms.getSSNGuidanceText | string | Specifies the guidance text when capturing a social security number. | |
| forms.getDateGuidanceText | string | Specifies the guidance text when capturing a date of birth. | |
| forms.getDriverLicenseGuidanceText | string | Specifies the guidance text when capturing a driver license number. | |
| forms.getNumericFieldGuidanceText | string | Specifies the guidance text when capturing generic numeric data. | |
| forms.getAlphaNumericFieldGuidanceText | string | Specifies the guidance text when capturing generic alpha-numeric data. | |
| forms.getPhoneNumberGuidanceText | string | Specifies the guidance text when capturing a phone number. | |
| forms.getCustomerVerificationAcceptLabel | string | Yes | Specifies the text label of the accept button for the Get Customer Verification custom form. |
| forms.getCustomerVerificationDeclineLabel | string | No | Specifies the text label of the decline button for the Get Customer Verification custom form. |
| personalCheckProcessingEnabled | boolean | true | Specifies whether Personal Check/Cheque processing is enabled. |
| lineDisplayEnabled | boolean | true | Specifies whether Line-Item Display processing is enabled. |
| maxLineItemTextLength | number | 64 | Specifies the maximum length of an Item Description in characters. This is used to truncate the length of the item description in case the description of a product is too long during line-item display on the pin entry device (PED) and on S/P request payload. |
| terminalMessagesEnabled | boolean | false | Allows the core to open a socket and listen and receive terminal messages being sent by the PSP specified by the in terminalMessagesEndpoint, which are then forwarded to the POS while a transaction request is being processed. The socket is closed once the response has been received to the transaction request. |
| terminalMessagesEndpoint | string | "wss://{TERMINAL_IP}:5017/ws/terminalmessage" | The endpoint used by EFTLink to open a socket for receiving messages from a psp. {format: wss://<IP>:<PORT>/ws/terminalmessage} |
| terminalMessagesConnectionTimeoutMillis | number | 3000 | connection timeout in milliseconds to TerminalMessagesEndpoint. |
| issuerIds | object | __________ | |
| issuerIds.31 | string | RESERVE-1 | Configurable eWallet Issuer ID value that can be overridden with a custom value. |
| issuerIds.32 | string | RESERVE-2 | Configurable eWallet Issuer ID value that can be overridden with a custom value. |
| issuerIds.33 | string | RESERVE-3 | Configurable eWallet Issuer ID value that can be overridden with a custom value. |
| issuerIds.34 | string | RESERVE-4 | Configurable eWallet Issuer ID value that can be overridden with a custom value. |
| issuerIds.35 | string | RESERVE-5 | Configurable eWallet Issuer ID value that can be overridden with a custom value. |
| issuerIds.36 | string | RESERVE-6 | Configurable eWallet Issuer ID value that can be overridden with a custom value. |
| issuerIds.37 | string | RESERVE-7 | Configurable eWallet Issuer ID value that can be overridden with a custom value. |
| issuerIds.38 | string | RESERVE-8 | Configurable eWallet Issuer ID value that can be overridden with a custom value. |
| issuerIds.39 | string | RESERVE-9 | Configurable eWallet Issuer ID value that can be overridden with a custom value. |
| issuerIds.60 | string | Generic eWallet | Configurable eWallet Issuer ID value that can be overridden with a custom value. |
| issuerIds.40 | string | RESERVE-10 | Configurable Issuer ID value that can be overridden with a custom value. |
| issuerIds.41 | string | RESERVE-11 | Configurable Issuer ID value that can be overridden with a custom value. |
| issuerIds.42 | string | RESERVE-12 | Configurable Issuer ID value that can be overridden with a custom value. |
| issuerIds.43 | string | RESERVE-13 | Configurable Issuer ID value that can be overridden with a custom value. |
| issuerIds.44 | string | RESERVE-14 | Configurable Issuer ID value that can be overridden with a custom value. |
| issuerIds.45 | string | RESERVE-15 | Configurable Issuer ID value that can be overridden with a custom value. |
| issuerIds.46 | string | RESERVE-16 | Configurable Issuer ID value that can be overridden with a custom value. |
| issuerIds.47 | string | RESERVE-17 | Configurable Issuer ID value that can be overridden with a custom value. |
| issuerIds.48 | string | RESERVE-18 | Configurable Issuer ID value that can be overridden with a custom value. |
| issuerIds.49 | string | RESERVE-19 | Configurable Issuer ID value that can be overridden with a custom value. |
| issuerIds.50 | string | RESERVE-20 | Configurable Issuer ID value that can be overridden with a custom value. |
| issuerIds.51 | string | RESERVE-21 | Configurable Issuer ID value that can be overridden with a custom value. |
| issuerIds.52 | string | RESERVE-22 | Configurable Issuer ID value that can be overridden with a custom value. |
| issuerIds.53 | string | RESERVE-23 | Configurable Issuer ID value that can be overridden with a custom value. |
| issuerIds.54 | string | RESERVE-24 | Configurable Issuer ID value that can be overridden with a custom value. |
| issuerIds.55 | string | RESERVE-25 | Configurable Issuer ID value that can be overridden with a custom value. |
| issuerIds.56 | string | RESERVE-26 | Configurable Issuer ID value that can be overridden with a custom value. |
| issuerIds.57 | string | RESERVE-27 | Configurable Issuer ID value that can be overridden with a custom value. |
| issuerIds.58 | string | RESERVE-28 | Configurable Issuer ID value that can be overridden with a custom value. |
| issuerIds.59 | string | RESERVE-29 | Configurable Issuer ID value that can be overridden with a custom value. |
| eWalletProcessingEnabled | boolean | true | Specifies whether to enable EWallet processing. EWalletIssuerIds setting becomes effective when this setting is true. |
| enforceCardNameSetByOpi | boolean | false | If true, the card name returned in the CardServiceResponse adheres to the mappings specified by the OPI spec and is not overridden by any mapping performed within the cardrange.xml. |
| quickChipEnabled | boolean | false |
Specifies whether to enable Quick Chip functionality to allow the customer to pre-authorize their card prior to sale tendering. Warning: This setting will not be in effect unless LineDisplayEnabled is true and a value greater than 0 is set in the QuickChipAverageTransactionValue.
|
| quickChipAverageTransactionValue | number | 20 | Specifies the average quickchip transaction value. This value determines the PED prompts in the transaction (for example NFC). |
| cardAcquisitionEnabled | boolean | false | Specifies whether to enable Card Acquisition message processing prior to Sale/Purchase message processing for 2-stage payment. |
| cardAcquisitionEventEnabled | boolean | false | If set to true, triggers the CA to send through a device event to the POS, so the POS can determine whether the transaction TaxFree is supported. |
| cardAcquisitionPromptTimeout | number | 1200 | Specifies the timeout in seconds, for the CardInserted DeviceRequest prompt displayed on the POS. |
| installmentsEnabled | boolean | false | Specifies whether to enable instalment payments functionality. |
| maxInstallmentsAllowed | number | 24 | Specifies the maximum number of installments allowed per transaction. If the entered value on the installments prompt exceeds the MaxInstallmentsAllowed value, the installments prompt will retry until the configured NoOfInstallmentsPromptRetries amount is reached. |
| debitCreditSelectionPromptTimeout | number | 600 | Specifies the timeout in seconds, for debit or credit selection prompt |
| noOfInstallmentsPromptTimeout | number | 600 | Specifies the timeout in seconds, for instalments prompt. |
| noOfInstallmentsPromptRetries | number | 3 | Specifies the number of installments prompt retries. |
| useLegacyTokenLogicEnabled | boolean | false |
Specifies whether to use legacy token logic processing. This ensures the RRN is set on the CardServiceResponse.CardValue.Token object so that linked refunds will use the CardServiceRequest.CardValue.Token for processing as the OriginalRRN. Warning: this setting disables/disallows the ability to pay by stored card token/vault card token. |
| refRefundUseCardTokenEnabled | boolean | false | Specifies whether to use the Card Token to perform refund requests instead of the OriginalRRN/AcquirerTransactionReference. |
| tokenizeAnonymousCardsEnabled | boolean | false | Specifies whether to always tokenize the card regardless of the existence of a CustomerId on the Payment CardServiceRequest. |
| legacyXstoreCopyCardTokenToOrigAltTransRef | boolean | false |
Enable when using Xstore pre V19.0.1 and Cardless Reference Refund required when moving from POS Jni Core to OPI Core. When process a Referenced Refund, it will copy CSRequest.Card.Token to OPI Refund Request OrigAltTransRef if CSRequest.TransactionReference is not set. |
| loyaltyBrandsEnabled | boolean | false | Specifies whether to enable Loyalty Brands |
| allowedLoyaltyBrands | array |
An array of allowed loyalty brands. For example: "allowedLoyaltyBrands": ["AppleVas", "Google Smarttap"] |
|
| cellPhoneRechargePromptForCardOrCashEnabled | boolean | false | Specifies whether the POS prompt for Card or Cash for a Cell Phone Recharge transaction request. |
| cellPhoneRechargePromptForCardOrCashTimeout | number | 600 | Specifies the timeout, in seconds, for the Card or Cash prompt during a Cell Phone Recharge transaction request. |
| invoicePaymentPromptForCardOrCashEnabled | boolean | false | Specifies whether to prompt for Card or Cash at the POS for an Invoice Payment transaction request. |
| invoicePaymentPromptForCardOrCashTimeout | number | 600 | Specifies the timeout, in seconds, for a prompt for Card or Cash for Invoice Payment request. |
| invoicePaymentPromptScanBarcodeRetries | number | 3 | Specifies the number of retries for the Scan Barcode prompt. |
| defaultOperatorId | string | EFTLink OPI Operator | Specifies a default operator id for POS systems that do not provide an operator id in the CardServiceRequest. |
| defaultBaseCurrency | string | GBP | Specifies the default base currency to be used as part of the TransCurrency element in the OPI Retail messages. |
| defaultCheckType | string | 01 | Specifies the default check type for check processing. |
| defaultCheckName | string | Personal Check | Specifies the default check name for check processing. |
| detectReceiptSignatureString | string | Specifies the text to find in the <Print Data>field to determine whether a signature check prompt is required for the currently inflight request. | |
| signatureCheckTimeout | number | 30 | Specifies the timeout in seconds, for the Signature Check prompt. |
| siteId | string | Site | Specifies the SiteId data which is required in every Oracle Payments Interface request. |
| posInfo | string | Test POS | Specifies the POSInfo data which is required for every Oracle Payments Interface request. |
| proxyInfo | string | OPI Version 26.1 | Override the ProxyInfo value reported on every Oracle Payments Interface request. |
| busyErrorText | string | Device error retry | Specifies the error text when the device is busy. |
| electronicJournal | boolean | false | Specifies whether to add journal attributes to print lines |
| alternativePrintDataOrder | boolean | false | If true, then the receipt ordering within the PrintData field is changed to expect the customer receipt copy first and the merchant receipt copy second. |
| combinedReceipt | boolean | false | Specifies whether to defer printing of the EFT customer receipt and instead include within the standard POS customer receipt |
| suppressMerchantCopyForDecline | boolean | false | Specifies whether to suppress the printing of the merchant receipt if the transaction response is for a decline. |
| doNotCombineCustomerReceiptForDecline | boolean | false | Specifies whether to combine the customer receipt with the POS receipt when transaction response is a decline. |
| combinedReceiptFilters | object | __________ | Defines up to 100 receipt-line suppression filters. Add properties named "0" through "100" (string keys). Each value is a match string evaluated against every printed receipt line; if a line matches, it is omitted from the customer receipt. Use the reserved value "<blank>" to suppress empty/blank receipt lines. |
| adminMenu | object | __________ | Admin menu options |
| adminMenu.0 | object | Top level Menu | |
| adminMenu.0.1 | object | Actionable Menu item | |
| adminMenu.0.1.key | string | TXT_RECONCILIATION | The translation key that exists in the translation file (Lang<EN>_OPIREtail.properties) where the label value is obtained. |
| adminMenu.0.1.value | string | Reconciliation | The default value of the label if no translation key is found. |
| adminMenu.0.2 | object | __________ | Actionable Menu item |
| adminMenu.0.2key | string | TXT_CANCEL | The translation key that exists in the translation file (Lang<EN>_OPIREtail.properties) where the label value is obtained. |
| adminMenu.0.2.value | string | Cancel | The default value of the label if no translation key is found. |
| merchantReference | string | Unique merchant reference - this is used to identify the POS/Store | |
| merchantReferenceFormat | string |
Merchant Reference Format controls Example: R-dddddddddd-SSSSS.WWWWWW.YYYYMMDD.hhmmss.TTTTTT Note: See “Reference Formats” section for detailed explanation. |
|
| merchantReferenceSpecialChar | string | Specify a character that is to be passed through 'as is' in addition to the ones already mentioned. | |
| capCancellation | boolean | true | Determines response for the getCapCancellation request. |
| capReversal | boolean | true | Determines response for the getCapReversal request. |
| displayMessageDuration | number | 30 | The duration in seconds on how long to display a display Message custom form request on the terminal. |
| printDataLogMasking | boolean | false | If enabled, the receipt data in PrintData tag response is masked in the logs. |
| saleTransactionRequestLineItemEnabled | boolean | true | If false, this will suppress the LineItem Field within the S/P Transaction request. |
| usePspPaymentBrandForCardCircuit | boolean | false | If true, and a value exists in the pspPaymentBrand field, then this value is mapped to the CardCiruit field in the cardServiceResponse. |
| payByLinkExpiresAtHours | number | 24 | Defines how many hours a generated URL should be considered valid. |
| sendLocalTimeWithOffset | boolean | false | If true, the OPIRetailCore will set the TransDateTime field upon all valid Transaction Requests, including the corresponding time zone offset. |
| entryModes | object | __________ | |
| entryModes.10 | object | __________ | |
| entryModes.10.eftLinkEntryMode | string | ICC | |
| entryModes.10.description | string | EMV Fallback (Signature Verification) | |
| entryModes.10.cardholderVerificationMethod | string | Signature | |
| entryModes.11 | object | __________ | |
| entryModes.11.eftLinkEntryMode | string | RFI | |
| entryModes.11.description | string | Proximity via Magnetic Stripe (Signature Verification) | |
| entryModes.11.cardholderVerificationMethod | string | Signature | |
| entryModes.12 | object | __________ | |
| entryModes.12.eftLinkEntryMode | string | RFI | |
| entryModes.12.description | string | Proximity via Magnetic Stripe (No CVM) | |
| entryModes.12.cardholderVerificationMethod | string | No CVM Required | |
| entryModes.13 | object | __________ | |
| entryModes.13.eftLinkEntryMode | string | RFI | |
| entryModes.13.description | string | Proximity via ICC (Signature Verification) | |
| entryModes.13.cardholderVerificationMethod | string | Signature | |
| entryModes.14 | object | __________ | |
| entryModes.14.eftLinkEntryMode | string | RFI | |
| entryModes.14.description | string | Proximity via ICC (PIN Verification) | |
| entryModes.14.cardholderVerificationMethod | string | PIN | |
| entryModes.15 | object | __________ | |
| entryModes.15.eftLinkEntryMode | string | RFI | |
| entryModes.15.description | string | Proximity via ICC (Customer Device Verified) | |
| entryModes.15.cardholderVerificationMethod | string | Customer Device | |
| entryModes.16 | object | __________ | |
| entryModes.16.eftLinkEntryMode | string | RFI | |
| entryModes.16.description | string | Proximity via ICC (No CVM) | |
| entryModes.16.cardholderVerificationMethod | string | No CVM Required | |
| entryModes.17 | object | __________ | |
| entryModes.17.eftLinkEntryMode | string | RFI | |
| entryModes.17.description | string | Proximity via ICC (No CVM) | |
| entryModes.17.cardholderVerificationMethod | string | No CVM Required | |
| entryModes.18 | object | __________ | |
| entryModes.18.eftLinkEntryMode | string | MSR | |
| entryModes.18.description | string | Swiping without PIN (Signature Verification) | |
| entryModes.18.cardholderVerificationMethod | string | PIN | |
| entryModes.19 | object | __________ | |
| entryModes.19.eftLinkEntryMode | string | RFI | |
| entryModes.19.description | string | Swiping - No CVM | |
| entryModes.19.cardholderVerificationMethod | string | No CVM Required | |
| entryModes.20 | object | __________ | |
| entryModes.20.eftLinkEntryMode | string | Manual | |
| entryModes.20.description | string | Manual enter card number (Signature Verification) | |
| entryModes.20.cardholderVerificationMethod | string | Signature | |
| entryModes.21 | object | __________ | |
| entryModes.21.eftLinkEntryMode | string | Manual | |
| entryModes.21.description | string | Manual enter card number - No CVM | |
| entryModes.21.cardholderVerificationMethod | string | No CVM Required | |
| entryModes.22 | object | __________ | |
| entryModes.22.eftLinkEntryMode | string | ICC | |
| entryModes.22.description | string | EMV (Signature Verification) | |
| entryModes.22.cardholderVerificationMethod | string | Signature | |
| entryModes.23 | object | __________ | |
| entryModes.23.eftLinkEntryMode | string | ICC | |
| entryModes.23.description | string | EMV (PIN Verification) | |
| entryModes.23.cardholderVerificationMethod | string | PIN | |
| entryModes.24 | object | __________ | |
| entryModes.24.eftLinkEntryMode | string | ICC | |
| entryModes.24.description | string | EMV (PIN & Signature Verification) | |
| entryModes.24.cardholderVerificationMethod | string | Signature | |
| entryModes.25 | object | __________ | |
| entryModes.25.eftLinkEntryMode | string | ICC | |
| entryModes.25.description | string | EMV - No CVM | |
| entryModes.25.cardholderVerificationMethod | string | No CVM Required | |
| entryModes.26 | object | __________ | |
| entryModes.26.eftLinkEntryMode | string | EWALLET | |
| entryModes.26.description | string | E-Wallet Payment | |
| entryModes.26.cardholderVerificationMethod | string | Customer Device | |
| entryModes.27 | object | __________ | |
| entryModes.27.eftLinkEntryMode | string | Stored | |
| entryModes.27.description | string | Saved Card Token - No CVM | |
| entryModes.27.cardholderVerificationMethod | string | No CVM Required | |
| entryModes.28 | object | __________ | |
| entryModes.28.eftLinkEntryMode | string | ECOMM | |
| entryModes.28.description | string | Ecommerce | |
| entryModes.28.cardholderVerificationMethod | string | Unknown | |
| entryModes.29 | object | __________ | |
| entryModes.29.eftLinkEntryMode | string | Manual | |
| entryModes.29.description | string | Manual enter card number (PIN Verification) | |
| entryModes.29.cardholderVerificationMethod | string | PIN | |
| opiTransactionProcessorMap | object | __________ | |
| customConfig | object | __________ | list of generic key values that can be used from a core customization, see OPI extensibility documentation examples. |