Перейти к основному содержимому

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

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

Примеры​

Запрос​

PUT /sites/site-01/bills/0102313fsdfj82
Accept: application/json
Authorization: Bearer 5628af1c-26d9-42e7-8a6a-c22d491d79fb
Content-type: application/json
Host: qpay-api.qiwi.kz
{
  "amount": {
    "currency": "KZT",
    "value": "100.00"
  },
  "expirationDateTime": "2022-12-12T10:10:19+06:00",
  "comment": "Payment for testing.",
  "flags": ["SALE"],
  "successUrl": "https://test.com/#success",
  "failedUrl": "https://test.com/#failure",
  "customer": {
    "account": "123456",
    "email": "test@test.kz"
  }
}

Ответ​

{
  "siteId": "site-01",
  "billId": "0102313fsdfj82",
  "invoiceUid": "7828af1c-26d9-42e7-8a6a-c22d491d79fb",
  "amount": {
    "currency": "KZT",
    "value": "100.00"
  },
  "flags": ["SALE"],
  "status": {
    "value": "CREATED",
    "changedDateTime": "2022-12-12T10:10:19+06:00"
  },
  "creationDateTime": "2022-12-12T10:10:19+06:00",
  "expirationDateTime": "2022-12-15T10:10:19+06:00",
  "customer": {
    "account": "123456",
    "email": "test@test.kz"
  },
  "payUrl": "https://qpay-payform.qiwi.kz/form/invoice?invoiceUid=7828af1c-26d9-42e7-8a6a-c22d491d79fb"
}
Параметры запроса

Path Parameters​

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

Headers​

ПараметрТипОбязательныйОписание
AuthorizationstringДаАвторизационные данные. "Bearer [acсess-token]"
Content-typestringДаТип запроса. "application/json"
AcceptstringДаТип запроса. "application/json"

Request​

ПараметрТипОбязательныйОписание
amountobjectДаИнформация о сумме платежа
expirationDateTimestringДаДата, до которой счет будет доступен для оплаты, в формате ISO8601 (YYYY-MM-DDThh:mm:ss±hh:ss). Если счет не будет оплачен до этой даты, последующая оплата станет невозможна.
commentstringНетКомментарий к запросу
flagsarray of stringsНетДополнительные команды для API. "SALE" — использовать одношаговый сценарий авторизации. "BIND_PAYMENT_TOKEN" — флаг для выпуска платежного токена. "RECURRENT_FIRST" — флаг для инициации первого рекуррентного платежа.
successUrlstringНетURL для возврата на сайт мерчанта, в случае успешной оплаты. Ссылку необходимо указывать в кодировке UTF-8.
failedUrlstringНетURL для возврата на сайт мерчанта, в случае ошибки оплаты. Ссылку необходимо указывать в кодировке UTF-8.
customerobjectНетИнформация о клиенте
recurrentobjectНетДанные первого рекуррентного платежа. Обязателен, если флаг RECURRENT_FIRST
receiptobjectНетДанные для формирования фискального чека

Amount​

ПараметрТипОбязательныйОписание
valuenumberДа*Сумма операции (округленная до двух десятичных знаков в меньшую сторону).
currencystring(3)ДаВалюта в буквенном формате согласно ISO 4217.
Примечание:

Для большинства операций параметр value обязателен. Отсутствие параметра value означает, что сумма платежа будет введена клиентом при оплате на пейформе.

Customer​

ПараметрТипОбязательныйОписание
accountstringНетУникальный идентификатор клиента в системе ТСП
emailstringНетEmail клиента в системе ТСП
namestringНетНаименование клиента
phonestringНетНомер мобильного телефона. Например: 77071112233
ipstringНетIPv4 адрес плательщика, с которого будет открыта пейформа

Response​

ПараметрТипОбязательныйОписание
siteIdstringДаСтроковый идентификатор сайта ТСП в QIWI Кассе.
billIdstringДаУникальный идентификатор счета в информационной системе ТСП. Уникальность означает, что идентификатор должен отличаться от идентификаторов всех ранее созданных счетов ТСП в рамках одного siteId.
invoiceUidstringДаИдентификатор счета на стороне QIWI
amountobjectДаИнформация о сумме платежа
statusobjectДаСтатус созданного инвойса
commentstringНетКомментарий к запросу
creationDateTimestringДаДата создания счета, в формате ISO8601 (YYYY-MM-DDThh:mm:ss).
expirationDateTimestringДаСрок оплаты счета, в формате ISO8601 (YYYY-MM-DDThh:mm:ss).
payUrlstringДаСсылка на созданную Платежную форму оплаты счета
customerobjectНетИнформация о клиенте

Status​

ПараметрТипОбязательныйОписание
valuestringДаСтроковое значение статуса. Только CREATED - счёт выставлен, ожидает оплаты
changedDateTimestringДаДата изменения статуса счёта в формате ISO8601 (YYYY-MM-DDThh:mm:ss±hh:mm).

Recurrent​

ПараметрТипОбязательныйОписание
minAuthDayintДаМинимальное количество дней авторизации, периодичность списания в днях
expiryDatestringДаДата до которой будут выполняться рекуррентные платежи

Receipt​

ПараметрТипОбязательныйОписание
itemsarray<object>ДаМассив данных о товаре или услуге, оказанных мерчантом в фискальном чеке. Каждый объект содержит поля, описанные ниже.
Поля объекта items​
ПараметрТипОбязательныйОписание
namestringДаНаименование товара или услуги
pricenumberДаЦена за одну единицу товара или услуги
quantitynumberДаКоличество товаров или услуг
totalnumberДаОбщая сумма по позиции