title

search

metatitle

metadescription

language_tabs

services

toc_footers

includes

Mobile payments API 2.1 Мобильная коммерция

true

Mobile payments API 2.1 Мобильная коммерция

Mobile payments API Мобильная коммерция открывает доступ к операциям с балансом счета пользователя у сотового оператора из вашего приложения. Поддерживаются операции инициирования оплаты счета с мобильного телефона, а также проверки статуса выполнения операций.

shell

php

<a href='#'>Swagger</a> | <a href='#'>Qiwi Demo</a>

<a href='/'>На главную</a>

pull-payments/notification_ru

Платежи с баланса мобильного оператора

Редактировать на GitHub

Mobile Payments API открывает доступ к операциям с платежами из вашего сервиса. Поддерживаются следующие операции:

Инициация платежа
Проверка статуса оплаты счета
Уведомления об оплате

Процесс оплаты заказа {#steps}

Процесс оплаты выглядит следующим образом:

Пользователь формирует заказ на сайте провайдера.
Мерчант выполняет запрос Инициировать платеж с параметрами авторизации.
Сразу после инициирования платежа пользователь получает СМС от своего мобильного оператора с информацией о счете и подтверждает оплату ответным СМС. Если пользователь отказался от оплаты, то счет автоматически отклоняется.

{:height="45%" width="45%"}
Если провайдер включил отправку уведомлений на сервер провайдера, то после проведения платежа система высылает уведомление на сервер провайдера об оплате данного счета. Уведомления содержат параметры авторизации, которые необходимо проверять на сервере провайдера.

В отсутствие уведомлений провайдер может запросить текущий статус платежа.
После подтверждения оплаты счета провайдер исполняет заказ пользователя.

Данное API можно использовать только после регистрации и подключения.

Авторизация {#auth_param}

Запросы мерчанта к Mobile payments API авторизуются посредством HTTP basic-авторизации. Для авторизации используются API ID и API password. Заголовок представляет собой параметр Authorization, значение которого представлено как: Basic Base64(API_ID:API_PASSWORD)

curl "адрес сервера" \
  --header "Authorization: Basic MjMyNDQxMjM6NDUzRmRnZDQ0Mw=="

Авторизация и работа с формами
Данные могут быть получены на сайте kassa.qiwi.com

Служебные данные {#auth_param}

Параметр	Описание	Тип
API_ID	Обязательный параметр. Идентификатор для авторизации провайдера в API	Integer
API_PASSWORD	Обязательный параметр. Пароль для авторизации в API	String
ID проекта	Обязательный параметр. Числовой идентификатор провайдера (идентификатор проекта или PRV_ID)	Integer

Получить служебные данные можно на партнерском сайте kassa.qiwi.com в разделе "Протоколы - REST-протокол - Аутентификационные данные".

Инициация платежа и оплата {#invoice_rest}

Запрос инициирует новый платеж на указанный номер телефона. Тип запроса - HTTP PUT.

Для подтверждения оплаты, на указанный номер телефона будет отправлен SMS код оператором сотовой связи пользователя.

Запрос → PUT

curl "https://api.qiwi.com/api/v2/prv/373712/bills/BILL-1" \
  -X PUT --header "Accept: text/json" \
  --header "Authorization: Basic ***" \
  -d 'user=tel%3A%2B79161111111&amount=10.00&ccy=RUB&comment=test&pay_source=mobile&lifetime=2016-09-25T15:00:00'

HTTP/1.1 200 OK
Content-Type: text/json

{
  "response": {
     "result_code": 0,
     "bill": {
        "bill_id": "BILL-1",
        "amount": "10.00",
        "ccy": "RUB",
        "status": "waiting",
        "error": 0,
        "user": "tel:+79161111111",
        "comment": "Text comment"
     }
  }
}

URL https://api.qiwi.com/api/v2/prv/prv_id/bills/bill_id
- prv_id - числовой идентификатор провайдера (идентификатор проекта на партнерском сайте kassa.qiwi.com)
- bill_id - уникальный идентификатор счета в системе провайдера.

HEADERS
- Accept: text/json - формат ответа JSON
- Content-type: application/x-www-form-urlencoded; charset=utf-8
- Authorization: Basic XXX

Параметры
Параметры передаются в теле запроса как url-encoded formdata

Параметр	Описание	Тип
user	Обязательный параметр. Идентификатор номера QIWI Wallet, на который выставляется счет (в международном формате), с префиксом `tel:`	String(20)
amount	Обязательный параметр. Сумма, на которую выставляется счет. Округляется в меньшую сторону до двух десятичных знаков	Number(6.2)
ccy	Обязательный параметр. Идентификатор валюты (Alpha-3 ISO 4217 код). Может использоваться любая валюта, предусмотренная договором с КИВИ	String(3)
comment	Обязательный параметр. Комментарий к счету	String(255)
lifetime	Обязательный параметр. Дата/время с точностью до секунд в формате ISO 8601 (`ГГГГ-ММ-ДДTчч:мм:сс`). Указывается московское время. Если счет не будет оплачен до этой даты, ему присваивается финальный статус и последующая оплата станет невозможна. Внимание! По истечении 45 суток от даты выставления счет автоматически будет переведен в финальный статус.	dateTime
pay_source	Обязательный параметр. `mobile` - оплата счета будет производиться с баланса мобильного телефона пользователя	String

Ответ ←

Успешный ответ

HTTP/1.1 200 OK
Content-Type: text/json;charset=utf-8

{
  "response": {
     "result_code": 0,
     "bill": {
        "bill_id": "BILL-1",
        "amount": "10.00",
        "ccy": "RUB",
        "status": "waiting",
        "error": 0,
        "user": "tel:+79031234567",
        "comment": "Text comment"
     }
  }
}

Ответ в случае ошибки

HTTP/1.1 500 Internal Server Error
Content-Type: text/json;charset=utf-8

{
 "response": {
  "result_code": 150,
  "description": "Authorization failed"
  }
}

Поля ответа

Поле ответа	Тип	Описание
result_code	Integer	Код результата
description	String	Описание ошибки. Передается в случае ошибки
bill	Object	Описание счета
bill.bill_id	String	Копия параметра `bill_id` из исходного запроса
bill.amount	String	Сумма счета. Округляется в меньшую сторону до двух десятичных знаков.
bill.ccy	String	Идентификатор валюты (Alpha-3 ISO 4217 код)
bill.status	String	Текущий статус счета
bill.error	Integer	Константа, всегда `0`
bill.user	String	Копия параметра `user` из исходного запроса
bill.comment	String	Копия параметра `comment` из исходного запроса

<?php
//Пример реализации запроса на PHP
//Идентификатор магазина из вкладки "Данные магазина"
$SHOP_ID = "21379721";
//API ID из вкладки "Данные магазина"
$REST_ID = "62573819";
//API пароль из вкладки "Данные магазина"
$PWD = "**********";
//ID счета
$BILL_ID = "99111-ABCD-1-2-1";
$PHONE = "79191234567";

$data = array(
    "user" => "tel:+" . $PHONE,
    "amount" => "1000.00",
    "ccy" => "RUB",
    "comment" => "Товар из корзины",
    "lifetime" => "2015-01-30T15:35:00",
    "pay_source" => "mobile"
);

$ch = curl_init('https://api.qiwi.com/api/v2/prv/'.$SHOP_ID.'/bills/'.$BILL_ID);
curl_setopt($ch, CURLOPT_SSL_VERIFYPEER, FALSE);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'PUT');
curl_setopt($ch, CURLOPT_POSTFIELDS, http_build_query($data));
curl_setopt($ch, CURLOPT_POST, 1);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, TRUE);
curl_setopt($ch, CURLOPT_HTTPAUTH, CURLAUTH_BASIC);
curl_setopt($ch, CURLOPT_USERPWD, $REST_ID.":".$PWD);
curl_setopt($ch, CURLOPT_HTTPHEADER,array (
    "Accept: application/json"
));
$results = curl_exec ($ch) or die(curl_error($ch));
echo $results;
echo curl_error($ch);
curl_close ($ch);
?>

Проверка статуса платежа {#invoice-status}

Запрос позволяет проверить текущий статус оплаты клиентом.

Запрос → GET

curl "https://api.qiwi.com/api/v2/prv/373712/bills/BILL-1" \
  --header "Authorization: Basic ***" \
  --header "Accept: text/json"

URL https://api.qiwi.com/api/v2/prv/prv_id/bills/bill_id
- prv_id - числовой идентификатор провайдера (идентификатор проекта на партнерском сайте kassa.qiwi.com)
- bill_id - уникальный идентификатор счета в системе провайдера.

HEADERS
- Authorization: Basic XXX
- Accept: text/json или Accept: application/json - формат ответа JSON

Ответ ←

Успешный ответ

HTTP/1.1 200 OK
Content-Type: text/json

{
  "response": {
     "result_code": 0,
     "bill": {
        "bill_id": "BILL-1",
        "amount": "10.00",
        "originAmount": "10.00"
        "ccy": "RUB",
        "originCcy": "RUB",
        "status": "paid",
        "error": 0,
        "user": "tel:+79031234567",
        "comment": "Text comment"
     }
  }
}

Ответ в случае ошибки

HTTP/1.1 500 Internal Server Error
Content-Type: text/json

{
 "response": {
  "result_code": 150,
  "description": "Authorization failed"
  }
}

Поля ответа

Поле ответа	Тип	Описание
result_code	Integer	Код результата
description	String	Описание ошибки. Передается в случае ошибки
bill	Object	Описание счета
bill.bill_id	String	Уникальный идентификатор счета в системе провайдера
bill.amount	String	Сумма счета, округленная до 2 или 3 знаков после запятой. Способ округления зависит от валюты.
bill.originAmount	String	Сумма счета в исходной валюте счета (см. параметр `originCcy`), округленная до 2 или 3 знаков после запятой. Способ округления зависит от валюты.
bill.ccy	String	Идентификатор валюты (Alpha-3 ISO 4217 код)
bill.originCcy	String	Идентификатор валюты выставленного счета (Alpha-3 ISO 4217 код)
bill.status	String	Текущий статус счета
bill.error	Integer	Константа, `0`
bill.user	String	Идентификатор кошелька пользователя, которому выставлен счет (номер телефона в международном формате с префиксом `tel:`)
bill.comment	String	Комментарий к счету

Статусы операций {#status}

Статусы платежей {#status_bills}

Статус	Описание	Финальный
waiting	Платеж инициирован, ожидает оплаты	-
paid	оплачен	+
rejected	отклонен	+
unpaid	Ошибка при проведении оплаты. Не оплачен	+
expired	Время жизни платежа истекло. Не оплачен	+

Список ошибок {#errors}

Код	Описание	Fatal
0	Успех
5	Неверные данные в параметрах запроса	+
13	Сервер занят, повторите запрос позже	-
78	Недопустимая операция	+
150	Ошибка авторизации	+
152	Не подключен или отключен протокол	-
155	Данный идентификатор провайдера (API ID) заблокирован	+
210	Платеж не найден	+
215	Платеж с таким bill_id уже существует	+
241	Сумма слишком мала	+
300	Техническая ошибка	-
303	Неверный номер телефона	+
316	Попытка авторизации заблокированным провайдером	-
319	Нет прав на данную операцию	-
339	Ваш IP-адрес или массив адресов заблокирован	+
341	Обязательный параметр указан неверно или отсутствует в запросе	+
700	Превышен месячный лимит на операции	+
774	Счет клиента в системе QIWI временно заблокирован	-
1001	Запрещенная валюта для провайдера	+
1003	Не удалось получить курс конвертации для данной пары валют	-
1019	Не удалось определить сотового оператора для мобильной коммерции	+
1419	Нельзя изменить данные счета – он уже оплачивается или оплачен	+

Признак Fatal означает, что при повторном запросе результат не изменится (ошибка не временная, проанализируйте данные запроса или обратитесь в Support).

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

pull-mobile-payments_ru.html.md

pull-mobile-payments_ru.html.md

Платежи с баланса мобильного оператора

Редактировать на GitHub

Процесс оплаты заказа {#steps}

Авторизация {#auth_param}

Авторизация и работа с формами

Служебные данные {#auth_param}

Инициация платежа и оплата {#invoice_rest}

Запрос → PUT

URL https://api.qiwi.com/api/v2/prv/prv_id/bills/bill_id

HEADERS

Параметры

Ответ ←

Поля ответа

Проверка статуса платежа {#invoice-status}

Запрос → GET

URL https://api.qiwi.com/api/v2/prv/prv_id/bills/bill_id

HEADERS

Ответ ←

Поля ответа

Статусы операций {#status}

Статусы платежей {#status_bills}

Список ошибок {#errors}

Files

pull-mobile-payments_ru.html.md

Latest commit

History

pull-mobile-payments_ru.html.md

File metadata and controls

Платежи с баланса мобильного оператора

Редактировать на GitHub

Процесс оплаты заказа {#steps}

Авторизация {#auth_param}

Авторизация и работа с формами

Служебные данные {#auth_param}

Инициация платежа и оплата {#invoice_rest}

Запрос → PUT

URL https://api.qiwi.com/api/v2/prv/prv_id/bills/bill_id

HEADERS

Параметры

Ответ ←

Поля ответа

Проверка статуса платежа {#invoice-status}

Запрос → GET

URL https://api.qiwi.com/api/v2/prv/prv_id/bills/bill_id

HEADERS

Ответ ←

Поля ответа

Статусы операций {#status}

Статусы платежей {#status_bills}

Список ошибок {#errors}