Documentation

Documentation

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

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

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

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

Работа с API

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

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

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

    • Выплаты самозанятым
    • Привязка самозанятого

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

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

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

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

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

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

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

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

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

Виджеты

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

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

  • Возможности
  • Взаимодействие
  • Проверка паспорта
  • Статус проверки
  • HTTP-коды ответа

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

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

Справочник 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+numberИНН, 10 цифр

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

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

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

НазваниеОбязательностьТипОписание
postcode+numberИндекс
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
  -X POST https://kyc-stage.bank131.ru/api/v1.1/check \
-H 'Content-Type: application/json' \
-H 'X-PARTNER-PROJECT: your_project_name' \
-d '{
"
payload": {
"
inn": "123456789012",
"
email": "name@email.com",
"
issuer": "ОТДЕЛОМ УФМС РОССИИ",
"
address": "п. Сосьва (Хант.), алл. Прибрежная, д. 53 стр. 9, 365826",
"
birthday": "28.02.1990",
"
postcode": "365826",
"
last_name": "Дмитриев",
"
birthplace": "с. Ербогачен, пер. Павлика Морозова, д. 86 к. 267, 531558",
"
first_name": "Иван",
"
patronymic": "Герасимович",
"
citizenship": "РФ",
"
issuer_code": "123-000",
"
issuer_date": "01.01.2010",
"
phone_number": "+79000000000",
"
migration_card": "-",
"
passport_number": "1234567890",
"
public_officials": "Нет",
"
beneficial_owners": "БВ отсутствует",
"
identity_document": "Паспорт гражданина РФ",
"
agent_contract_date": "01.01.2020",
"
right_to_stay_in_rf": "-",
"
agent_contract_number": "123456789"
},
"
signature": "dkQzYwTExRc0RFWk1CY0dBMVVFQnd3UTBMTXVJTkNjMEw3Ug0NCmd..."
}'

Ответ

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

НазваниеОбязательностьТипОписание
status+stringСтатус проверки. Возможные варианты: ok, error
data-DataОбъект с данными ответа
id-numberИдентификатор запроса check
description-stringОписание статуса запроса
error-ErrorОбъект с данными ошибки
code+stringКод ошибки
description+stringОписание ошибки

Содержимое ответа

Дальше описано содержимое объектов Data и Error, которые приходят в ответе при HTTP-коде 200. Посмотреть все HTTP-коды ответа

Статус ok

Запрос проверки создан. Чтобы узнать результат, отправьте запрос check{id} с идентификатором из поля id.

Пример ответа
{
    "status": "ok",
    "data":
        {
            "id": "7",
            "description": "запрос добавлен в очередь"
           }
}

Статус error

codedescriptionОписание ошибки
partner_project_not_foundpartner project not foundИдентификатор проекта, отправленный в заголовке X-PARTNER-PROJECT, не существует
Пример ответа с ошибкой
{
    "status": "error",
    "error": {
        "code": "partner_project_not_found",
        "description": "partner project not found"
    }
}
← ВзаимодействиеСтатус проверки →
  • Метод check
    • Адрес для отправки запроса
  • Запрос
    • Параметры запроса
    • Пример запроса
  • Ответ
    • Параметры ответа
    • Содержимое ответа
Documentation
Документация
Массовые выплатыПрием платежейСправочник API
Сценарии по шагам
Выплата на карту с токеномВыплата на карту с PCI DSSВыплата самозанятомуОплата через платежную форму
Напишите нам
Предложения и идеи — partners@131.ruПресса — press@131.ru
© 2020 Банк 131