Documentation

Documentation

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

›Методы

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

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

Работа с API

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

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

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

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

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

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

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

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

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

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

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

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

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

Виджеты

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

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

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

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

Самозанятые

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

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

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

Справочник API

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

Статус проверки

Метод check/{id}

Этот запрос нужен, чтобы проверить статус запроса check и получить ответ на проверку паспорта физлица.

Добавьте в адрес запроса идентификатор, полученный в ответ на запрос проверки паспортных данных. В ответ придет статус проверки.

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

  • Для тестирования GET https://kyc-stage.bank131.ru/api/v1.1/check/{id}
  • Для реальных операциийGET https://kyc.bank131.ru/api/v1.1/check/{id}

Запрос

Тело запроса пустое.

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

cURL
  -X GET https://kyc.bank131.ru/api/v1.1/check/7 \
-H 'Content-Type: application/json' \
-H 'X-PARTNER-PROJECT: your_project_name'

Ответ

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

НазваниеОбязательностьТипОписание
status+stringСтатус проверки. Возможные варианты: ok, pending, error
data-DataОбъект с данными ответа
id-numberИдентификатор запроса check
description-stringОписание статуса запроса
participant-ParticipantДанные получателя выплаты
reference-stringИдентификатор получателя
error-ErrorОбъект с данными ошибки
code+stringКод ошибки
description+stringОписание ошибки
Пример успешного ответа
{
  "status": "ok",
  "data":
    {
      "id": "7", // идентификатор запроса `check`
      "description": "valid",
      "participant":
        {
          "reference": "123"
        }
    }
}
Пример ответа: запрос в обработке

Повторите запрос check/{id} с этими же данными чуть позже.

{
    "status": "pending",
    "data":
        {
            "id": "7",
            "description": "Check in progress"
           }
}
Пример ответа с ошибкой. Данные уже проверили
{
    "status": "error",
    "error": {
        "code": "already_exists",
        "description": "Request with the same data already exists"
    }
    "data": {
        "id": "7" // идентификатор предыдущей проверки
       }
}
← Проверка паспортаОтветы и ошибки →
  • Метод check/{id}
    • Адрес для отправки запроса
  • Запрос
    • Пример запроса
  • Ответ
    • Параметры ответа
Documentation
Документация
Массовые выплатыПрием платежейСправочник APIЮридические документы
Сценарии по шагам
Выплата на карту с токеномВыплата на карту с PCI DSSВыплата самозанятомуОплата через платежную форму
Напишите нам
Предложения и идеи — partners@131.ruПресса — press@131.ru
© 2022 Банк 131