Создание счёта¶

Запрос создаёт платёжный счёт.

Сценарии, в которых используется запрос создания счёта, см. в статьях «Проверка карты», «Оплата с формы QIWI с помощью API» и «Платёжный токен»

Запрос¶

PUT /payin/v1/sites/{siteId}/bills/{billId}

Параметры строки запроса¶

Параметр	Обязательный	Тип	Описание
siteId	Да	string	Строковый идентификатор сайта ТСП в QIWI Кассе
billId	Да	string	Уникальный идентификатор счёта в информационной системе ТСП. Уникальность означает, что идентификатор должен отличаться от идентификаторов всех ранее созданных счетов ТСП в рамках одного `siteId`.

Заголовки¶

Заголовок	Обязательный	Тип	Описание
Authorization	Да	string	Авторизационные данные. `Bearer [access-token]`
Content-type	Да	string	Тип запроса. `application/json`
Accept	Нет	string	Тип ответа. `application/json`

Параметры тела запроса¶

Параметр	Обязательный	Тип	Описание
amount	Да	object	Данные о сумме операции
expirationDateTime	Да	string	Дата, до которой счёт будет доступен для оплаты. Если счёт не будет оплачен до этой даты, последующая оплата станет невозможна.
comment	Нет	string(256)	Описание услуги, которую получает плательщик.
billPaymentMethodsType	Нет	array of strings	Способы оплаты, отображаемые на платёжной форме для покупателя. `CARD` — банковская карта. `SBP` — Система Быстрых Платежей.
flags	Нет	array of strings	Дополнительные команды для API. `SALE` — использовать одношаговый сценарий авторизации. `CHECK_CARD` — использовать проверку карты. `BIND_PAYMENT_TOKEN` — флаг для выпуска платёжного токена.
customer	Нет	object	Данные о покупателе
receiverData	Нет	object	Информация о получателе платежа
customFields	Нет	object	Поля для произвольной информации, дополняющей данные по операции. Например, описание услуг ТСП

Пример запроса на оплату¶

Создание счёта на оплату

PUT /partner/payin/v1/sites/site-01/bills/893794793973 HTTP/1.1
Accept: application/json
Authorization: Bearer 5c4b25xx93aa435d9cb8cd17480356f9
Content-type: application/json
Host: b2b-api.qiwi.com

{
   "amount": {
     "currency": "RUB",
     "value": 100.00
   },
   "billPaymentMethodsType": [
      "SBP"
   ],
   "comment": "Text comment",
   "expirationDateTime": "2022-04-13T14:30:00+03:00",
   "customer": {},
   "customFields": {
     "cf1": "Some data"
   }
}

Пример запроса на проверку карты¶

Создание счёта на проверку карты

PUT /partner/payin/v1/sites/site-01/bills/893794793973 HTTP/1.1
Accept: application/json
Authorization: Bearer 5c4b25xx93aa435d9cb8cd17480356f9
Content-type: application/json
Host: b2b-api.qiwi.com

{
   "expirationDateTime": "2022-04-13T14:30:00+03:00",
   "customer": {
     "account": "account1"
   },
  "flags": [
    "CHECK_CARD", "BIND_PAYMENT_TOKEN"
  ]
}

Ответ¶

См. также список общих HTTP кодов ошибок

Поля успешного ответа¶

Параметр	Обязательный	Тип	Описание
billId	Да	string	Идентификатор счёта. Такой же как в запросе
invoiceUid	Да	string(60)	Идентификатор счёта на стороне QIWI
amount	Да	object	Сумма операции
status	Да	object	Статус счёта. Возможно только значение `CREATED`
comment	Да	string	Описание услуги, которую получает плательщик
creationDateTime	Да	string	Дата создания счёта
expirationDateTime	Да	string	Срок оплаты счёта
payUrl	Да	string	Ссылка на созданную платёжную форму
customer	Нет	object	Данные покупателя: `account`, `email`, `phone`
customFields	Нет	object	Поля с произвольной информацией, дополняющей данные по операции (повтор данных из запроса): `contractdId`, `invoice_callback_url`, `themeCode` и др.

Поля ответа с ошибкой¶

Параметр	Обязательный	Тип	Описание
serviceName	Да	string	Имя сервиса, сгенерировавшего ошибку
errorCode	Да	string	Код ошибки
description	Да	string	Описание ошибки для ТСП
userMessage	Да	string	Описание ошибки для отображения покупателю
dateTime	Да	string	Дата и время ошибки
traceId	Да	string	Уникальный ID лога ошибки

Примеры ответов¶

Успешный ответ на оплатуУспешный ответ проверки картыОтвет, если счёт уже существует и у него истёк срок оплатыОтвет с ошибкой 4xx

{
    "billId": "893794793973",
    "invoiceUid": "d875277b-6f0f-445d-8a83-f62c7c07be77",
    "amount": {
        "value": "100.00",
        "currency": "RUB"
    },
    "status": {
        "value": "CREATED",
        "changedDateTime": "2022-04-05T11:27:41"
    },
    "comment": "Text comment",
    "customFields": {
        "cf1": "Some data"
    },
    "creationDateTime": "2022-03-05T11:27:41",
    "expirationDateTime": "2022-04-13T14:30:00",
    "payUrl": "https://payment.qiwi.com/form/?invoice_uid=d875277b-6f0f-445d-8a83-f62c7c07be77"
}

{
    "billId": "893794793973",
    "invoiceUid": "d875277b-6f0f-445d-8a83-f62c7c07be77",
    "amount": {
        "value": "0.00",
        "currency": "RUB"
    },
    "status": {
        "value": "CREATED",
        "changedDateTime": "2022-04-05T11:27:41"
    },
    "customer": {
        "account": "account1"
    },
    "flags": [
        "BIND_PAYMENT_TOKEN",
        "CHECK_CARD"
    ],
    "creationDateTime": "2022-03-05T11:27:41",
    "expirationDateTime": "2022-04-13T14:30:00",
    "payUrl": "https://payment.qiwi.com/validation/card?invoice_uid=d875277b-6f0f-445d-8a83-f62c7c07be77"
}

{
"billId": "12345",
"invoiceUid": "3b39ad6d-f111-401d-8108-ed11af920a65",
"amount": {
    "currency": "RUB",
    "value": "1.00"
},
"expirationDateTime": "2023-03-21T13:02:00+03:00",
"status": {
    "value": "EXPIRED",
    "changedDateTime": "2023-03-21T13:02:00+03:00"
},
"comment": "Text comment",
"flags": [
    "TEST"
],
"payUrl": "https://payment.qiwi.com/form?invoiceUid=3b39ad6d-f211-401d-8008-ed11af920a65"
}

{
  "serviceName" : "payin-core",
  "errorCode" : "validation.error",
  "description" : "Validation error",
  "userMessage" : "Validation error",
  "dateTime" : "2022-03-05T11:49:59.166+03:00",
  "traceId" : "fd0e2a08c63ace83"
}