Перейти к основному содержимому

Клиенты

Для работы с клиентами вам потребуется разрешение ReadCustomerData.

Клиент — это компания, подключённая к вашему доступу в API. У одного доступа может быть несколько клиентов: например, если вы обслуживаете несколько своих юрлиц или ИП.

Каждому клиенту соответствует уникальный код — customerCode, строка из 9 символов. Это один из ключевых идентификаторов в API. Он передаётся в большинство методов, чтобы банк понимал, по какой именно компании выполнять запрос на просмотр балансов, формирование выписки, создание платёжных ссылок или QR-кодов.

Какие методы есть​

  • Get Customers List — это метод для получения списка всех подключённых компаний. По каждой приходит customerCode и основные реквизиты.
  • Get Customer Info — это метод для получения подробной информации по одной компании. В запросе передаётся customerCode нужного клиента.

Полное описание полей, примеры запросов и ответов можно найти на страницах этих методов в разделе «Методы».

С чего начать​

Получение клиента — обычно самый первый шаг интеграции, потому что почти все остальные методы требуют customerCode.

  1. Вызовите Get Customers List и найдите нужную компанию
  2. Сохраните её customerCode — он понадобится в дальнейших запросах: счета, балансы, выписки, платежи, эквайринг, СБП
  3. При необходимости запросите детальную информацию по компании методом Get Customer Info

Какие данные приходят по клиенту​

В ответе по каждой компании возвращаются основные реквизиты:

  • customerCode — уникальный код клиента (используется в других методах)
  • customerType — тип клиента: Business (юридическое лицо) или Personal (физическое лицо)
  • isResident — признак резидента
  • taxCode — ИНН
  • kpp — КПП, есть только у юрлица
  • customerOgrn — ОГРН / ОГРНИП
  • fullName — полное наименование
  • shortName — краткое наименование, передаётся при наличии

Что важно знать​

  • customerCode — строка длиной из 9 символов. Указывается во многих методах API, поэтому его удобно сохранить сразу после первого запроса.
  • Во всех запросах необходимо использовать компании с customerType: "Business".
cовет

customerCode часто нужен вместе с accountId - это идентификатор счёта. Получить счета компании можно методами из раздела Счета.