Documentation

Documentation

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

›Методы

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

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

Работа с API

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

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

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

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

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

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

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

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

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

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

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

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

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

Виджеты

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

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

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

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

Самозанятые

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

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

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

Справочник API

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

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

Метод check

Этот запрос нужен, чтобы провести проверку паспортных данных получателя выплаты (физлица).

В ответе возвращается идентификатор запроса, по нему можно узнать результат проверки.

Адрес для отправки запроса

Для тестирования

POST https://kyc-stage.bank131.ru/api/v1.1/check

При тестировании реальная проверка паспортных данных в СМЭВ не производится, результат проверки будет эмулирован. Не используйте проверку на тестовой среде для идентификации клиентов.

Для реальных операциий

POST https://kyc.bank131.ru/api/v1.1/check

Запрос

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

Данные получателя

НазваниеОбязательностьТипОписание
first_name+stringФамилия
last_name+stringИмя
patronymic-stringОтчество
birthday+stringДата рождения
birthplace+stringМесто рождения
inn+stringИНН, 10 цифр

Удостоверение личности (паспорт)

НазваниеОбязательностьТипОписание
identity_document+stringТип документа. Всегда: Паспорт гражданина РФ
passport_number+stringСерия и номер паспорта, без пробелов. Пример: 1234567890.
issuer+stringКем выдан
issuer_code+stringКод подразделения
issuer_date+stringДата выдачи в формате ДД.ММ.ГГГГ
citizenship+stringГражданство. Всегда РФ

Адрес регистрации

НазваниеОбязательностьТипОписание
postcode+stringИндекс
address+stringАдрес

Контакты получателя

НазваниеОбязательностьТипОписание
email+stringАдрес электронной почты (нужен валидный адрес)
phone_number+stringНомер телефона в любом формате

Дополнительные данные

НазваниеОбязательностьТипОписание
agent_contract_number+stringНомер агентского договора с получателем
agent_contract_date+stringДата агентского договора с получателем
beneficial_owners+stringВсегда ВБ отсутствует
public_officials+stringВсегда Нет
migration_card+stringВсегда -
right_to_stay_in_rf+stringВсегда -

Пример запроса

cURL
   -H 'x-partner-project: test-partner-project' \
-H 'Content-Type: application/json' \
-H 'accept: application/json' \
--data-binary
'{
"payload":
{
"inn":"065553161159",
"email":"name@email.com",
"issuer":"ОТДЕЛОМ УФМС РОССИИ",
"address":"г. Бобруйск, алл. Прибрежная, д. 53 стр. 9, 365826",
"birthday":"01.01.1970",
"postcode":"365826",
"birthplace":"г. Бобруйск",
"last_name":"Дмитриев",
"first_name":"Иван",
"patronymic":"Герасимович",
"citizenship":"РФ",
"issuer_code":"123-000",
"issuer_date":"01.01.2010",
"phone_number":"+79000000000",
"migration_card":"-",
"passport_number":"0234567890",
"public_officials":"Нет",
"beneficial_owners":"ВБ отсутствует",
"identity_document":"Паспорт гражданина РФ",
"agent_contract_date":"01.01.2020",
"right_to_stay_in_rf":"-",
"agent_contract_number":"123456789-0"
},
"signature":"dkQzYwTExRc0RFWk1CY0dBMVVFQnd3UTBMTXVJTkNjMEw3Ug0NCmd..."}' --compressed

Ответ

При тестировании успех проверки (значение поля status в ответе) зависит от последней цифры номера паспорта в поле passport_number в запросе.

Последняя цифра passport_numberЗначение status
Четный, включая 0ok
Нечетныйerror

Параметры ответа

НазваниеОбязательностьТипОписание
status+stringСтатус проверки. Возможные варианты: ok, error
data-DataОбъект с данными ответа
id-numberИдентификатор запроса check
description-stringОписание статуса запроса
error-ErrorОбъект с данными ошибки
code+stringКод ошибки
description+stringОписание ошибки
Пример успешного ответа
{
    "status": "ok",
    "data":
        {
            "id": "7",
            "description": "запрос добавлен в очередь"
           }
}
Пример ответа с ошибкой
{
    "status": "error",
    "error": {
        "code": "partner_project_not_found",
        "description": "partner project not found"
    }
}
← ВзаимодействиеСтатус проверки →
  • Метод check
    • Адрес для отправки запроса
  • Запрос
    • Параметры запроса
    • Пример запроса
  • Ответ
    • Параметры ответа
Documentation
Документация
Массовые выплатыПрием платежейСправочник APIЮридические документы
Сценарии по шагам
Выплата на карту с токеномВыплата на карту с PCI DSSВыплата самозанятомуОплата через платежную форму
Напишите нам
Предложения и идеи — partners@131.ruПресса — press@131.ru
© 2022 Банк 131