• 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.

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
}