POST/v3/billing/api/order/orderAuthorization:Bearerb37c4c689295904ed21eee5d9a48d42eContent-Type:application/jsonUser-Agent:MyApp1.0Accept:application/json{"merchantId":"01771534-196a-1105-839a-82422289d6d9","merchantOrderId":"m-1608560079","amount":371.88,"successUrl":"https://merchant.ru/order/xxx?result=success","failUrl":"https://merchant.ru/order/xxx?result=fail","returnUrl":"https://merchant.ru/order/xxx?result=return","vatAmount":61.98,"basketItems":[{"sku":"5fe0adcfa7fb4","name":"Бронирование номера","measure":"шт.","measureCode":"796","grossWeight":0,"netWeight":0,"quantity":3,"amount":123.96,"amountWoVat":103.3,"totalAmount":371.88,"totalVatAmount":61.98,"vatCode":"RUS_VAT20","type":"service","paymentType":"full_prepayment"}],"metaData":{"@type":"LodgingReservation","reservationId":"abc456","reservationStatus":"https://schema.org/ReservationConfirmed","underName":{"@type":"Person","name":"John Smith"},"reservationFor":{"@type":"LodgingBusiness","name":"Hilton San Francisco Union Square","address":{"@type":"PostalAddress","streetAddress":"333 O'Farrell St","addressLocality":"San Francisco","addressRegion":"CA","postalCode":"94102","addressCountry":"US"},"telephone":"415-771-1400"},"checkinTime":"2017-04-11T16:00:00-08:00","checkoutTime":"2017-04-13T11:00:00-08:00"},"expirationDate":"2020-12-22T00:00:00+00:00","languageId":"ru","currencyId":"RUB","description":"Оплата номера в отеле","customer":{"type":"private","name":"Peter","phone":"79001112233","email":"peter@domain.com","vatNumber":"","registrationAddress":""}}
CreateOrderRequest
Свойство
Обязательное
Тип
Описание
Пример значения
description
да
string(1000)
Описание заказа
Оплата номера в отеле
merchantId
да
string(36)
Идентификатор магазина
01771534-1a57-f184-dee3-ebeb91dded76
merchantOrderId
да
string(256)
Идентификатор заказа в учётной системе магазина, должен быть уникальным
O-12345
merchantOrderIdVisible
нет
string(256)
Номер заказа, отображаемый на платежной странице. Если не заполнено, показывается значение из merchantOrderId
Повторяет свойства объекта CreateOrderRequest с дополнительными свойствами:
Свойство
Обязательное
Тип
Описание
Пример значения
id
да
string(36)
Идентификатор заказа в системе Инвойсбокс
01771534-1a57-f184-dee3-ebeb91dded75
paymentUrl
да
string(1000)
Ссылка для перехода на платёжный шлюз для оплаты заказа
createdAt
да
datetime
Дата создания заказа
2020-12-22T00:00:00+00:00
status
да
string(50) enum
Статус заказа
completed
paidAt
нет
datetime
Дата оплаты заказа (если оплачен)
2020-12-22T00:00:00+00:00
В зависимости от сценария использования API, ссылка для перехода на платёжный шлюз (paymentUrl) может быть получена для переадресации пользователя в браузере или же закодирована в QR-коде для дальнейшего его сканирования камерой или приложением Инвойсбокс.
Customer
Свойство
Обязательное
Тип
Описание
Пример значения
type
нет
string(10) enum
Тип заказчика
legal - юр. лицо, private - физ лицо
name
нет
string(500)
Имя
Peter
phone
нет
string(100)
Номер телефона
79001112233
email
нет
string(100)
Электронная почта
peter@domain.com
vatNumber
нет
string(20)
ИНН
7710044140
taxRegistrationReasonCode
нет
string(9)
КПП
770201001
registrationAddress
нет
string(1000)
Юр. адресс
190000, Санкт-Петербург, Невский пр. 147, офис 321