Vignette ID Partner API

Documentation describes the possibilities of connecting to the platform Vignette ID for the possibility of paying for the motorway in 9 European countries.

More about supported countries

Get access to sandbox

BASE URL

https://sandbox-api.vignette.id

Products List Endpoints

Endpoints for interacting with products.

ENDPOINTS

GET	/public/products
GET	/public/products/status

Users List Endpoints

Endpoints for interacting with Users.

ENDPOINTS

GET	/public/users
GET	/public/users/:id/orders

Orders List Endpoints

Endpoints for interacting with orders.

ENDPOINTS

GET	/public/orders
POST	/public/orders
GET	/public/orders/:id
GET	/public/orders/:id/status
POST	/public/orders/:id/cancel
POST	/public/orders/:id/cancel-pending
POST	/public/orders/:id/cancel-deferred

Extended List Endpoints

Extended endpoints.

ENDPOINTS

POST	/public/validate-vehicle

Products (vignettes and tunnels)

All available products (vignettes, tunnels, trains, ferries) for customers in 8 European countries

Headers

Authorization

required, string

The Authorization header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE.

Query Parameters

country

optional, string

Returns filtered products by country. Supported countries at, ch, si, hu, sk , cz, ro, bg, md

type

optional, string

Returns filtered products by type. Supported types vignette, tunnel

currency

optional, string, default: EUR

Return price of products in selected currency with the included individual commission for the partner. Supported currencies EUR, UAH, USD, PLN, HUF and more

GET

/public/products

Products / Status

Returns the status of national providers, as well as all products.

Headers

Authorization

required, string

The Authorization header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE.

Query Parameters

status

optional, string

Returns filtered products by status. Supported types online, offline

country

optional, string

Returns filtered products by country. Supported countries at, ch, si, hu, sk , cz, ro, bg, md

type

optional, string

Returns filtered products by type. Supported types vignette, tunnel

GET

/public/products/status

Users

Returns an array of partner users who made at least 1 payment.

Headers

Authorization

required, string

The Authorization header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE.

Query Parameters

page

optional, number

GET

/public/users

User Orders

An array of all vignettes for a specific user.

Headers

Authorization

required, string

The Authorization header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE.

Query Parameters

page

optional, number

Path Parameters

required, string

ID of user

GET

/public/users/:id/orders

Get Orders

This endpoint allows you to obtain a list of all partner orders with all the necessary information about the order

Headers

Authorization

required, string

The Authorization header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE.

Query Parameters

status

optional, string

Returns filtered orders by status.

• Statuses

Each vignette can have one of the statuses: PENDING, WILL BE ACTIVE, ACTIVE, EXPIRED, REFUNDED, DELETED

More about status list.

bug_report

optional, boolean, default: false

Use with all endpoints to inform us for bugs in API

GET

/public/orders

Create order

New paid order on partner side initiate request for processing in Vignette ID system.

Headers

Authorization

required, string

The Authorization header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE.

Request Body

Payload required to validate a vehicle plate.

terms_and_privacy_accepted

required, boolean

Must be true to indicate that terms and privacy are accepted. Partner need to store this information in the user order.

order_has_been_paid

required, boolean

• true - this means that the partner accepted and processed the payment on his side.

• false - to pay for an order, the API generates a link and returns it to the response in payment_link, which the partner must display to the user. The payment is processed on our side.

optional, string

The partner user email. Must contain the user's real email. By default, any emails from our side are disabled.

user

optional, object

Object of User data.

cars

required, array

Array of Vehicles with vehicle plate and registration country.

products

required, array

Array of vignettes with custom id, name, period, and start date.

interchange_fee

optional, object

POST

/public/orders

EXAMPLE BODY

{
  "terms_and_privacy_accepted": true,
  "order_has_been_paid": true,
  "email": "[email protected]",
  "user": {
    "email": "[email protected]",
    "user_name": "John Smith",
    "passport_number": "FP123456"
  },
  "cars": [
    {
      "country": "ua",
      "plate": "AA4544AA",
      "vin_code": "VWT045FD9812VB341"
    }
  ],
  "products": [
    {
      "custom_id": "partnername-000001",
      "name": "vignette-si-2a",
      "start_date": 1690711200,
      "period": 30
    }
  ],
  "interchange_fee": {
    "amount": 0.33,
    "currency": "EUR"
  }
}

Get Order

• id - order id in Vignette ID system • custom_id - order id in Partner system • provider_id - unique vignette id in national (government) providers systems • cars -> provider_id - unique vignette identificator in national provider system • cars -> pdf - confirmation file from national provider system

Headers

Authorization

required, string

The Authorization header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE.

Query Parameters

bug_report

optional, boolean, default: false

Use with all endpoints to inform us for bugs in API

Path Parameters

required, string

id of order in Vignette ID system or custom_id from Partner system

GET

/public/orders/:id

Get Order Status

Returns only the order status. Applicable in cases where you need to check only the status without other information.

Headers

Authorization

required, string

The Authorization header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE.

Query Parameters

bug_report

optional, boolean, default: false

Use with all endpoints to inform us for bugs in API

Path Parameters

required, string

id of order in Vignette ID system or custom_id from Partner system

GET

/public/orders/:id/status

Cancel Pending Order (will be deprecated)

The ability to cancel an order that has a pending status if it is not processed within the specified time period

• PENDING - only

Headers

Authorization

required, string

The Authorization header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE.

Query Parameters

bug_report

optional, boolean, default: false

Use with all endpoints to inform us for bugs in API

Path Parameters

required, string

id of order in Vignette ID system or custom_id from Partner system

POST

/public/orders/:id/cancel

Cancel Pending Order

The ability to cancel an order that has a PENDING status if it is not processed within the specified time period

• PENDING - only

Headers

Authorization

required, string

The Authorization header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE.

Query Parameters

bug_report

optional, boolean, default: false

Use with all endpoints to inform us for bugs in API

Path Parameters

required, string

id of order in Vignette ID system or custom_id from Partner system

POST

/public/orders/:id/cancel-pending

Cancel Deferred Order

The ability to cancel an order that has a DEFERRED status if it is not processed within the specified time period

• DEFERRED - only

Headers

Authorization

required, string

The Authorization header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE.

Query Parameters

bug_report

optional, boolean, default: false

Use with all endpoints to inform us for bugs in API

Path Parameters

required, string

id of order in Vignette ID system or custom_id from Partner system

POST

/public/orders/:id/cancel-deferred

Validate vehicles

Possibility to check the vehicle number according to the selected country.

A list of acceptable vehicle registration countries codes in two letter format like at, cz, pl, ua...

Headers

Authorization

required, string

The Authorization header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE.

Query Parameters

bug_report

optional, boolean, default: false

Use with all endpoints to inform us for bugs in API

Request Body

Payload required to validate a vehicle plate.

cars

required, array

Array of vehicles with vehicle plate and registration country.

emails

optional, array

Option to check user email

POST

/public/validate-vehicle

EXAMPLE BODY

{
  "cars": [
    {
      "country": "ua",
      "plate": "AA4544AA",
      "vin_code": "VWT045FD9812VB341"
    }
  ],
  "email": "[email protected]"
}