Payment API

Available resources

• POST - Connect parking
• POST - Manual stop
• POST - Manual start
• Callback POST - Successful end of parking
• Callback POST - Cancel parking
• Error handling

Access requirements

• A valid authentication token is required to access the API. How to authenticate your application
• Please note that Autopay provides separate API credentials to manage payments for different operators.

Note: Integrators must provide Autopay with two callbak URLs. We support URLs protected with basic authentication. More info about the callback below.

POST - Connect parking

This method allows you to register an external payment and connect it to the parking.

Endpoint

POST https://api.autopay.io/payment/v1/connect_parking

Request parameters

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

Example request

{
    "parking_area_code": "area1",
    "reference": "ref1",
    "vehicle_reg": "123ABC",
    "plate_issuer": "NOR",
    "plate_subdivision": null
}

Success response

HTTP Code: 200 OK

Example request

POST https://api.autopay.io/payment/v1/connect_parking

Example success responce

{
    "parking_id": "1234567890",
    "reference": "ref1",
    "start_time": "2019-02-26T11:52:16+0000"
}

POST - Manual stop

This method allows you to request manual stop for parking in Autopay.

Endpoint

POST https://api.autopay.io/payment/v1/manual_stop

Request parameters

• The request body must be in JSON format and HTTP headers must include Content-Type: application/json.
• The headers must include a valid access token.
• The headers must include a valid access token.
• Please see the table below for post parameters.

Example request

{
    "parking_id": "1234567890",
    "reference": "ref1",
    "end_time": "2019-02-28T11:52:16+0000"
}

Success response

HTTP Code: 200 OK

POST - Manual start

This method allows you to manually start a parking session in Autopay.

Endpoint

POST https://api.autopay.io/payment/v1/manual_start

Request parameters:

• The request body must be in JSON format and HTTP headers must include Content-Type: application/json.
• The headers must include a valid access token.
• Special permission is needed to use the manual start endpoint; credentials must include the scope “PAYMENT_PROVIDER_MANUAL_START“.
• Please see the table below for post parameters.

Example request:

{
    "parking_area_code": "area1",
    "zone_code": "1111",
    "reference": "ref1",
    "vehicle_reg": "123ABC",
    "plate_issuer": "NOR",
    "plate_subdivision": null,
    "start_time": "2021-07-28T11:52:16+0000"
}

Success response

HTTP Code: 204 OK

Callback POST - Successful end of parking

When parking ends, Autopay will send a POST request to the provided success callback URL with parking details. Parking is successful if Autopay finishes the parking, or the payment provider makes a manual stop.

Parking is successfully ended

Example request body

{
    "parking_id": "1234567890",
    "reference": "ref1",
    "end_time": "2019-02-28T11:52:16+0000",
    "cost": {
        "currency": "NOK",
        "vat_percent": 20.0,
        "net_amount": 100.0,
        "vat_amount": 20.0,
        "gross_amount": 120.0
    }
}

Callback POST - Cancel parking

Autopay sends cancellation message to provided cancel callback URL if the parking goes into an error state in Autopay.

Parking is canceled

Example request body

{
    "parking_id": "1234567890",
    "reference": "ref1"
}

Error messages

Example error response

{
    "error_id": "authentication_error",
    "message": "No access token present in header!"
}

Possible error id-s