The lane management API is the cloud equivalent of the triPOS distributed lane API calls. The lane management API will allow an integrator to pair a pinpad device to the Express API credentials. When a device is received that has not been paired to Express API credentials it will boot up and display an Activation Code. The POS should offer a pairing process to the POS operator where they enter the ActivationCode and then the POS will send the 'Add Device' command to the lane management API including the ActivationCode.
For the triPOS Cloud beta all of the devices were shipped with this pairing process already complete so to reset the device to an unpaired mode you will need to make a DELETE API request first.
The endpoint for the lane management API help/documentation is:
Use the same headers as specified above when accessing the lane management API.
Add device
Send a POST to /cloudapi/v1/lanes with the following body content:
{
"laneId": "string",
"description": "string",
"terminalId": "string",
"activationCode": "string"
}
Delete/Get/Get all device(s)
These are the most straightforward. For delete/get you'll provide an ID and each endpoint will perform the action on the lane(s) associated with their account.
Update
There is no update (PUT) endpoint at this time. In order to perform an "update" first delete then re-add.
The lane management API is the cloud equivalent of the triPOS distributed lane API calls. The lane management API will allow an integrator to pair a pinpad device to the Express API credentials. When a device is received that has not been paired to Express API credentials it will boot up and display an Activation Code. The POS should offer a pairing process to the POS operator where they enter the ActivationCode and then the POS will send the 'Add Device' command to the lane management API including the ActivationCode.
For the triPOS Cloud beta all of the devices were shipped with this pairing process already complete so to reset the device to an unpaired mode you will need to make a DELETE API request first.
The endpoint for the lane management API help/documentation is:
https://triposcert.vantiv.com/cloudapi/swagger/ui/index
And the HTTPS POST URL for managing lanes is:
triposcert.vantiv.com/cloudapi/v1/lanes
Use the same headers as specified above when accessing the lane management API.
Add device
Send a POST to /cloudapi/v1/lanes with the following body content:
{
"laneId": "string",
"description": "string",
"terminalId": "string",
"activationCode": "string"
}
Delete/Get/Get all device(s)
These are the most straightforward. For delete/get you'll provide an ID and each endpoint will perform the action on the lane(s) associated with their account.
Update
There is no update (PUT) endpoint at this time. In order to perform an "update" first delete then re-add.