Documentation

Documentation

  • API Банка 131
  • Languages iconРусский
    • English

›Прием платежей

Документация

  • Возможности API
  • С чего начать

Работа с API

  • Формат работы
  • Библиотеки
  • Тестирование
  • История изменений

Массовые выплаты

  • Возможности
  • Как всё работает
  • Сценарии выплат
  • Возвраты выплат
  • Самозанятые

    • Выплаты самозанятым
    • Фискализация без выплаты

    Способы получения выплат

    • На российскую банковскую карту
    • На счет в российском банке
    • В кошелек QIWI
    • В кошелек ЮMoney (Яндекс.Деньги)
    • В налоговую
    • Через СБП по номеру телефона

    Выплаты по шагам

    • Выплата на карту с виджетом
    • Выплата с расчетного счета
    • Выплата с номинального счета
    • Выплата в иностранной валюте
    • Выплата одним запросом
    • Выплата на карту с PCI DSS
    • Выплата самозанятому с фискализацией

Прием платежей

  • Возможности
  • Процесс платежа
  • Платеж банковской картой
  • Платежи с холдированием
  • Возвраты
  • Рекуррентные платежи
  • Платежи через СБП по QR-коду
  • Платеж кошельком QIWI
  • Сплит-платежи

    • Варианты и возможности
    • Сплит-платежи без доработок
    • Сплит-платежи по API

    Платежи по шагам

    • Оплата через платежную форму
    • Оплата с PCI DSS
    • Платеж одним запросом

Виджеты

  • Виджет для токенизации карты
  • Виджет платежной формы
  • Виджет для привязки самозанятого

Проверка паспорта

  • Возможности
  • Взаимодействие
  • Методы

    • Проверка паспорта
    • Статус проверки
  • Ответы и ошибки

Самозанятые

  • Общая информация
  • Привязка
  • Проверка привязки
  • Проверка данных
  • Оповещения из ФНС
  • Начисления и бонусы

Акты и реестры

  • Реестр выплат
  • Реестр платежей
  • Акт

Справочник API

  • Объекты
  • Методы
  • Вебхуки
  • Коды ошибок

Платеж кошельком QIWI

Вы можете принимать платежи кошельками QIWI. Этот способ годится только для плательщиков-резидентов.

Cценарий получения платежа кошельком QIWI

  1. Создаете платеж session/init/payment. В параметрах платежного запроса можно передать URL для перехода пользователя после оплаты, время жизни инвойса и дополнительное описание платежа;
  2. Получаете вебхук action_required от Банка 131. В вебхуке передается URL c параметрами оплаты;
  3. Перенаправляете пользователя по URL, пользователь авторизовывается в кошельке и подтверждает платеж смс-кодом. На совершение платежа пользователю по умолчанию отводится 1 час. Время ожидания можно настроить в параметре expiration_at, но оно не должно быть более 1 часа;
  4. Получаете от Банка 131 вебхук payment_finished с результатом проведения платежа и номером телефона плательщика. Статус succeeded сообщает вам, что платеж успешно проведен.

Пример запроса на создание платежной сессии

В запросе в объекте payment_options можно передать URL для перехода пользователя после оплаты и время жизни инвойса.

curl -X POST \
  https://demo.bank131.ru/api/v1/session/create \
  -H 'Content-Type: application/json' \
  -H 'X-PARTNER-PROJECT: your_project_name' \
  -H 'X-PARTNER-SIGN: 721af394d5a7aefd0e91f5390abc4d7e20fb2b5784b091fef621f3c61b7abb4b' \
  -d '{
    "payment_details": {
        "type": "wallet",
        "wallet": {
            "type": "qiwi",
            "qiwi": {
                "description": "my description"
            }
        }
    },
    "customer": {
        "reference": "190558917",
        "contact": [
            {
                "email": "ramdevi@example.com"
            }
        ]
    },
    "amount_details": {
        "amount": 100,
        "currency": "rub"
    },
    "metadata": {
        "key": "value"
    },
    "payment_options": {
        "return_url": "http://xxxx.ru",
        "recurrent": false
    }
}

Пример вебхука action_required (вебхук содержит URL для перехода пользователя после оплаты, время жизни инвойса и дополнительное описание платежа)

curl -X POST \
  https://partner.ru \
  -H 'Content-Type: application/json' \
  -H 'X-PARTNER-SIGN: a4f1698616d6ad7b8b73a9d72d281eeb443b64dee3f38df430eeed6aa29e1dc' \
  -d '{
  "type": "action_required",
  "session": {
    "id": "ps_629464",
    "status": "in_progress",
    "created_at": "2023-06-16T08:20:11.100714Z",
    "updated_at": "2023-06-16T08:20:11.758451Z",
    "acquiring_payments": [
      {
        "id": "pm_301086",
        "status": "pending",
        "created_at": "2023-06-16T08:20:11.195507Z",
        "customer": {
          "reference": "190558917"
        },
        "payment_details": {
          "type": "wallet",
          "wallet": {
            "type": "qiwi",
            "qiwi": {
              "account": "",
              "description": "my description"
            }
          }
        },
        "amount_details": {
          "amount": 100,
          "currency": "RUB"
        },
        "amounts": {
          "net": {
            "amount": 95,
            "currency": "RUB"
          },
          "gross": {
            "amount": 100,
            "currency": "RUB"
          }
        },
        "customer_interaction": {
          "type": "redirect",
          "redirect": {
            "url": "https://oplata.qiwi.com/form?invoiceUid=6691a752-9a2f-445a-8121-7936a7244a63&successUrl=http%3A%2F%2Fya.ru",
            "base_url": "https://oplata.qiwi.com/form",
            "method": "GET",
            "qs": {
              "invoiceUid": "6691a752-9a2f-445a-8121-7936a7244a63",
              "successUrl": "http://xxxx.ru"
            },
            "params": {}
          }
        },
        "metadata": {
          "key": "value"
        },
        "payment_options": {
          "return_url": "http://xxxx.ru",
          "recurrent": false
        }
      }
    ]
  }
}

Пример вебхука action_required (вебхук содержит время жизни инвойса и дополнительное описание платежа)

curl -X POST \
  https://partner.ru \
  -H 'Content-Type: application/json' \
  -H 'X-PARTNER-SIGN: a4f1698616d6ad7b8b73a9d72d281eeb443b64dee3f38df430eeed6aa29e1dc' \
  -d '{
  "type": "action_required",
  "session": {
    "id": "ps_1093171",
    "status": "in_progress",
    "created_at": "2023-07-12T13:53:21.802280Z",
    "updated_at": "2023-07-12T13:53:22.341487Z",
    "acquiring_payments": [
      {
        "id": "pm_773370",
        "status": "pending",
        "created_at": "2023-07-12T13:53:21.906913Z",
        "customer": {
          "reference": "190100500"
        },
        "payment_details": {
          "type": "wallet",
          "wallet": {
            "type": "qiwi",
            "qiwi": {
              "account": "",
              "description": "комментарий в 256 символов"
            }
          }
        },
        "amount_details": {
          "amount": 400,
          "currency": "RUB"
        },
        "amounts": {
          "net": {
            "amount": 400,
            "currency": "RUB"
          },
          "gross": {
            "amount": 400,
            "currency": "RUB"
          }
        },
        "customer_interaction": {
          "type": "redirect",
          "redirect": {
            "url": "https://oplata.qiwi.com/form?invoiceUid=d5f8fcf2-3f52-4101-9495-d7c00c4599b5&successUrl=https%3A%2F%2Fwww.131.ru%2F",
            "base_url": "https://oplata.qiwi.com/form",
            "method": "GET",
            "qs": {
              "invoiceUid": "d5f8fcf2-3f52-4101-9495-d7c00c4599b5",
              "successUrl": "https://www.131.ru/"
            },
            "params": {}
          }
        },
        "metadata": {
          "key": "value"
        },
        "payment_options": {
          "return_url": "https://www.131.ru/",
          "recurrent": false,
          "description": "комментарий в 256 символов"
        }
      }
    ]
  }
}

Пример вебхука payment_finished - успешная оплата

{
  "type": "payment_finished",
  "session": {
    "id": "ps_1100755",
    "status": "accepted",
    "created_at": "2023-08-03T07:51:59.878059Z",
    "updated_at": "2023-08-03T07:58:59.286803Z",
    "acquiring_payments": [
      {
        "id": "pm_773469",
        "status": "succeeded",
        "created_at": "2023-08-03T07:51:59.984814Z",
        "finished_at": "2023-08-03T07:58:59.072221Z",
        "customer": {
          "reference": "190100500"
        },
        "payment_details": {
          "type": "wallet",
          "wallet": {
            "type": "qiwi",
            "qiwi": {
              "account": "79011234567",
              "description": "коомментарий в 256 символовкоомментарий в 256 символовкоомментарий в 256 символовкоомментарий в 256 символовкоомментарий в 256 символовкоомментарий в 256 символовкоомментарий в 256 символовкоомментарий в 256 символовкоомментарий в 256 символовкоомментари1"
            }
          }
        },
        "amount_details": {
          "amount": 400,
          "currency": "RUB"
        },
        "amounts": {
          "net": {
            "amount": 400,
            "currency": "RUB"
          },
          "gross": {
            "amount": 400,
            "currency": "RUB"
          }
        },
        "payment_options": {
          "return_url": "https://www.131.ru/",
          "recurrent": false,
          "description": "коомментарий в 256 символовкоомментарий в 256 символовкоомментарий в 256 символовкоомментарий в 256 символовкоомментарий в 256 символовкоомментарий в 256 символовкоомментарий в 256 символовкоомментарий в 256 символовкоомментарий в 256 символовкоомментари1",
          "expiration_at": "2023-08-03 10:55:59"
        }
      }
    ]
  }
}
← Платежи через СБП по QR-кодуВарианты и возможности →
  • Cценарий получения платежа кошельком QIWI
    • Пример запроса на создание платежной сессии
    • Пример вебхука action_required (вебхук содержит URL для перехода пользователя после оплаты, время жизни инвойса и дополнительное описание платежа)
    • Пример вебхука action_required (вебхук содержит время жизни инвойса и дополнительное описание платежа)
    • Пример вебхука payment_finished - успешная оплата
Documentation
Документация
Массовые выплатыПрием платежейСправочник APIЮридические документы
Сценарии по шагам
Выплата на карту с токеномВыплата на карту с PCI DSSВыплата самозанятомуОплата через платежную форму
Напишите нам
Предложения и идеи — partners@131.ruПресса — press@131.ru
© 2022 Банк 131