API QIWI Мастер {#qiwi-master}

Предложить правки на GitHub

API дает доступ к управлению пакетом услуг QIWI Мастер. Пакет услуг позволяет выпускать до пяти бесплатных виртуальных карт QIWI и перевыпускать карты неограниченное число раз. Выпуск карт сверх указанного количества оплачивается по тарифу.

Доступны два типа карт:

QIWI Мастер Prepaid – для оплаты рекламы в сервисах Яндекс.Директ и myTarget;
QIWI Мастер Debit – новый дебетовый БИН.

Для вызова методов API вам потребуется токен API QIWI Wallet с разрешениями на следующие действия:

Управление виртуальными картами,
Запрос информации о профиле кошелька,
Просмотр истории платежей,
Проведение платежей без SMS.

Отметьте указанные разрешения при выпуске токена API QIWI Wallet.

См. также Пошаговое руководство по интеграции API QIWI Мастер.

С помощью методов API вы можете:

Выпустить карту QIWI Мастер.
Получить список ваших карт QIWI Мастер.
Получить выписку транзакций по карте.
Заблокировать и разблокировать карту.
Получить реквизиты карты.
Переименовать карту.

Чтобы начать работу с API, необходимо приобрести пакет QIWI Мастер.

Покупка пакета QIWI Мастер {#buy-qiwi-master}

Запрос → POST

curl -X POST \
  'https://edge.qiwi.com/sinap/api/v2/terms/28004/payments' \
  --header "Content-Type: application/json" \
  --header "Accept: application/json" \
  --header "Authorization: Bearer <токен API>" \
  -d '{
        "id":"1600884280003",
        "sum": {
          "amount":2999,
          "currency":"643"
        },
        "paymentMethod": {
          "type":"Account",
          "accountId":"643"
        },
        "comment":"Оплата",
        "fields": {
          "account":"79121112233",
          "vas_alias":"qvc-master"
        }
    }'

POST /sinap/api/v2/terms/28004/payments HTTP/1.1
Content-Type: application/json
Accept: application/json
Authorization: Bearer <токен API>
Host: edge.qiwi.com

{
 "id":"1600884280003",
 "sum": {
  "amount":2999,
  "currency":"643"
 },
 "paymentMethod": {
  "type":"Account",
  "accountId":"643"
 },
 "comment":"Оплата",
 "fields": {
   "account":"79121112233",
   "vas_alias":"qvc-master"
 }
}

import requests
import time

# Перевод на QIWI Кошелек
def buy_qiwi_master(api_access_token, qw):
    s = requests.Session()
    s.headers = {'content-type': 'application/json'}
    s.headers['authorization'] = 'Bearer ' + api_access_token
    s.headers['User-Agent'] = 'Android v3.2.0 MKT'
    s.headers['Accept'] = 'application/json'
    postjson = {"id":"","sum":{"amount":"","currency":""},"paymentMethod":{"type":"Account","accountId":"643"}, "fields":{"account":"", "vas_alias":"qvc-master"}}
    postjson['id'] = str(int(time.time() * 1000))
    postjson['sum']['amount'] = 2999
    postjson['sum']['currency'] = '643'
    postjson['fields']['account'] = qw
    res = s.post('https://edge.qiwi.com/sinap/api/v2/terms/28004/payments',json = postjson)
    return res.json()

URL /sinap/api/v2/terms/28004/payments

HEADERS
- Accept: application/json
- Content-type: application/json
- Authorization: Bearer ***

Параметры

В теле запроса передается JSON-объект Payment. Набор обязательных реквизитов платежа в поле fields:

Название	Тип	Описание
fields.account	String	Номер кошелька для покупки пакета QIWI Мастер
fields.vas_alias	String	Только `qvc-master`

Ответ ←

print(buy_qiwi_master(mylogin,api_access_token,'+79261112233','comment',99.01))

>> Response
{'fields': {'account': '79261112233'},
 'id': '1514296828893',
 'source': 'account_643',
 'sum': {'amount': 2999.00, 'currency': '643'},
 'terms': '28004',
 'transaction': {'id': '11982501857', 'state': {'code': 'Accepted'}}}

Успешный JSON-ответ содержит объект PaymentInfo с данными о принятом платеже.

Выпуск виртуальной карты QIWI Мастер {#qiwi-master-issue-card}

Для выпуска виртуальной карты к пакету QIWI Мастер вам необходимо последовательно выполнить следующие запросы.

Шаг 1. Создание заказа {#order-card}

POST /cards/v2/persons/78000008024/orders HTTP/1.1
Accept: application/json
Authorization: Bearer f80f0875d8e45af7bdd244c7df3f1a3f
Content-Type: application/json
Host: edge.qiwi.com

{
 "cardAlias": "qvc-cpa"
}

Ответ

{
   "id": "<номер заказа>",
   "cardAlias": "qvc-cpa",
   "status": "DRAFT",
   "price": null,
   "cardId": null
}

Отправьте POST-запрос на адрес:

/cards/v2/persons/<номер кошелька>/orders

В ссылке запроса укажите номер кошелька с пакетом QIWI Мастер. В теле запроса укажите JSON с обязательным параметром:

Название	Тип	Описание
cardAlias	String	Тип карты

Успешный ответ содержит JSON с номером заказа:

Поле ответа	Тип	Описание
id	String	Номер заказа
cardAlias	String	Тип карты
status	String	Статус заказа
price	Object	Не заполняется
cardId	String	Не заполняется

Доступные для заказа типы карт {#card-types}

Название карты	Описание	cardAlias
QIWI Мастер Prepaid	Для оплаты рекламы в сервисах Яндекс.Директ и myTarget	"qvc-cpa"
QIWI Мастер Debit	Новый дебетовый БИН	"qvc-cpa-debit"

Шаг 2. Подтверждение заказа {#card-order-confirm}

PUT /cards/v2/persons/78000008024/orders/920fa383-6209-4743-a5d1-883f473f7f95/submit HTTP/1.1
Accept: application/json
Authorization: Bearer f80f0875d8e45af7bdd244c7df3f1a3f
Content-Type: application/json
Host: edge.qiwi.com

Ответ, если карта бесплатная

{
   "id": "<номер заказа>",
   "cardAlias": "qvc-cpa",
   "status": "COMPLETED",
   "price": {
     "amount": 0,
     "currency": 643
   },
   "cardId": "<ID карты>"
}

Ответ, если карта платная

{
   "id": "<номер заказа>",
   "cardAlias": "qvc-cpa",
   "status": "PAYMENT_REQUIRED",
   "price": {
     "amount": <стоимость>,
     "currency": 643
   },
   "cardId": null
}

Отправьте PUT-запрос на адрес:

/cards/v2/persons/<номер кошелька>/orders/<номер заказа из ответа в Шаге 1>/submit

В ссылке запроса укажите номер кошелька с пакетом QIWI Мастер и номер заказа из ответа предыдущего шага (поле id). В теле запроса ничего не указывайте.

Успешный ответ содержит JSON со статусом заказа:

Поле ответа	Тип	Описание
id	String	Номер заказа
cardAlias	String	Тип карты
status	String	Статус заказа. Если карта бесплатная, то `COMPLETED`. Если карта платная (выпускается сверх лимита в 5 карт), то `PAYMENT_REQUIRED`.
price	Object	Сведения о платеже
---	---	---
amount	Number(Decimal)	Сумма покупки
currency	Number(3)	Валюта платежа (ISO-4217)
-----	---	----
cardId	String	Номер выпущенной карты. Не заполняется, если карта платная.

Шаг 3. Покупка карты {#card-buy}

POST /sinap/api/v2/terms/32064/payments HTTP/1.1
Accept: application/json
Authorization: Bearer 68944212761e25f6fce457661cabba6c
Content-Type: application/json
Host: edge.qiwi.com

{
 "id": "1600884290004",
 "sum": {
   "amount": 99,
   "currency": "643"
 },
 "paymentMethod": {
   "type": "Account",
   "accountId": "643"
 },
 "fields": {
   "account": "78000008024",
   "order_id":"920fa383-6209-4743-a5d1-883f473f7f95"
 }
}

Этот шаг необходим только при выпуске платной карты (сверх лимита в пять карт).

Отправьте POST-запрос на адрес:

/sinap/api/v2/terms/32064/payments

В теле запроса передается JSON-объект Payment. Набор обязательных реквизитов платежа в объекте fields:

Название	Тип	Описание
fields.account	String	Номер кошелька
fields.order_id	String	Номер заказа из ответа на запрос

Успешный JSON-ответ содержит объект PaymentInfo с данными о принятом платеже.

Информацию о выпущенной карте вы можете запросить со списком карт QIWI Мастер в вашем кошельке. Карту можно найти по дате активации (поле activated) или по сравнению со списком ранее выпущенных карт.

Список карт QIWI Мастер {#qiwi-master-list}

GET /cards/v1/cards?vas-alias=qvc-master HTTP/1.1
Accept: application/json
Authorization: Bearer b15ba2d82db883697e8a35877e60e680
Host: edge.qiwi.com

Чтобы получить список всех ваших карт QIWI Мастер, отправьте GET-запрос на адрес:

/cards/v1/cards/?vas-alias=qvc-master

Ответ

[
  {
    "qvx": {
      "id": 133789472,
      "maskedPan": "****9078",
      "status": "ACTIVE",
      "cardExpire": "2022-01-31T00:00:00+03:00",
      "cardType": "VIRTUAL",
      "cardAlias": "Yandex",
      "cardLimit": null,
      "activated": "2020-01-29T11:10:59+03:00",
      "smsResended": "2020-01-29T11:35:01+03:00",
      "postNumber": null,
      "blockedDate": null,
      "fullPan": null,
      "cardId": 2001291110576200000,
      "txnId": "2001291110576200000",
      "cardExpireMonth": "01",
      "cardExpireYear": "2022"
    },
    "balance": null,
    "info": {
      "id": 12,
      "name": "Виртуальная карта QIWI",
      "alias": "qvc-cpa",
      "price": {
        "amount": 99.0000,
        "currency": 643
      },
      "period": "за год",
      "type": "QVC_CPA",
      "details": {
        "info": "99 ₽, действует 1 год",
        "description": "",
        "tariffLink": "https://static.qiwi.com/qcms/files/1582791401478_5_JJ5vJe1L0szXzKb.pdf",
        "offerLink": "https://static.qiwi.com/ru/doc/qvc.pdf",
        "features": [
          "Покупки без комиссии"
        ],
        "requisites": [
          {
            "name": "Получатель",
            "value": "КИВИ Банк (АО)"
          },
          {
            "name": "ИНН",
            "value": "3123011520"
          },
          {
            "name": "Банк получателя",
            "value": "КИВИ Банк (АО)"
          },
          {
            "name": "БИК",
            "value": "044525416"
          },
          {
            "name": "КПП",
            "value": "772601001"
          },
          {
            "name": "Счет",
            "value": "47416810600000000004"
          },
          {
            "name": "Корр. счет",
            "value": "30101810645250000416 (открыт в ГУ Банка России по Центральному федеральному округу)"
          },
          {
            "name": "Назначение платежа",
            "value": "Пополнение QIWI Кошелька\nN +79258150000"
          }
        ]
      },
      "features": []
    }
  }
]

Успешный ответ содержит JSON-массив с информацией о выпущенных картах:

Поле ответа	Тип	Описание
qvx	Object	Общая информация о карте
----	-----	----
id	Number	ID карты
maskedPan	String	Маскированный номер карты (отображаются только последние 4 цифры)
status	String	Текущий статус карты. Возможные значения: `ACTIVE`, `SENDED_TO_BANK`, `SENDED_TO_USER`, `BLOCKED`, `UNKNOWN`
cardExpire	String	Срок действия карты
cardType	String	Вид карты: всегда `VIRTUAL` (виртуальная карта)
cardAlias	String	Название карты в интерфейсе сайта qiwi.com
cardLimit	Object	Лимиты на карту
-----	-----	------
value	Number	Значение лимита
currencyCode	Number(3)	Код валюты (ISO-4217)
----	---	---
activated	String	Дата активации карты
smsResended	String	Дата высылки СМС с реквизитами
blockedDate	String	Дата блокировки
unblockAvailable	Boolean	Признак возможности разблокировать карту
txnId	String	ID транзакции заказа карты
cardExpireMonth	String	Месяц окончания действия карты
cardExpireYear	String	Год окончания действия карты
----	---	---
balance	Object	Данные баланса карты
---	----	-----
amount	Number	Сумма баланса
currency	Number(3)	Код валюты баланса (ISO-4217)
----	-----	----
info	Object	Тарифы и банковские реквизиты карты
-----	-----	----
alias	String	Тип карты
price	Object	Тариф карты
-----	-----	----
amount	Number	Стоимость обслуживания
currency	Number(3)	Код валюты баланса (ISO-4217)
-----	-----	----
period	String	Период обслуживания (по тарифу)
tariffLink	String	Ссылка на описание тарифа
offerLink	String	Ссылка на договор оферты на выпуск карты
requisites	Array	Список пар "ключ-значение" с данными банковских реквизитов для пополнения карты

Выписка по карте {#card-payments}

GET /payment-history/v1/persons/78000008024/cards/158618787/statement?from=2020-01-01T00%3A00%3A00%2B03%3A00&till=2020-09-23T23%3A59%3A59%2B03%3A00 HTTP/1.1
Accept: application/json
Authorization: Bearer b15ba2d82db883697e8a35877e60e680
Host: edge.qiwi.com

Запрос предназначен для выгрузки операций по определенной карте за указанный период в тарифе QIWI Мастер.

Выписку можно запросить за период не более 90 дней

Чтобы получить список операций по карте QIWI Мастер, отправьте GET-запрос на адрес:

/payment-history/v1/persons/<номер кошелька>/cards/<ID карты>/statement?from=<дата начала выписки>&till=<дата окончания выписки>

ID карты можно получить:

при ее выпуске — для бесплатной карты;
из ответа на запрос списка карт — для платной карты.

Успешный ответ в формате application/pdf (в бинарном виде) содержит PDF-файл с выпиской.

Блокировка карты {#card-block}

PUT /cards/v2/persons/78000006047/cards/70590106/block HTTP/1.1
Accept: application/json
Authorization: Bearer 68944212761e25f6fce457661cabba6c
Host: edge.qiwi.com

Чтобы заблокировать карту тарифа QIWI Мастер, отправьте PUT-запрос на адрес:

/cards/v2/persons/<номер кошелька>/cards/<ID карты>/block

ID карты можно получить:

при ее выпуске — для бесплатной карты;
из ответа на запрос списка карт — для платной карты.

Ответ ←

HTTP/1.1 202 Accepted
Content-Type: application/json

Успешный ответ содержит HTTP-код 202.

Разблокировка карты {#card-unblock}

PUT /cards/v2/persons/78000006047/cards/111887288/unblock HTTP/1.1
Accept: application/json
Authorization: Bearer 68944212761e25f6fce457661cabba6c
Host: edge.qiwi.com

Ответ

{
   "status": "OK",
   "nextConfirmationRequest": null,
   "confirmationId": null,
   "operationId": null
}

Разблокировка доступна в течение 90 дней с момента блокировки карты по API.

Чтобы разблокировать карту, отправьте PUT-запрос на адрес:

/cards/v2/persons/<номер кошелька>/cards/<ID карты>/unblock

ID карты можно получить:

при ее выпуске — для бесплатной карты;
из ответа на запрос списка карт — для платной карты.

Успешный ответ содержит JSON со статусом операции:

Поле ответа	Тип	Описание
status	String	Статус операции: `OK`, `FAIL`, `CONFIRMATION_REQUIRED` или `CONFIRMATION_LIMIT_EXCEED`
confirmationId	String	ID подтверждения (`null` для API)
operationId	String	ID операции (`null` для API)
nextConfirmationRequest	String	Дата следующей возможности запросить подтверждение (`null` для API)

Получение реквизитов карты {#card-details}

PUT /cards/v1/cards/158619365/details HTTP/1.1
Accept: application/json
Authorization: Bearer 68944212761e25f6fce457661cabba6c
Content-Type: application/json
Host: edge.qiwi.com

{
   "operationId": "43555447-a026-4c17-b56d-6956a09249c9"
}

Ответ

{
   "status": "OK",
   "cvv": "111",
   "pan": "44441111222233333",
   "errorCode": "0"
}

Чтобы получить платежные реквизиты карты (PAN и CVV), отправьте PUT-запрос на адрес:

/cards/v1/cards/<ID карты>/details

ID карты можно получить:

при ее выпуске — для бесплатной карты;
из ответа на запрос списка карт — для платной карты.

В теле запроса укажите JSON с обязательным параметром:

Название	Тип	Описание
operationId	String	Произвольный UUID

Успешный ответ содержит JSON с PAN и CVV карты:

Поле ответа	Тип	Описание
status	String	Статус операции: `OK`, `FAIL`, `CONFIRMATION_REQUIRED` или `CONFIRMATION_LIMIT_EXCEED`
cvv	String	CVV карты
pan	String	PAN карты
errorCode	String	Код ошибки

Переименование карты {#qvc-rename}

PUT /cards/v1/cards/158619365/alias HTTP/1.1
Accept: application/json
Authorization: Bearer 68944212761e25f6fce457661cabba6c
Content-Type: application/json
Host: edge.qiwi.com

{
   "alias": "new card name"
}

Ответ

{
   "status": "OK",
   "error": "OK",
   "errorCode": "OK"
}

Чтобы изменить название карты в интерфейсе сайта qiwi.com, отправьте PUT-запрос на адрес:

/cards/v1/cards/<ID карты>/alias

ID карты можно получить:

при ее выпуске — для бесплатной карты;
из ответа на запрос списка карт — для платной карты.

В теле запроса укажите JSON с обязательным параметром:

Название	Тип	Описание
alias	String	Новое пользовательское имя карты

Успешный ответ содержит JSON со статусом операции:

Поле ответа	Тип	Описание
status	String	Статус операции:`OK` или `FAIL`
error	String	Текстовое описание ошибки
errorCode	String	Код ошибки

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

_master_ru.html.md

_master_ru.html.md

API QIWI Мастер {#qiwi-master}

Предложить правки на GitHub

Покупка пакета QIWI Мастер {#buy-qiwi-master}

Запрос → POST

URL /sinap/api/v2/terms/28004/payments

HEADERS

Параметры

Ответ ←

Выпуск виртуальной карты QIWI Мастер {#qiwi-master-issue-card}

Шаг 1. Создание заказа {#order-card}

Доступные для заказа типы карт {#card-types}

Шаг 2. Подтверждение заказа {#card-order-confirm}

Шаг 3. Покупка карты {#card-buy}

Список карт QIWI Мастер {#qiwi-master-list}

Выписка по карте {#card-payments}

Блокировка карты {#card-block}

Ответ ←

Разблокировка карты {#card-unblock}

Получение реквизитов карты {#card-details}

Переименование карты {#qvc-rename}

Files

_master_ru.html.md

Latest commit

History

_master_ru.html.md

File metadata and controls

API QIWI Мастер {#qiwi-master}

Предложить правки на GitHub

Покупка пакета QIWI Мастер {#buy-qiwi-master}

Запрос → POST

URL /sinap/api/v2/terms/28004/payments

HEADERS

Параметры

Ответ ←

Выпуск виртуальной карты QIWI Мастер {#qiwi-master-issue-card}

Шаг 1. Создание заказа {#order-card}

Доступные для заказа типы карт {#card-types}

Шаг 2. Подтверждение заказа {#card-order-confirm}

Шаг 3. Покупка карты {#card-buy}

Список карт QIWI Мастер {#qiwi-master-list}

Выписка по карте {#card-payments}

Блокировка карты {#card-block}

Ответ ←

Разблокировка карты {#card-unblock}

Получение реквизитов карты {#card-details}

Переименование карты {#qvc-rename}