laneLockingEnabled. The preferred value is true for all customers and use cases. Disabling the feature should only be utilized where it directly inhibits critical business function..
To determine if Lane Locking is enabled for a lane, send a GET request to the lane’s configuration endpoint, e.g., GET /cloudapi/v1/lanes/{{laneId}}/configuration. The response will contain a field as follows:
"laneLockingEnabled": true
By default, lane locking is enabled for a lane. To disable it, send a PATCH request to the same endpoint with the value of the field set to false:
"laneLockingEnabled": false
Once lane locking is enabled for a lane, if a second request is sent before the first one completes, HTTP status code 500 (Internal Server Error) will be returned with the following response body for triPOS API requests:
{
"exceptionType": "TriPos.Shared.Exceptions.LaneException",
"exceptionMessage": "The device assigned to lane 1022 is currently in use."
}
For requests sent to the triPOS Cloud API, a 500 error with the following response body will be returned:
{
"exceptionMessage": "The requested device is currently busy."
}
If the lane is locked when changing the idle image, the response to a GET request to the /cloudapi/v1/lanes/{{laneId}}/profiles/image/transferstatus endpoint will be a 200 (OK) with the following body:
{
"resourceLocation": null,
"status": "DeviceLockFailed",
"exceptionMessage": null
}
The Lane Locking feature is applicable only for endpoints that access the PIN pad. Listed below are the relevant triPOS Transaction API endpoints:
| Endpoint | Request Method |
|---|---|
| /api/v1/authorization | POST |
| /api/v1/authorization/{transactionId}}/completion | POST |
| /api/v1/balance | POST |
| /api/v1/barcode | GET |
| /api/v1/binQuery | GET |
| /api/v1/card | GET |
| /api/v1/card/financial | GET |
| /api/v1/card/nonfinancial | GET |
| /api/v1/display | POST |
| /api/v1/ebtVoucher | POST |
| /api/v1/force/credit | POST |
| /api/v1/gift | GET |
| /api/v1/gift/activate | POST |
| /api/v1/gift/reload | POST |
| /api/v1/idle | POST |
| /api/v1/input | GET |
| /api/v1/paymentAccount | POST |
| /api/v1/paymentAccount/{paymentAccountId} | PUT |
| /api/v1/reboot | POST |
| /api/v1/receipt | POST |
| /api/v1/refund | POST |
| /api/v1/refund/token | POST |
| /api/v1/refund/{paymentAccountId} | POST |
| /api/v1/return/{transactionId}/{paymentType} | POST |
| /api/v1/sale | POST |
| /api/v1/selection | GET |
| /api/v1/signature | GET |
| /api/v1/token/omni | POST |
| /api/v1/token/paymetric | POST |
The Lane Locking feature applies to the following triPOS Cloud Lane API endpoints:
| Endpoint | Request Method |
|---|---|
| /cloudapi/v1/lanes/{laneId}/command | POST |
| /cloudapi/v1/lanes/{laneId} | DELETE |
| /cloudapi/v1/lanes/{laneId}/ | PATCH |
| /cloudapi/v1/lanes/{laneId}/ | GET |
For lanes that are assigned to the same PIN pad, the laneLockingEnabled configuration value needs to be the same to ensure predictable behavior.