Создание счёта Qplus¶
Запрос возвращает платежную ссылку и QR-код для оплаты через Qplus.
Сценарий, в котором используется метод создания счёта Qplus, см. в статье «Оплата с помощью Qplus»
Запрос¶
POST /payin/v1/sites/{siteId}/qplus/invoices
Параметры строки запроса¶
| Параметр | Обязательный | Тип | Описание |
|---|---|---|---|
| siteId | Да | string | Строковый идентификатор сайта ТСП в QIWI Кассе |
Заголовки¶
| Заголовок | Обязательный | Тип | Описание |
|---|---|---|---|
| Authorization | Да | string | Авторизационные данные. Bearer [access-token] |
| Content-type | Да | string | Тип запроса. application/json |
| Accept | Нет | string | Тип ответа. application/json |
Параметры тела запроса¶
| Параметр | Обязательный | Тип | Описание |
|---|---|---|---|
| invoiceUid | Да | string | Уникальный идентификатор счёта в информационной системе ТСП. Уникальность означает, что идентификатор должен отличаться от идентификаторов всех таких ранее созданных счетов в рамках одного siteId |
| amount | Да | object | Данные о сумме операции |
| merchantRedirectUrl | Да | string(1000) | URL для переадресации клиента после оплаты |
| qplusPhoneNumber | Да | string | Номер телефона, на который зарегистрирован Qplus клиента. 11 цифр, начинается с 79. Пример: 79851234567 |
| ttl | Нет | number | Параметр определяет время, в течение которого пользователь может воспользоваться платежной ссылкой. Время указывается в секундах. Минимальное время - 180 сек. Максимальное время - 86400 сек. По умолчанию - 1800 сек |
| comment | Нет | string(1000) | Комментарий к счёту |
| qrCodeImageParams | Нет | object | Характеристики изображения QR-кода |
Характеристики изображения QR-кода¶
Параметры изображения QR-кода передаются в объекте qrCodeImageParams тела запроса.
| Параметр | Обязательный | Тип | Описание |
|---|---|---|---|
| size | Нет | number | Размер изображения в пикселях. Целое число в диапазоне 200–1000. По умолчанию - 300 |
| format | Нет | string | Формат изображения. Допустимые значения: PNG, JPEG. По умолчанию - PNG |
Пример запроса¶
Создание счёта Qplus
POST /partner/payin/v1/sites/test-01/qplus/invoices HTTP/1.1
Accept: application/json
Authorization: Bearer 5c4b25xx93aa435d9cb8cd17480356f9
Content-type: application/json
Host: b2b-api.qiwi.com
{
"invoiceUid" : "aae8557a-a1bd-4634-8224-b63bc6d913f3",
"amount" : {
"value" : "6.00",
"currency" : "RUB"
},
"merchantRedirectUrl": "https://example.com/redirectUrl",
"qplusPhoneNumber": "79851234567",
"ttl": 180,
"comment": "Оплата заказа",
"qrCodeImageParams": {
"size": 300,
"format": "PNG"
}
}
Ответ¶
См. также список общих HTTP кодов ошибок
Поля успешного ответа¶
| Параметр | Обязательный | Тип | Описание |
|---|---|---|---|
| invoiceUid | Да | string | Идентификатор запроса. Такой же как в теле запроса |
| invoiceStatus | Да | string | Статус счёта Qplus |
| amount | Да | object | Данные о сумме операции |
| paymentUrl | Да | string | URL платежной ссылки счёта Qplus |
| qrCode | Да | string | QR-код в формате base64 для платёжной формы Qplus |
| createdOn | Да | string | Дата и время создания счёта Qplus |
Поля ответа с ошибкой¶
| Параметр | Обязательный | Тип | Описание |
|---|---|---|---|
| serviceName | Да | string | Имя сервиса, сгенерировавшего ошибку |
| errorCode | Да | string | Код ошибки |
| description | Да | string | Описание ошибки для ТСП |
| userMessage | Да | string | Описание ошибки для отображения покупателю |
| dateTime | Да | string | Дата и время ошибки |
| traceId | Да | string | Уникальный ID лога ошибки |