APIs

0
No votes yet

Courier Delivery Services (1.0.5)

Назначение

Данный сервис предназначен для обращения партнёров-курьерских служб к бэк-системе Альфа-Банка с целью обмена файлами и продвижением заявок по бизнес-процессу.

Доступные методы

GetAttachedFiles

Метод для получения приложенных к заявке файлов. Альфа-Банк возвращает те файлы, которые необходимы партнёру для конкретного процесса.

GetAttachedFileContent

Метод для получения содержимого файла в формате base64. Должен вызываться по каждому файлу, полученному в методе GetAttachedFiles.

AuthorizePipe

Метод для запроса авторизации курьера для заверения документов простой электронной подписью (курьер должен быть оформлен в штат)

CheckCodePipe

Метод для проверки СМС-кода, полученного курьером при запросе авторизации

AttachFile

Метод для передачи файла в Альфа-Банк. Необходимо вызывать для каждого файла, который планируется передать.

ChangeStatus

Метод для изменения статуса заявки в Альфа-Банк. Продвигает заявку на Открытие счета далее по процессу. Обычно его необходимо вызывать при завершении процесса на стороне партнёра, чтобы продвинуть заявку на Открытие счета с шага ожидания.

AttachNote

Метод для передачи комментария в Альфа-Банк. Необходимо вызывать для каждого файла, который планируется передать.

Порядок вызова

Для партнёров-курьеров с целью осуществления курьерской доставки

Вызов GetAttachedFiles -> Цикл по каждому файлу GetAttachedFileConent->Процесс в курьерском ПО->Встреча с клиентом и сверка документов->Заверение документов AuthorizePipe->Ввод кода-пароля в курьерском ПО->Отправка пароля на проверку CheckCodePipe->Фотографирование файла в курьерском ПО->Вызов AttachFile по каждому прикладываемому файлу-> Вызов ChangeStatus Сервис AttachNote может вызываться в любом месте вашего процесса.

Обработка ошибок

Внимание! В случае ошибок сервиса, отличных от внутренних ошибок сервера (Код 500), ответ будет содержать код 200/400, а также структуру, содержащую информацию об ошибке:

"errorInfo":
{
 "errorCode": "001"
"errorString":"Текст ошибки"
}

Что мы ждём от партнёра

Необходимо организовать на своей стороне сервис deliveryapi/order#POST с определенной нами структурой данных для создания заявки на курьерскую доставку

Ожидаемые коды ошибок при создании заявки Альфа-Банком в курьерской службе: | Код ошибки | Текст ошибки | | ------------- | ------------- | | 003 | Ошибка авторизации | | 004 | Не указан идентификатор | | 007 | Массив входящих данных пуст | | 008 | Ошибка данных: отсутствует или не заполнено поле {ИМЯ ПОЛЯ} | | 009 | Заявка с таким идентификатором у заданного партнера уже есть | | 011 | Ошибка геокодирования адреса |

0
No votes yet

NFS Transfer (1.0.2)

API позволяет Партнеру передавать информацию о совершенной поездке в рамках нефинансовых сервисов

0
No votes yet

Единый веб-сервис проверок. (1.2.0)

Описание схемы работы API.

Для осуществления проверки необходимо добавить её в массив checks в теле запроса, вписав название в поле checkName. Названия проверок приведены в таблице ниже:

Название Описание
WSConsumerSubjectInfoGet Получение данных о субъекте из мастер-системы, хранящей оперативную клиентскую информацию
WSCodeInvalidIdentityCard Проверка клиента через сервис недействительных паспортов
WSCustomerBankruptcyInfo Проверка клиента через сервис банкротств
WSCustomerReputationRisk Проверка клиента через сервис репутационных рисков
WSCustomerTerrorism Проверка клиента на присутствие в базах, причастных к терроризму
WSGlobalSearch Проверка клиента на возможность получения лизинга
WSResultSOZSalaryProject Проверка клиента на благонадежность в зарплатном проекте
WSCustomerComplianceCheckGet Осуществление проверки блокировок по черным спискам

На вход в Единый сервис проверок (ЕСП) передаются следующие данные:

Параметр Расшифровка Комментарий
exs Код внешней системы
Блок checks.checkName Имя сервиса См. предыдущую таблицу по названиям проверок
Блок checks.isToCall Вызывать или нет true - вызывать, false - не вызывать
idg Код системы Необходим для вызова проверки WSCustomerComplianceChecks
chklst Код проверки Необходим для вызова проверки WSCustomerComplianceChecks. Если необходимо выполнить несколько проверок, то перечисляются через запятую без пробелов, например, "chklst":"N04,S01,C02"
cus Идентификатор клиента
fnm1 Фамилия
fnm2 Имя
fnm3 Отчество
dtbr Дата рождения
ucd Тип документа, удостоверяющего личность (ДУЛ)
ser Серия ДУЛ
num Номер ДУЛ
dopn Дата выдачи ДУЛ
edt Дата окончания ДУЛ
ucdoТип старого ДУЛ Временно не используется
sero Серия старого ДУЛ Временно не используется
numo Номер старого ДУЛ Временно не используется
crf ИНН ЮЛ/ФЛ
fior СНИЛС
cod
ecs Описание вызывающей системы
cban Код блокировки

Приняты следующие коды результатов проверок (указываются в checks/имя проверки/result):

Код проверки Расшифровка
E Проверка не выполнялась
N Проверка успешна (клиент НЕ является банкротом, НЕ имеет недействительный паспорт и т.п.)
Y Проверка неуспешна (клиент является банкротом, имеет недействительный паспорт и т.п.)

Возможные сообщения:

  • Возможные сообщения по сервисам WSCustomerComplianceCheckGet, WSCodeInfvalidIdentityCard, WSCustomerBankruptcyInfo, WSCustomerReputationRisk, WSCustomerTerrorism, WSCunsumerSubjectInfoGet
Код Описание
KSM0006 Входная переменная не найдена
PBC0999 Ошибка выполнения оператора SQL
PBS0000 Результат не определен
PBS0001 Дата актуализации действительная
PBS0002 Дата актуализации не действительная
PBS0003 Дата действия доверенности УЛ не истекла
PBS0004 Дата действия доверенности УЛ истекла
PBS0005 Паспорт клиента РФ действителен
PBS0006 Паспорт клиента РФ не действителен
PBS0007 Срок действия паспорта РФ не истек
PBS0008 Срок действия паспорта РФ истек
PBS0009 Срок действия загранпаспорта не истек
PBS0018 Найдено полное соответствие в списке репутационных рисков
PBS0019 Найдено частичное соответствие в списке репутационных рисков
PBS0020 Соответствие не найдено в списке репутационных рисков
PBS0021 Найдено полное соответствие в списке террористов\экстремистов
PBS0022 Найдено частичное соответствие в списке террористов\экстремистов
PBS0023 Соответствие не найдено в списке террористов\экстремистов
PBS0025 Найдено соответствие в списке репутационных рисков ЮЛ/ИП
PBS0027 Действующих рисков не обнаружено
PBS0047 Найдено полное соответствие в санкционном списке
PBS0049 Санкционные коды риска не найдены
PBS0100 Недостаточно входных параметров
PBS0101 Некорректные входные парам
WSE9999 Ошибка установки соединения
  • Возможные сообщения по сервису WSGlobalSearch
Код Описание
0 Нет ошибок
1 Авторизация не пройдена
2 Нет данных для авторизации
3 Отсутствует ИНН ЮЛ
4 Отсутствует информация о ФЛ (ФИО и день рождения или номер документа удостоверяющего личность)
5 Возникла ошибка при проверке ЮЛ по ИНН
6 Возникла ошибка при проверке ФЛ по ФИО и день рождения
7 Возникла ошибка при проверке ФЛ по ДУЛ
8 ИНН менее 10 символов
9 Размер документа удостоверяющего личность отличен от 10 символов
  • Возможные сообщения по сервису WSResultSOZSalaryProject
Код Описание
0 Нет ошибок
1 Авторизация не пройдена
2 Нет данных для авторизации
3 Отсутствует ИНН ЮЛ
4 По данному ЮЛ присутствует запрос в работе
5 Возникла ошибка при поиске сведений об ЮЛ
6 У запроса истек срок действия заключения Службы экономической безопасности
7 По данному ЮЛ в Cистеме обработки заявок отсутствует запрос
  • Список возможных ошибок.
  1. Некорректный запрос:
    • HTTP код: 400
    • { "httpCode": "400", "httpMessage": "Bad Request", "moreInformation": "Error description" }
  2. Некорректный заголовок x-ibm-client-id:
    • HTTP код: 401
    • { "httpCode": "401", "httpMessage": "Unauthorized", "moreInformation": "Application is not registered with mutual tls" }
  3. Не предоставлен разрешенный сертификат:
    • HTTP код: 401
    • { "httpCode": "401", "httpMessage": "Unauthorized", "moreInformation": "Invalid client certificate is provided" }
  4. Ошибка валидации:
    • HTTP код: 422
    • { "httpCode": "422", "httpMessage": "Invalid", "moreInformation": "Validate REST: ... ." }
  5. Внутренняя техническая ошибка:
    • HTTP код: 500.
    • {"Error": { "ErrorCode": 0, "ErrorString": "WSTechnicalException", "ErrorTrace": "Error trace" }}
  6. Внутренняя техническая ошибка:
    • HTTP код: 500
    • { "httpCode": "500", "httpMessage": "Internal Server Error", "moreInformation": "Error description" }
  7. Система Единый веб-сервис проверок недоступна:
    • HTTP код 500 -{ "httpCode": "500", "httpMessage": "URL Open error", "moreInformation": "Could not connect to endpoint" }
  • Примеры запросов:

Пример 1:

{ "exs": "WBI_ZP", "checks": [ {

  "checkName": "WSCustomerBankruptcyInfo", 
  "isToCall": "true" 

}, {

  "checkName": "WSCustomerComplianceCheckGet", 
  "isToCall": "true" 

}, {

  "checkName": "WSConsumerSubjectInfoGet", 
  "isToCall": "true" 

}, {

  "checkName": "WSGlobalSearch", 
  "isToCall": "true" 

}, {

  "checkName": "WSCodeInvalidIdentityCard", 
  "isToCall": "true" 

}, {

  "checkName": "WSCustomerReputationRisk", 
  "isToCall": "true" 

}, {

  "checkName": "WSResultSOZSalaryProject", 
  "isToCall": "true" 

}, {

  "checkName": "WSCustomerTerrorism", 
  "isToCall": "true" 

} ],

"idg": "123456", 
"cus": "AAAAAA", 
"fnm1": "Familiya", 
"fnm2": "Imya", 
"fnm3": "Otchestvo", 
"dtbr": "1979-12-31", 
"ucd": "001", 
"ser": "1", 
"num": "1", 
"ucdo": "01", 
"sero": "11AA", 
"numo": "222333", 
"crf": "123456789012", 
"fior": "12345678900",
"chklst":"N04,S01,C02",
"customerType":"FL"

}

Пример 2:

{ "exs": "WBI_ZP", "checks": [
{

  "checkName": "WSCustomerComplianceCheckGet", 
  "isToCall": "true" 

}, {

  "checkName": "WSCodeInvalidIdentityCard", 
  "isToCall": "true" 

}, {

  "checkName": "WSCustomerReputationRisk", 
  "isToCall": "true" 

} ],

"fnm1": "Familiya", 
"fnm2": "Imya", 
"fnm3": "Otchestvo", 
"ucd": "001", 
"ser": "2351", 
"num": "666555", 
"chklst":"N04"
"customerType":"FL"

}

0
No votes yet

Выдача кредитных карт (1.0.6)

API позволяет партнеру осуществлять выдачу кредитной карты Альфа-Банка.


1. Бизнес-описание процесса, логику которого реализует API

  1. Физическое лицо (клиент / не клиент банка) приходит в точку партнера, с которым заключен договор сотрудничества, получает предложение от менеджера торговой точки оформить кредитную карту Альфа-Банка.

  2. В случае согласия физическое лицо подписывает согласие на обработку персональных данных, передает сотруднику партнера свой паспорт, позволяет менеджеру торговой точки сфотографировать себя.

  3. Менеджер ТТ вводит персональные данные клиента, необходимые для отправки короткой заявки в банк, используя "Кредитный брокер партнера", после чего информация поступает в Альфа-Банк на короткий скоринг. Метод POST /applications/.

  4. По персональным данным короткой заявки происходит проверка, является ли данное физическое лицо существующим клиентом, производится короткий скоринг.

  5. В случае одобрения результат скоринга отправляется в "Кредитный брокер партнера" и менеджер ТТ может продолжить заполнение заявки физического лица. В случае отказа результаты скоринга предаются в " Кредитный брокер партнера" и процесс завершается. Метод GET /applications/{appId}/scorings/short.

  6. Менеджер ТТ партнера заполняет дополнительные поля для полной заявки, прикладывает фото клиента, скан-образы основной страницы паспорта клиента, страницы паспорта с адресом регистрации, согласие на обработку персональных данных по форме партнера к заявке.

  7. Данные полной заявки отправляются в Альфа-Банк. Метод POST /applications/{appId}/full.

  8. После получения персональных данных полной заявки ПО на стороне Альфа-Банка осуществляет отправку данных клиента на полный скоринг. Скан-образы документов отправляются на ручную верификацию.

  9. В случае успешного скоринга и успешной верификации документов, клиенту открывается счет, формируется предложение по кредитной карте и отправляется в "Кредитный брокер партнера". В случае отказа результаты скоринга предаются в "Кредитный брокер партнера" и процесс на этом заканчивается. Метод GET /applications/{appId}/scorings/full.

  10. Если физическое лицо устраивает предложение Альфа-Банка, то менеджер ТТ сканирует/вводит номер штрих-кода, нанесенный на карту, и данные по карте отправляются в Альфа-банк. Метод POST /applications/{appId}/card.

  11. На стороне Альфа-банк а происходит проверка статуса карты, формируются печатные формы документов Анкета-заявление, Индивидуальные условия, Расписка в получении карты, Дополнительное соглашение и передаются в "Кредитный брокер партнера". Методы GET /applications/{appId}/card, GET /applications/{appId}/docs/printForms/required, POST /applications/{appId}/docs/printForms, GET /applications/{appId}/docs/printForms.

  12. Менеджер ТТ партнера распечатывает полученные печатные формы и дает их физическому лицу на подпись в двух экземплярах, один для клиента, один для банка).

  13. Менеджер ТТ партнера сканирует подписанные документы и скан-образы документов отправляются в Альфа-Банк. Метод POST /applications/{appId}/docs/scans/upload.

  14. Скан-образы документов отправляются на верификацию. В случае отрицательного результата верификации в "Кредитный брокер партнера" отправляется информация о том, какие документы необходимо исправить для повторной отправки на верификацию в банк. Метод GET /applications/{appId}/docs/scans/results. При наличии дооформлений документы повторно отправляются методом POST /applications/{appId}/docs/scans/upload.

  15. Если результат верификации документов положительный, то происходит регистрация договора, персонификация карты и на нее перечисляется одобренный лимит. Менеджер ТТ осуществляет выдачу кредитной карты, упакованной в welcome pack, подписанные клиентом документы по кредитному договору.


2. API предоставляет следующий набор методов (нумерацию указывает порядок вызова методов): 0. POST /configurations - осуществляет добавление индивидуальных настроек партнера. (Вызывается один раз с параметрами по умолчанию для тестовой среды, для промышленной отдельно настраивается под каждоо партнера)

  1. POST /applications/ - позволяет отправить короткую заявку клиента.

  2. GET /applications/{appId}/scorings/short - позволяет получить результат скоринга по короткой заявке.

  3. POST /applications/{appId}/full - позволяет дозаполнить заявку полными данными.

  4. GET /applications/{appId}/scorings/full- позволяет получить результат скоринга по полной заявке.

  5. GET/applications/{appId}/offers/ - позволяет получить список предложений по заявке.

  6. POST /applications/{appId}/offers/{offerId}/select - позволяет выбрать предложение из списка.

  7. POST /applications/{appId}/offers/{offerId}/deselect - позволяет отменить выбор предложения.

  8. POST /applications/{appId}/card - позволяет отправить штрих-код на карте на проверку в банк.

  9. GET /applications/{appId}/card - позволяет получить результат проверки карты.

  10. GET /applications/{appId}/docs/printForms/required - позволяет получить список обязательных документов.

  11. POST /applications/{appId}/docs/printForms - позволяет запросить генерацию печатных форм для заявки.

  12. GET /applications/{appId}/docs/printForms - позволяет получить результат генерации печатных форм.

  13. POST /applications/{appId}/docs/scans/upload - позволяет закрузить сканы печатных форм.

  14. GET /applications/{appId}/docs/scans/results - позволяет получить результаты проверки загруженных сканов.

  15. POST /applications/{appId}/issuance/confirm - позволяет подтвердить выдачу карты на руки клиенту.

  16. POST /applications/{appId}/cancel - позволяет отменить заявку. Запрос может быть отправлен сразу после создания короткой заявки в любой момент процесса для отмены обработки заявки до запроса POST/applications/{appId}/issuance/confirm, который означает завершение обработки заявки партнером


3. Возможные коды ошибок:

  • 400 Badrequest - Некорректный запрос со стороны партнера, не прошедший валидацию.

  • 403 Access denied - Доступ к заявке запрещен, некорректный X-IBM-Client-Id,x-ibm-client-secret или partnerName, appId или порядок вызова методов нарушен.

  • 409 Incorrect status - статус заявки не позволяет выполнить текущий запрос

  • 500 Partner is not registered in OES - Партнер не зарегистрирован в OES.


4. Справочная информация по процессу:

  • В случае если по необязательным полям нет информации,они не должны пристутствовать в теле запроса.

  • При дозаполнении заявки (/applications/{appId}/full) необходимо приложить документы: 1. главная страница паспорта, 2. страница паспорта с адресом регистрации, 3. согласие на обработку персональных данных по форме партнера, 4. фото клиента.

  • У сотрудника ТТ есть 4 часа на ввод ШК карты, иначе заявка откажется на стороне банка.

  • Если штрих-код карты не прошёл проверку, можно попробовать ещё раз.

  • Запрос на генерацию ПФ выполняется 1 раз.

  • После завершения генерации печатных форм у сотрудника есть 4 часа на отправку сканов на проверку.

  • При первой отправке ПФ по заявке необходимо отправить весь комплект документов одним запросом.

  • При повторной отправке ПФ необходимо отправить только документы с отказами.

0
No votes yet

Entry score API (1.0.2)

Сервис для комплаенс пре-скоринга клиента при открытии ему расчетного счета

Модель комплаенс пре-скоринга оценивает вероятность возникновения комплаенс мер в течение года с момента прихода клиента в банк.

Для оценки различных типов клиентов используются отдельные ресурсы:

  • /ie/score для ИП, 12-значный ИНН.
  • /llc/score для компаний (ООО), 10-значный ИНН.

Скоринг производится для каждого запроса к API, поэтому значение может меняться с течением времени, т.е. значения, рассчитанные, например, в январе и феврале, могут отличаться.

Полученное значение скоринга обычно относится к одной из трех категорий: зеленая, желтая или красная. Категории определяют какое решение рекомендуется вынести по данному клиенту и какие бизнес-действия с ним стоит предпринять. Величины и действия могут быть различными для разных партнеров банка, поэтому, пожалуйста, свяжитесь насчет данных категорий с вашим партнерским менеджером от Банка или командой поддержки данного комплаенс-сервиса (scoring_openapi_support@alfabank.ru).

Коды ошибок

Основные коды ошибок, возвращаемые API.

Код ошибки Описание
#1000 ИНН является валидным, но компания с данным ИНН не найдена в базе ФНС.
#1001 Запрос не передал тело запроса в формате JSON. Проверьте заголовки и тело запроса.
#1002 Переданное тело запроса не является валидным JSON объектом. Проверьте тело запроса.
#2001 Не удалось получить данные от поставщика данных из ФНС. Попробуйте позднее.
#2002 Ошибка в процессе скоринга. Если ошибка повторяется, пожалуйста обратитесь к поддержке данного API
0
No votes yet

Расширенные лиды (1.1.1)

Extended-leads-api

Данный сервис предназначен для приема расширенных лидов от различных партнеров банка. Расширенный лид - контактные данные клиента (т.е. лид), а в некоторых случаях также и его дополнительные данные. Сервис сохраняет загруженные лиды и далее направляет лиды по необходимым бизнес-процессам банка (обзвон Клиентов сотрудниками Колл-центра, запуск оформления кредитной карты, скоринг Клиента и т.д.)

Возможные коды ошибок:

  1. Произошла внутренняя ошибка:

    • Код 500
    • Exception.class
    • HttpStatus.INTERNAL_SERVER_ERROR
  2. Некорректное сохранение данных в БД (в данном случае откатывается вся транзакция):

    • Код 500
    • IncorrectBatchUpdateException.class
    • HttpStatus.INTERNAL_SERVER_ERROR
  3. Направленные данные (поля) не проходят валидацию:

    • Код 400
    • ConstraintViolationException.class
    • HttpStatus.BAD_REQUEST
  4. Неизвестный источник данных (x-apicHeaderSource):

    • Код 400
    • UnknownSourceException.class
    • HttpStatus.BAD_REQUEST
  5. Превышен дневной лимит для данного источника:

    • Код 400
    • LimitExceededException.class
    • HttpStatus.BAD_REQUEST
0
No votes yet

()

0
No votes yet

Сервис списания денежных средств с заемщика (1.1.0)

Сервис предназначен для реализации прямого списания денежных средств кредитором с организации, являющейся заемщиком по заранее выданному долгосрочному согласию.

Термины и определения

Согласие - сущность, которую должен создать в сервисе Партнер, чтобы зарегистрировать выданный займ и зафиксировать реквизиты Партнера, на которые возможен возврат займа.

Оферта - Перечень действий, которые Клиент разрешает выполнять приложению Партнера. Оферта создается при подписании Клиентом длительного поручения Банку в момент начала работы с Партнером.

Счет займа - (в контексте данного сервиса) счет заемщика, на который был зачислен займ.

Платежное поручение (ПП) - платежный документ, создаваемый Банком в момент вызова Партнером сервиса списания денежных средств, на основании длительного поручения Клиента, зафиксированного в Оферте.

Есть некоторые условия работы Партнера с данным сервисом

  • в назначении кредитного транша должен присутствовать 'service Id: transactionId', где transactionId - уникальный идентификатор, присваиваемый траншу Партнером;
  • в оферте Партнеру должно быть выдано разрешение на списание средств заемщика и на получение статуса платежного поручения.

Pages