Payment API

Available resources

• POST - Connect parking
• POST - Manual stop
• 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
• Access to the Payment API is offered as a paid service. Please contact your Autopay representative for details
• Please note that Autopay provides separate API credentials to manage payments for different operators.

• basic authentication,
• token authentication (uses the Authorization header),
• API key (uses the X-API-Key header).

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 the payment provider to request a manual stop for parking in Autopay if, for example, an exit event is missed in the Autopay system. After a manual stop is requested, a Successful end of parking message with the details of the parking will be sent to the corresponding callback URL. However, a follow-up session will be created in the Autopay system. If a corresponding exit event happens, the follow-up session is finished and charged to the customer using the regular means 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

Callback POST - Successful end of parking

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

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

If the parking goes into an error state in Autopay and shouldn't be charged to the customer, Autopay sends a cancellation message to the provided cancel callback URL.

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