POST /cloudapi/v1/lanes endpoint to add a new lane to your account. Once the device is connected, an activation code should be displayed on the PIN pad you are trying to associate.
The intention is that the end user initiates the pairing by taking the activation code and entering it into the point of sale application, which calls this endpoint to create a lane.
The following optional features can be enabled in this request:
* Features may be device and device software version specific.
Ingenico devices with RBA older than 23.0.44 will continue working as before with MSD contactless enabled and require no additional parameters.
New features will be available on Ingenico devices with RBA 23.0.44 or newer, including Quick Chip and Contactless options.
Note that in addition to the device support, the merchant account payment gateway support may be required for some features.
New features require that the lane is recreated with the new features enabled. (Update lane options feature coming soon)
Ingenico devices with RBA older that 23.0.44 will work as before for backwards compatibility enabling MSD contactless, but not EMV contactless and the QuickChip feature is unavailable.
The new values will not return in a response, unless specified in the request, and not the default value, for backward compatibility.
There are defaults and validation errors from this API as follows:
contactlessMsdEnabled = false and is optional.contactlessEmvEnabled = true and is optional.quickChipEnabled = true and is optional.quickChipDataLifetime = 240 and is optional.contactlessEmvEnabled to a non-boolean value, the error will be contactlessEmvEnabled must be Boolean..contactlessMsdEnabled to a non-boolean value, the error will be contactlessMsdEnabled must be Boolean..quickChipEnabled to a non-boolean value, the error will be quickChipEnabled must be Boolean..quickChipDataLifetime is set to a value outside of 30 - 600, the error will be Valid QuickChipDataLifetime value in seconds between 30-600..contactlessMsdEnabled = true, the error will be Contactless MSD is not supported on this device..contactlessMsdEnabled = false and is optional.contactlessEmvEnabled = true and is optional.quickChipEnabled = true and is optional.quickChipDataLifetime = 240 and is optional.contactlessEmvEnabled to a non-boolean value, the error will be contactlessEmvEnabled must be Boolean..contactlessMsdEnabled to a non-boolean value, the error will be contactlessMsdEnabled must be Boolean..quickChipEnabled to a non-boolean value, the error will be quickChipEnabled must be Boolean..quickChipDataLifetime is set to a value outside of 30 - 600, the error will be Valid QuickChipDataLifetime value in seconds between 30-600..contactlessMsdEnabled = true, the error will be Contactless MSD is not supported on this device..contactlessMsdEnabled = true and is optional.contactlessEmvEnabled = false and is optional.quickChipEnabled = false and is optional.contactlessEmvEnabled = true, the error will be Contactless EMV is not supported on this device..quickChipEnabled = true, the error will be Quick Chip is not supported on this device..quickChipDataLifetime is set to any value, the error will be Quick Chip is not supported on this device..
The Quick Chip feature requires changes to the transaction flow as well as new fields.
See the following for more information:
The Processor field is needed for Canadian integrations. It sets the CurrencyCode and CountryCode for the transactions. For more information please visit here.
Here is an example request enabling new features:
{
"laneId": "0000",
"description": "Test Device",
"activationCode": "X000000",
"terminalId": "0000",
"contactlessEmvEnabled": true,
"contactlessMsdEnabled": false,
"quickChipEnabled": true,
"quickChipDataLifetime": 240,
"processor": "Vantiv"
}