Создание заказа (Create Order)
Отправьте новый заказ с выбором продукта, платёжными данными и информацией о клиенте.
POST /orders
Тело запроса
{
"products": [
{
"productId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
"productTypeId": 1,
"quantity": 1,
"vehiclePlate": "AB123CD",
"vehicleCountryIsocode": "AT",
"vehicleCategoryId": "f1e2d3c4-b5a6-7890-abcd-ef1234567890",
"startAt": "2026-04-01T00:00:00.000Z",
"endAt": "2026-04-10T23:59:59.000Z",
"driverFirstname": "John",
"driverLastname": "Doe"
}
],
"payment": {
"type": "CARD",
"paymentMethodId": "pm_1234567890abcdef",
"returnUrl": "https://yourapp.com/payment/callback"
},
"customer": {
"email": "john.doe@example.com",
"firstName": "John",
"lastName": "Doe",
"phone": "+43123456789"
},
"address": {
"countryIsocode": "AT",
"city": "Vienna",
"addressLine": "Mariahilfer Strasse 1",
"postalCode": "1060",
"taxNumber": "ATU12345678",
"companyName": "Doe GmbH"
},
"idempotencyKey": "unique-order-key-12345",
"externalReference": "YOUR-ORDER-REF-001",
"callbackUrl": "https://yourapp.com/webhooks/vignetim"
}
Products DTO
| Поле | Тип | Обязательное | Описание |
|---|
productId | UUID | Да | ID продукта из каталога |
productTypeId | integer | Да | Тип продукта: 1 = VIGNETTE, 2 = ESIM, 3 = INSURANCE, 4 = FINE_PAYMENT |
quantity | integer | Да | Количество единиц |
vehiclePlate | string | Условно | Номерной знак транспортного средства (обязателен для VIGNETTE) |
vehicleCountryIsocode | string | Условно | Страна регистрации транспортного средства (обязательна для VIGNETTE) |
vehicleCategoryId | UUID | Условно | Категория транспортного средства (обязательна для VIGNETTE) |
startAt | ISO 8601 | Условно | Дата начала действия (обязательна для VIGNETTE) |
endAt | ISO 8601 | Условно | Дата окончания действия (обязательна для VIGNETTE) |
driverFirstname | string | Нет | Имя водителя |
driverLastname | string | Нет | Фамилия водителя |
Payment DTO
| Поле | Тип | Обязательное | Описание |
|---|
type | string | Да | Один из: CARD, GOOGLE_PAY, APPLE_PAY, IDEAL, REVOLUT, BANCONTACT |
paymentMethodId | string | Условно | Токен платёжного метода Stripe (обязателен для CARD) |
returnUrl | string | Условно | HTTPS URL для callback перенаправления 3DS (обязателен для CARD) |
Маршрутизация платежей
- Платежи CARD маршрутизируются через NestPay и могут потребовать верификацию 3D Secure.
- GOOGLE_PAY, APPLE_PAY, IDEAL, REVOLUT и BANCONTACT маршрутизируются через Stripe.
Customer DTO
| Поле | Тип | Обязательное | Описание |
|---|
email | string | Да | Email-адрес клиента |
firstName | string | Да | Имя клиента |
lastName | string | Да | Фамилия клиента |
phone | string | Нет | Номер телефона клиента (рекомендуется формат E.164) |
Address DTO
| Поле | Тип | Обязательное | Описание |
|---|
countryIsocode | string | Да | ISO-код страны |
city | string | Да | Название города |
addressLine | string | Да | Адрес улицы |
postalCode | string | Нет | Почтовый индекс |
taxNumber | string | Нет | Идентификационный номер налогоплательщика |
companyName | string | Нет | Название компании (для корпоративных клиентов) |
Дополнительные поля
| Поле | Тип | Обязательное | Описание |
|---|
idempotencyKey | string | Нет | Уникальный ключ для предотвращения дублирования заказов. Тот же ключ с тем же содержимым возвращает исходный заказ (рекомендуется). |
externalReference | string | Нет | Ваша внутренняя ссылка на заказ для отслеживания |
callbackUrl | string | Нет | URL для получения обновлений статуса заказа |
Ответ
201 Created
{
"id": "ord-a1b2c3d4-e5f6-7890-abcd-ef1234567890",
"status": "PENDING",
"redirectUrl": "https://pay.vignetim.com/3ds/verify/abc123",
"clientSecret": "pi_1234567890_secret_abcdef",
"products": [
{
"productId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
"productTypeId": 1,
"quantity": 1,
"status": "PENDING"
}
],
"total": {
"amount": 11.5,
"currency": "EUR"
},
"externalReference": "YOUR-ORDER-REF-001",
"createdAt": "2026-03-20T14:30:00.000Z"
}
- redirectUrl -- Присутствует, когда требуется верификация 3D Secure (платежи CARD). Перенаправьте клиента по этому URL.
- clientSecret -- Присутствует для платежей, маршрутизируемых через Stripe. Используйте его с Stripe.js для подтверждения платежа на стороне клиента.
409 Conflict (идемпотентный)
Если тот же idempotencyKey отправлен с тем же содержимым, возвращается исходный заказ с кодом состояния 409. Повторная отправка безопасна.
{
"statusCode": 409,
"message": "Order already exists for this idempotency key",
"error": "Conflict"
}