PATCH /cloudapi/v1/lanes/{{laneId}}/configuration endpoint to allow partial or full update of configuration for a specific lane. triPOS Cloud now supports modification of several more configurations.
The following optional features can be updated via this request:
Allow EMV Contactless PIN Bypass: If AllowEMVContactlessPINBypass=false,then the PIN Bypass will not be allowed for EMV Contactless transactions. Default setting for this parameter isfalse.This cannot be overridden on a per request basis.
Allow Manual Entry: If isManualEntryAllowed=true, allows manual entry of card account numbers on the PIN pad. Default setting for this parameter istrue.This can be overridden on a per request basis and is supported on all the endpoints as this is set on lane level.
Allow Partial Approvals: If allowPartialApprovals=true,enables partial authorization of transactions. Default setting for this parameter istrue.This can be overridden on a per request basis and is supported on Sale and Auth endpoints.
Amex Debit:
If isAmexDebitAllowed=true, this value determines if triPOS will allow Amex Debit in sale and auth requests for integrators. Default setting for this parameter isfalse. This cannot be overridden on a per request basis and is supported on Sale and Auth endpoint.
* This flag is supported for Ingenico Tetra devices only, for Ingenico RBA and Verifone this flag is not supported.
CashBack: If isCashbackAllowed=true,cashback is enabled for all debit transactions. Default setting for this parameter isfalse.This can be overridden on a per request basis and is supported on Sale endpoint only. For more information, click here
Check For Duplicate Transactions: If checkForDuplicateTransactions=true,enables duplicate checking for all transactions. Default setting for this parameter istrue. This can be overridden on a per request basis and is supported on all the endpoints as this is set on lane level.
Confirm Convenience Fee Amount: If confirmConvenienceFeeAmount=true,prompts the cardholder to confirm the convenienceFeeAmount on the PIN pad. Default setting for this parameter istrue.This cannot be overridden on a per request basis and is supported on Sale, Auth, Refund endpoint. For more information, click here.
Confirm Total Amount Screen Displayed: If isConfirmTotalAmountScreenDisplayed=true,the cardholder is prompted to confirm the transaction total amount. Default setting for this parameter istrue.This can be overridden on a per request basis and is supported only on Sale endpoint.
Confirm Credit Surcharge Screen Displayed: If isConfirmCreditSurchargeScreenDisplayed=true,the cardholder is prompted to confirm the credit surcharge amount. Default setting for this parameter isfalse.This cannot be overridden on a per request basis and is supported on Sale and Auth endpoint.
Contactless Event Delay Time*: contactlessEventDelayTimeis used to set the device contactless card detection time in seconds. Its value is default to1.0 and can be set to 0or higher with an upper bound of59.0.This is applicable for Ingenico Tetra devices only.
Country Code*: countrycode is used to set the country where triPOS is being used, it can be set toUsa(for United States) orCan(for Canada). By default, it is set toUsa.This cannot be overridden on a per request basis and is set on device level.
Credit AVS Entry Condition: creditAvsEntryCondition is set when AVS entry (billing postal code entry) should be prompted for credit
transactions.This cannot be overridden on a per request basis and is supported on all the endpoints.
If creditAvsEntryCondition = Keyed,
the prompt to enter zip code appears only for transactions with Keyed entry mode. Default setting for this parameter is Keyed.
If creditAvsEntryCondition = Always, the prompt to enter zip code appears for all transactions with Keyed, Swipe and Fswipe entry modes. EMV and EMV contactless not supported.
If creditAvsEntryCondition = Never, the prompt to enter zip code does not appear.
CSC Support: If isCscSupported = true,
cardholder will be prompted to enter card security code (CVV) for keyed transactions on the device. Default setting for this parameter isfalse.
This can be overridden on a per request basis and is supported on all the endpoints for transactions with Keyed as entry mode.
Currency Code*: currencyCode is used to set the currency code for all transactions.
Values can be'Usd'for United States dollar and'Cad'
for Canadian dollar. Default value for this parameter isUsd.
This can be overridden on a per request basis and is supported on all the endpoints. This parameter is set on device level.
Debit:
If allowDebit=true,debit is enabled for all the transactions. Default setting for this parameter isfalse.This can be overridden on a per request basis and is supported for Sale and Refund ( only when isDebitRefundSupported=true) endpoint.
If isDebitRefundSupported=true,debit refund support is enabled. Default setting for this parameter is false.This cannot be overridden on a per request basis and is supported on
Refund endpoint.
For more information, click here
Display Screen Configuration:
Convenience Fee Display: if confirmConvenienceFeeAmount is set to false, the isConvenienceFeeToBeDisplayed can be set to true, allowing the itemized convenience fee to be displayed on the screen. By default, isConvenienceFeeToBeDisplayed is set to false.
Surcharge Amount Display: if isConfirmCreditSurchargeScreenDisplayed is set to false, the isSurchargeAmountToBeDisplayedcan be set to true, and the itemized surcharge amount will display on the screen. The isSurchargeAmountToBeDisplayed default is set to false.
Total Amount Display: if isConfirmTotalAmountScreenDisplayed is set to false, the isTotalAmountToBeDisplayed can be set to true, and the calculated total amount will display on the screen.
The isTotalAmountToBeDisplayed default is set to false.
Display Totals Summary Timer: The default value for displayTotalsSummaryTimer is set to 2000ms (2000 seconds). This configuration can be set to a value between 1500ms (1.5 seconds) and 3000ms (3000 seconds).
The recommended value to display the itemization of amounts is 2000ms (2 seconds).
Display Custom AID: If isDisplayCustomAidScreen=true,display custom AID screen is enabled on the device. Default setting for this parameter is true.This cannot be overridden on a per request basis and is supported on Sale and Refund endpoints for multi-AID cards
EBT:
If isEbtFoodStampSupported=true,EBT food stamp card support is enabled for all the transactions. Default setting for this parameter isfalse.This cannot be overridden on a per request basis and is supported on Sale, Refund, Reversal, EBT Voucher, Balance Enquiry endpoints.
If set isEbtCashBenefitSupported=true,EBT cash benefit card support is enabled for all the transactions. Default setting for this parameter isfalse.This cannot be overridden on a per request basis and is supported on Sale, Reversal, Balance Enquiry endpoints.
If set isEbtRefundSupported=true,allows refund on EBT cards. Not all processors support this. Default setting for this parameter isfalse.This cannot be overridden on a per request basis and is supported on Refund endpoint.
For more information, click here
EMV Fallback Allowed: emvFallbackAllowed determines the system's behavior for allowing swipe fallback for a chip card. It can be set toAllowAfterChipErrorORNeverAllow.Default setting isAllowAfterChipError.This cannot be overridden on a per request basis and is supported on all the endpoints as this is set on lane level.
EMV Support: If isEmvSupported=true,allows EMV cards to be used. EMV cards are also sometimes called chip cards, smart cards, or IC cards are supported on device. Default setting for this parameter istrue.This cannot be overridden on a per request basis and is supported on all the endpoints as this is set on lane level.
Enable Contactless EMV* : If contactlessEmvEnabled=true,contactless EMV is enabled on the device. Default setting for this parameter is true.This cannot be overridden on a per request basis and is supported on all the endpoints as this is set on lane level. For more information, click here.
Enable Contactless MSD*: If contactlessMsdEnabled=true,contactless MSD is enabled on the device. Default setting for this parameter isfalse.This cannot be overridden on a per request basis and is supported on all the endpoints as this is set on lane level.
Gift Support: If isGiftSupported=true,allows Vantiv gift cards to be used on the device. Default setting for this parameter isfalse.This can be overridden on a per request basis and is supported on Sale, Gift Activate, Gift Refund, Gift Reload, Gift Unload, Gift Close, Balance endpoints.
Healthcare Support: If isHealthcareSupported=true,triPOS will allow healthcare data in sale and auth requests for integrators that may be required to implement an Inventory Information Approval System (IIAS) for retail point of sale systems. Default setting for this parameter istrue.This cannot be overridden on a per request basis and is supported on Sale and Auth endpoints.
Hosted Credit Surcharge: If isHostedSurchargeEnabled=true,surcharge amount will be determined by Express.Default setting for this parameter isfalse.
Language*: language sets the default language triPOS should use. Valid values areEnglishorFrench.Default setting for this parameter is English.This cannot be overridden on a per request basis and is set on device level.
Lane Locking: If laneLockingEnabled=true,prevents the interruption of any request that involves the payment terminal by a concurrently issued request. Default setting for this parameter istrue.This cannot be overridden on a per request basis. For more information, click here
Market Code: marketCode sets market code specific to the type of transaction being submitted. This global value can be set, but it can be overridden by a lane configuration value or a request value. Possible values are Default, AutoRental, DirectMarketing, ECommerce, FoodRestaurant, HotelLodging, Petroleum, Retail, QSR.This can be overridden on a per request basis and is supported on all the endpoints.
Original Amount Confirmation: If confirmOriginalAmount=true,the original transaction amount will be confirmed after card information is obtained. Default setting for this parameter istrue.This cannot be overridden on a per request basis and is supported only on Sale endpoint.
Post Response Cleanup: If isPostResponseCleanup=true,allows for the response from Sale and Authorization transactions to be returned immediately after Host processing while messages are still displaying on the screen and device cleanup is being performed. Default setting for this parameter isfalse.This cannot be overridden on a per request basis. For more information, click here
Preferred AID: is configured in the PIN pad to set AID preference. If preferredAid:0= No Preference,1= Prefer US Common Debit Aid,2= Prefer Global Debit AID. Default setting for this parameter is0.This cannot be overridden on a per request basis and is supported only on Sale endpoint for EMV and contactless transactions.
Process Maestro Debit AID With Offline PIN CVM As Debit †
Processor*: processor sets the processor name. Valid values are VantivorVantivCanada.Default value isVantiv.This cannot be overridden on a per request basis and is set on device level.
Prompt To Remove Card At Transaction Start: If promptToRemoveCardAtTransactionStart = true,
the device PINPad terminal will prompt for the removal of the card after the card is already inserted in the terminal.
If promptToRemoveCardAtTransactionStart = false,
and the card has already been inserted in the terminal the PIN Pad will not display Please Remove Card.
Default setting for this parameter istrue.
Provisional Amount †
Quick Chip Data Lifetime*: quickChipDataLifetime can be set to amount of time to wait until quick chip data is cleaned/wiped out. The value must be within the range of 30 to 600 seconds. Default value for this parameter is240.This cannot be overridden on a per request basis and is supported on all endpoints as this is set on lane level.
Quick Chip*: If quickChipEnabled=true, POS system to support quick chip transaction request. Default setting for this parameter is true. This cannot be overridden on a per request basis and is supported on all endpoints as this is set on lane level.
For more information, click here
Reboot Time: rebootTime will be used to default reboot time if the reboot time is not specified in the PIN pad section under lanes. Default value will be a random time between08:45 to 09:15. The value is UTC time in HH:MM or HHMM in 24-hour format. This cannot be overridden on a per request basis and is set on device level.
Signature Format*: signatureFormat is used to select either of the supported signature formats. This parameter can have valuesPointsLittleEndian, PointsBigEndian, Ascii3Byte.Default setting for this parameter is PointsLittleEndian. This cannot be overridden on a per request basis and is supported on all endpoints as this is set on lane level.
Threshold Amount*: thresholdAmount can be set to0.0or higher to always require a signature for credit sale. For example, set to the amount that must be reached before asking for a signature, such as 25.00.This can be overridden on a per request basis and is supported on Sale and Refund. For more information, click here.
Tip:
If isTipAllowed=true,tip entry is allowed on the device. Default setting for this parameter istrue.This can be overridden on a per request basis and is supported on only Sale endpoint.
If isTipPromptAllowed =true, prompts the user with ‘Leave a tip?’ confirmation prompt. This is valid only on standard transaction flow. Default setting for this parameter is false. This cannot be overridden on a per request basis and is supported on only Sale endpoint.
The tipOptions container allows for the addition of the tipSelections configuration. For more information click here.
The tipSelections endpoint allows for the configuration of predefined tip amounts using fixed dollar amounts, percentages, or custom amounts. Selection values must be a comma-separated list of decimal numbers, ‘none’ or ‘other’. For more information click here.
User Input Timeout: userInputTimeout is used to setup the custom time after which transaction will timeout in case of no user input. This can be set in the range of10000to60000milliseconds. This can be overridden on a per request basis and is supported on all the endpoints.
* Features may be device and/or device software version specific.
† This feature modification is not currently supported by this API. It is reserved for future use.
Ingenico Telium devices and Verifone Mx915 and Mx925 devices can allow for MSD contactless, however, it is recommended to support EMV contactless if possible.
EMV Contactless and Quick Chip features can be updated on Ingenico devices with RBA 23 and Verifone Mx915 and Mx925 devices with XPI 5400D.
The new values will not update in a response, unless specified in the request.
There are defaults and validation errors from this API as follows:
isGiftSupported to a non-boolean value, the error is IsGiftSupported must be a boolean.isCSCSupported to a non-boolean value, the error is IsCSCSupported must be a boolean.currencyCode is used to set the currency code for all transactions. Values can be 'Usd' for United States dollar, 'Cad' for Canadian dollar or None. If value is set to None through the patch lane configuration API then the currencyCode value should be set to Usd through the request body of Sale API.contactlessEmvEnabled = true, contactless EMV is enabled on the device.contactlessMsdEnabled = true, contactless MSD is enabled on the device.contactlessMsdEnabled = true, contactless MSD is enabled on the device. (Only set if EMV Contactless is not supported by your account and gateway.)contactlessMsdEnabled and contactlessEmvEnabled to true.quickChipEnabled = true, quick chip is enabled on the device.quickChipDataLifetime is set to any value, quick chip data lifetime is set to that value on the device.contactlessEmvEnabled to a non-boolean value, the error is ContactlessEmvEnabled must be a boolean.contactlessMsdEnabled to a non-boolean value, the error is ContactlessMsdEnabled must be a boolean.quickChipEnabled to a non-boolean value, the error is QuickChipEnabled field must be a boolean.quickChipDataLifetime is set to a value outside of 30-600, the error is QuickChipDataLifetime field must be an int between 30-600.contactlessEventDelayTime is used to set the device contactless card detection time in seconds. It's value is default to 1 and can be set to 0 or higher. This is applicable for Ingenico Tetra devices only.contactlessEmvEnabled = true, the error is Contactless EMV is not supported on this device.quickChipEnabled = true, the error is Quick Chip is not supported on this device.quickChipDataLifetime is set to any value, the error is Quick Chip is not supported on this device.contactlessEmvEnabled = true, the error is Contactless EMV is not supported on this device.quickChipEnabled = true, the error is Quick Chip is not supported on this device.quickChipDataLifetime is set to any value, the error is Quick Chip is not supported on this device.Here is an example request modifying new features:
{
"contactlessEmvEnabled": true,
"contactlessMsdEnabled": false,
"quickChipEnabled": true,
"quickChipDataLifetime": 240,
"language": "english",
"isCashbackAllowed": true,
"isConfirmTotalAmountScreenDisplayed": true,
"cashbackOptions": {
"selectionAmounts": "1,2,other",
"manualEntry": {
"amountIncrement": 10,
"maximumAmount": 100
}
}
}