LPR

The LPR integration allows you to connect your Licenseplate recognition system to Wallet.

GET/lpr/devices

Get all LPR devices

This endpoint allows you to get all LPR devices for a brand.

Required headers

Name
Authorization
Type
string
Description
The token itself as a bearer token.

Abilities

Name
lpr.get
Type
string
Description
The scope required to access this endpoint.

Query parameters

Name
brand_id
Type
string|Required
Description
The brand id to get the LPR devices for.

Request

GET

/lpr/devices

curl -X GET https://api.walletapp.co/lpr/devices  \ 
-H "Content-Type: application/json"
-H "Accept: application/json"
-H "Authorization: Bearer <your_token>"
-d '{
    "brand_id": "<brand_id>"
}'

Response

{
    "success": true,
    "data": [
        {
            "name": "<name>",
            "uuid": "<uuid>",
            "external_reference": "<external_reference>",
            "token": "<bearer_token>",
            "created_at": "<timestamp>",
            "updated_at": "<timestamp>",
            "address": "<address>"
        },
        ...
    ]
}

POST/lpr/devices

Create an LPR device

This endpoint allows you to create an LPR device for a location.

Required headers

Name
Authorization
Type
string
Description
The token itself as a bearer token.

Abilities

Name
lpr.store
Type
string
Description
The scope required to access this endpoint.

Query parameters

Name
location_id
Type
string|Required
Description
The location id to get the LPR devices for.
Name
name
Type
string|Required
Description
The name of the LPR device.
Name
external_reference
Type
string|Required
Description
A reference provided by the third party.

Request

POST

/lpr/devices

curl -X POST https://api.walletapp.co/lpr/devices  \ 
-H "Content-Type: application/json"
-H "Accept: application/json"
-H "Authorization: Bearer <your_token>"
-d '{
    "location_id": "<location_id>",
    "name": "<name>",
    "external_reference": "<external_reference>"
}'

Response

{
    "success": true,
    "data": {
        "name": "<device_name>",
        "location_id": "<location_id>",
        "brand_id": "<brand_id>",
        "organization_id": "<organization_id>",
        "external_reference": "<external_reference>",
        "uuid": "<uuid>",
        "updated_at": "<timestamp>",
        "created_at": "<timestamp>",
        "token": "<bearer_token>"
    }
}

GET/lpr/devices/:identifier

Inspect a device

This endpoint allows you to fetch a specific LPR device.

Required headers

Name
Authorization
Type
string
Description
The token itself as a bearer token.

Abilities

Name
lpr.get
Type
string
Description
The scope required to access this endpoint.

Route parameters

Name
identifier
Type
string|Required
Description
The identifier of the device.

Request

GET

/lpr/devices/:identifier

curl -X GET https://api.walletapp.co/lpr/devices/:identifier  \ 
-H "Content-Type: application/json"
-H "Accept: application/json"
-H "Authorization: Bearer <your_token>"

Response

{
    "success": true,
    "data": {
        "external_reference": "<external_reference>",
        "uuid": "<uuid>",
        "location_id": "<location_id>",
        "brand_id": "<brand_id>",
        "organization_id": "<organization_id>",
        "created_at": "<timestamp>",
        "updated_at": "<timestamp>",
        "limiter": 50,
        "name": "<device_name>",
        "token": "<authentication_token>",
        "deleted_at": "<timestamp|null>"
    }
}

DELETE/lpr/devices/:identifier

Remove a device

This endpoint allows you to remove a specific LPR device.

Required headers

Name
Authorization
Type
string
Description
The token itself as a bearer token.

Abilities

Name
lpr.delete
Type
string
Description
The scope required to access this endpoint.

Route parameters

Name
identifier
Type
string|Required
Description
The identifier of the device.

Request

DELETE

/lpr/devices/:identifier

curl -X DELETE https://api.walletapp.co/lpr/devices/:identifier  \ 
-H "Content-Type: application/json"
-H "Accept: application/json"
-H "Authorization: Bearer <your_token>"

Response

{
    "success": true,
    "message": "Device deleted"
}

PATCH/lpr/devices/:identifier

Restore a device

This endpoint allows you to restore a specific LPR device.

Required headers

Name
Authorization
Type
string
Description
The token itself as a bearer token.

Abilities

Name
lpr.delete
Type
string
Description
The scope required to access this endpoint.

Route parameters

Name
identifier
Type
string|Required
Description
The identifier of the device.

Request

PATCH

/lpr/devices/:identifier

curl -X PATCH https://api.walletapp.co/lpr/devices/:identifier  \ 
-H "Content-Type: application/json"
-H "Accept: application/json"
-H "Authorization: Bearer <your_token>"

Response

{
    "success": true,
    "message": "Device restored"
}