• Regular - the customer club can send in members of the customer club, and once the end user signs up for Autopay, the customer club permit is applied to the customer. The integrators are also able to verify the status of the requests.
• External (Webhook) - Autopay requests a predefined URL with the ID (either a license plate or a loyalty membership ID) and gets a response about whether the ID is a valid membership.
• Anonymous - the integrator can send in license plate numbers for customer club members, and the customer club permit will be applied to the customer without requiring Autopay registration.

Regular customer clubs

Available resources

• POST - Join a customer club
• GET - Get the registration status
• DELETE - Resign from a customer club
• Error handling

Access requirements

• A valid authentication token is required to access the API. How to authenticate your application
• Access to the Customer Club API is offered as a paid service. Please contact your Autopay representative for details.

POST - Join a customer club

This method allows you to add a customer to a customer club. The membership is linked to the customer's Autopay.io profile. If no profile exists, Autopay asks the customer to create one. Customer club membership is activated once the customer has agreed to join. If an existing profile exists in Autopay.io, Autopay will discard all the information in the request, except the wish to join the customer club; this is done for security reasons.

Endpoint

POST https://api.autopay.io/customer_club/v2/join

Request parameters

• The request body must be in JSON format and HTTP headers must include Content-Type: application/json.
• The HTTP headers must include a valid access token with scope: customer_club.

Request example

{
    "email":"test123@test.com",
    "phone":{
        "dialing_code":"47",
        "number":"22849200"
    },
    "first_name":"Test",
    "last_name":"Client",
    "vehicles":[
        {
            "vehicle_reg":"123ABC",
            "plate_issuer":"EST"
        },
        {
            "vehicle_reg":"456CBE",
            "plate_issuer":"FIN",
            "plate_subdivision":"PS"
        }
    ],
    "language_code":"en"
}

Success response

HTTP Code: 200 OK

Example success response

{
    "success": true,
    "registration_id": "A1B2C3D4",
    "message": "Customer club join request processed"
}

GET - Get the registration status

This method allows you to get the registration status of the end-user based on the registration ID you received in the join request response.

Endpoint

GET https://api.autopay.io/customer_club/v2/status/{registrationId}

Request parameters

• The HTTP headers must include a valid access token with scope: customer_club.
• The request path must include the registration ID (e.g. A1B2C3D4).

Request example

GET https://api.autopay.io/customer_club/v2/status/A1B2C3D4

Success response

HTTP Code: 200 OK

Example success response

{
    "success": true,
    "status": "PENDING"
}

DELETE - Resign from a customer club

This method allows you to cancel the end-user's membership to a customer club.

Endpoint

DELETE https://api.autopay.io/customer_club/v2/leave/{registration_id}

Request parameters

• The HTTP headers must include a valid access token with scope: customer_club.
• The path must include registration id of the customer (e.g. A1B2C3D4).

Request example

DELETE https://api.autopay.io/customer_club/v2/leave/A1B2C3D4

Success response

Example success responses

Customer left the customer club

{
    "success": true,
    "message": "Customer club left"
}

Customer has not verified joining the customer club

{
    "success": true,
    "message": "Request to join AUTOPAY customer club is canceled"
}

Error handling

Error message paramaters

Example error response

{
    "error_id": "missing_property",
    "message": "Missing property: customer_club"
}

Error codes and messages

External (Webhook) customer clubs

Authentication

• Basic authentication
• API key
• Token
• Token provider.

Request

Request example

https://external-integration.something.com/44b5ef2d144653d3fb89c615777721582be3d5143fadd584fa35504c67ef2e9e

Response

Response examples

{
    "is_member": true,
    "member_level": "GOLD"
}

{
    "is_member": false
}

Anonymous customer clubs

Available resources

• POST - Add vehicle to customer club
• DELETE - Delete vehicle from a customer club
• GET - Get vehicle id
• How to hash a vehicle license plate number with HMAC-SHA256 algorithm
• Error handling

Access requirements

• A valid authentication token is required to access the API. How to authenticate your application
• Access to the Customer Club API is offered as a paid service. Please contact your Autopay representative for details.

POST - Add vehicle to customer club

This method allows you to add a vehicle to a customer club. Vehicle license plate number must be hashed with HMAC-SHA256 algorithm in hex format using secret key provided on anonymous customer club creation.

Endpoint

POST https://api.autopay.io/customer_club/v2/add_vehicle

Request parameters

• The request body must be in JSON format and HTTP headers must include Content-Type: application/json.
• The HTTP headers must include a valid access token with scope: customer_club.

Request example

{
    "hashed_license_plate_number":"8d15903f338c16111443163cda663bb031ebc5fe4ffea0e0da0f48f07f7eee7f"
}

Success response

HTTP Code: 200 OK

Example success response

{
    "success": true,
    "id": "b679209d-bc8d-43a7-853b-c8eb92ff2e16",
    "message": "Vehicle has been added to customer club"
}

DELETE - Delete vehicle from a customer club

This method allows you to remove vehicle from a customer club.

Endpoint

DELETE https://api.autopay.io/customer_club/v2/remove_vehicle/{vehicle_id}

Request parameters

• The HTTP headers must include a valid access token with scope: customer_club.
• The path must include registration id of the vehicle (e.g. b679209d-bc8d-43a7-853b-c8eb92ff2e16).

Request example

DELETE https://api.autopay.io/customer_club/v2/remove_vehicle/b679209d-bc8d-43a7-853b-c8eb92ff2e16

Success response

Example success response

{
    "success": true
}

GET - Get vehicle id

This method allows you to get the vehicle id based on hashed license plate number you provided in the add vehicle process.

Endpoint

GET https://api.autopay.io/customer_club/v2/get_vehicle_id/{hashed_license_plate_number}

Request parameters

• The HTTP headers must include a valid access token with scope: customer_club.
• The request path must include the vehicle hashed license plate number in hex format (e.g. 8d15903f338c16111443163cda663bb031ebc5fe4ffea0e0da0f48f07f7eee7f).

Request example

GET https://api.autopay.io/customer_club/v2/get_vehicle_id/8d15903f338c16111443163cda663bb031ebc5fe4ffea0e0da0f48f07f7eee7f

Success response

HTTP Code: 200 OK

Example success responses

One vehicle

{
    "ids": ["b679209d-bc8d-43a7-853b-c8eb92ff2e16"]
}

Multiple vehicles

{
    "ids": ["b679209d-bc8d-43a7-853b-c8eb92ff2e16", "a13bcad3-068c-490b-97a8-f091e460f154"]
}

How to hash a vehicle license plate number with HMAC-SHA256 algorithm

After creating an anonymous customer club, you get a popup with credentials on your screen, and there is a pepper value added in addition to clientId and clientSecret. Pepper is 32 characters long and consists only of alphanumeric characters. This pepper is the secret key used to produce a HMAC-SHA256 hashed vehicle license plate number. License plate is hashed without country code.

Example

1. The pepper provided on anonymous customer club creation is biflByamRgXSKbTyuLHp32oqniE7xjnW and you want to hash license plate TEST123.
2. Compute HMAC-SHA256 hash with TEST123 input and use the provided secret key.
3. Encode the hash result to a hex string. Result should be: 8d15903f338c16111443163cda663bb031ebc5fe4ffea0e0da0f48f07f7eee7f

To validate your result, you can use one of online HMAC signature verifiers, such as this one.

Error handling

Error message paramaters

Example error response

{
    "error_id": "customer_club_vehicle_not_found",
    "message": "Customer club vehicle not found."
}

Error codes and messages