API-платформа
Начать
1. Добро пожаловать
НОВЫЙ! Общественность Кросс-Ривер с готовыми запросами на коллекцию Cross Postman
Река. конечные точки API
Добро пожаловать в Кросс-Ривер документация
Откройте для себя, изучите и начните интегрировать наши продукты с легкостью.
Быстрый старт Просмотреть все продукты
Получать начал
Настройте и начните свой путешествие с использованием API Cross River
Концепции
Узнайте, как решения Cross River могут преобразить ваш финтех-путь
API-интерфейсы
Развиваться с использованием береговой линии реки Кросс
платформа и надежные наборы API
Учебники
Узнайте, как использовать Cross
API River шаг за шагом
2. Быстрый старт
Шаг 1
Шаг 2
Шаг 3
Шаг 4
Получить токен доступа
Использовать токен доступа
Построить Sampле приложение
Получить учетные данные API: Ваш первый шаг к работе с API Cross River — регистрация для получения учетных данных API.
Получить токен доступа: После получения учетных данных API и перед тем, как вы сможете использовать наши API, вам необходимо получить токен доступа с помощью клиент_id и клиент_секрет который вы получили при регистрации.
Использовать токен доступа: После успешной аутентификации, access_token возвращается вам. Включите этот токен в заголовок вызовов API.
Webкрючки: WebХуки — важный компонент любой интеграции с Cross River. API позволяют запрашивать данные по запросу, webХуки отправляют обновления в режиме реального времени непосредственно в вашу систему, устраняя необходимость в постоянном опросе и сокращая задержку.
Песочницы: Песочница — это полностью изолированная среда, поэтому не стесняйтесь
2.1. Получить учетные данные API
Шаг 1
Получить учетные данные API
Шаг 2
Получить токен доступа
Шаг 3
Использовать токен доступа
Шаг 4
Построить Sampле приложение
Первым шагом к работе с API Cross River является регистрация для получения учётных данных API. С этими данными вы можете запросить и получить токен доступа для отправки API в нашей тестовой среде.
ВАЖНЫЙ
Ваш IP-адрес, который должен быть публичным и статическим, должен быть в нашем списке разрешённых. Ваш внутренний ИТ-отдел должен иметь возможность предоставить вам этот IP-адрес. Узнайте больше о статических IP-адресах.
SandboxAccess
Подать запрос для доступа к песочнице, для получения учетных данных API.
Как только ваш статический IP-адрес будет добавлен в наш белый список, мы отправим вам 2 зашифрованных письма с вашими учетными данными:
Одно письмо содержит ваше клиент_id , партнер_id и другая информация, которая вам понадобится в зависимости от вашего запроса.
Второе письмо, которое зашифровано, содержит ваши клиент_секрет и webhook_secret . Они понадобятся вам для аутентификации и работы в песочнице.
ПРИМЕЧАНИЕ
Если вы запросили доступ к платежам по карте, вы получите дополнительный набор учетных данных, включая второй клиент_id и клиент_секрет
2.2. Получить токен доступа
Шаг 1
Получить учетные данные API
Шаг 2
Получить токен доступа
Шаг 3
Использовать токен доступа
Шаг 4
Построить Sampле приложение
Cross River использует OAuth 2.0 для аутентификации и авторизации. Это контролирует доступ к нашей системе и гарантирует, что доступ к нашим API и другим защищённым ресурсам имеют только авторизованные пользователи. Информация, которую вы вводите в нашу систему аутентификации, конфиденциальна и не может быть доступна другим приложениям Cross River.
После получения вашего API, прежде чем вы сможете использовать наши API, вам необходимо получить учетные данные API. токен доступа с использованием клиент_id и клиент_секрет Вы получили его при регистрации. Этот токен доступа позволяет безопасно отправлять информацию в виде JSON-объекта для использования в наших API. Необходимо включить этот токен в заголовок каждого запроса API.
Существует несколько способов запросить и получить токен доступа:
Используйте интерфейс командной строки (CLI) с cURL или любой другой язык
Используйте Postman или любой другой инструмент тестирования API.
После получения скопируйте токен доступа в буфер обмена. Обязательно сохраните его.
CommandLineInterface
Чтобы запросить токен, отправьте POST-подключение/токен команда, содержащая клиент_id и клиент_секрет и тип_гранта к (серверу аутентификации) сервера аутентификации соответствующую песочницу, как показано на рисункеampниже.
Обратитесь к разделу для объяснения этих tags. Таблица компонентов HTTP
Следующий примерample использует cURL для запроса токена у одного из серверов авторизации.
Sampзапрос le в cURL для COS
curl –location –request 'POST https://idptest.crbcos.com/connect/token' \ –header 'Content-Type: application/x-www-form-urlзакодировано' \ -данные-urlшифровать 'client_id=[ваш идентификатор здесь]' \
-данные-urlшифровать 'client_secret=[ваш секрет здесь]' \
-данные-urlшифровать 'grant_type=client_credentials' \
-данные-urlшифровать 'audience=https://api.crbcos.com/'
Sample ответ от cURL запрос
{ «токен_доступа»: «содержит много символов», \
«expires_in»: 86400, \
«тип_токена»: «Носитель» }
Почтальон
Чтобы запросить токен с помощью Postman, отправьте POST-подключение/токен команда к аутентификация сервер соответствующей песочницы. Добавьте тип_гранта , область применения (необязательно) ,
клиент_id и клиент_секрет на вызов.
Обратитесь к разделу для объяснения этих tags. Таблица компонентов HTTP
Если аутентификация прошла успешно, код статуса — 200 (ОК).
COSExplorer
В , нажмите стрелку вниз рядом с вашим логином и нажмите Копировать токен доступа. COS Explorer
Токен доступа копируется в буфер обмена и готов к использованию в песочнице.
Ответ на запрос токена
Описание атрибута
|
доступ_к кен |
JSON с цифровой подписью web токен (JWT), отправленный с сервера oAuth, который позволяет получить доступ к определенным ресурсам Cross River |
|
объем |
Диапазон услуг, к которым пользователь может получить доступ |
|
expires_i n |
Время до истечения срока действия токена. – Наша команда по интеграции сообщит вам о сроке действия, или вы также сможете декодировать свой токен доступа. – Мы рекомендуем вам получить новый токен доступа незадолго до истечения срока действия старого токена. – Повторно используйте токены в течение всего срока их действия, а не получайте новый токен для каждого вызова одного и того же защищенного ресурса (API). ВАЖНЫЙ: Никогда не декодируйте свой токен на публично размещенном сервере. webсайт |
тип токена
Токен на предъявителя
HTTP-компоненты
Следующие HTTP-компоненты используются как в запросах API, так и в запросах Postman.
HTTP
компонент
Tag Описание
|
Конечная точка |
ПОЧТА /connect/toke n |
Конечная точка для получения токена доступа |
|
Заголовок |
содержание тип |
приложение/x-www-form- urlзакодированный |
|
Тело |
клиент_id |
Уникальный идентификатор клиента |
|
Тело |
клиент_секрет т |
Зашифрованная строка символов, используемая для подписи и проверки идентификационных токенов. Важный: Секреты не восстанавливаются с помощью CR. В случае потери секрета необходимо сгенерировать новый. Не Передавайте свои секреты в систему контроля версий. |
|
Тело |
тип_гранта |
Это поле всегда будет иметь значение учетные данные_клиента |
|
Тело |
аудитория необязательный |
Способ, позволяющий пользователю проверить, предназначен ли ему конкретный токен доступа. |
|
Тело |
объем необязательный |
Определенный диапазон или ограниченный набор услуг, к которым пользователь может получить доступ с помощью токена доступа. Если область действия не указана, возвращаемый токен будет содержать все области действия, связанные с вашими учетными данными. Примечание: В одном запросе можно отправить несколько областей, добавив пробел между именами каждой области. Например:ample: 'scope=scope1scope2scope3' |
Авторизационный серверURLs
Модуль сервера аутентификации URL
|
Счета |
https://idptest.crbcos.com/connect/token |
|
АЧХ |
https://idptest.crbcos.com/connect/token |
|
Провода |
https://idptest.crbcos.com/connect/token |
|
Проверки |
https://idptest.crbcos.com/connect/token |
|
Основной |
https://idptest.crbcos.com/connect/token |
|
Мгновенные платежи |
https://idptest.crbcos.com/connect/token |
|
Выпуск карты |
https://idptest.crbcos.com/connect/token |
|
Карточные платежи |
https://crbcos-sandbox.auth0.com/oauth/token |
Кредитование https://oauthtest.crbnj.net/connect/token
Поиск неисправностей
Если токен аутентификации действителен, будет возвращен код 200. Если токен аутентификации недействителен, будет возвращен код 401.
Если вы не можете получить токен на предъявителя и не получали его ранее:
Подтвердите URL.
Проверьте, что клиент_id и клиент_секрет введены правильно. Они чувствительны к регистру.
Проверьте свой клиент_id и клиент_секрет Совпадения с полученным вами. Убедитесь, что нет проблем с сетью или разрешённым списком.
Свяжитесь с нашей командой по интеграции, если ваша учетная запись заблокирована в результате 3-кратного неверного входа в систему. попытки.
2.3. Использовать токен доступа
Шаг 1
Получить учетные данные API
Шаг 2
Получить токен доступа
Шаг 3
Использовать токен доступа
Шаг 4
Построить Sampле приложение
После успешного прохождения проверки вы получите токен доступа. возвращается вам. Включайте аутентифицированный этот токен в заголовке ваших вызовов API.
Токен доступа истекает через заданный период времени. В ответе, содержащем токен, также указывается время истечения срока действия в секундах. Сохраните и используйте свой токен доступа до истечения срока его действия. Мы рекомендуем использовать токен до получения ошибки 401 «Неавторизованный доступ», а затем запросить новый токен.
ВАЖНЫЙ
1. Не запрашивайте новый токен для каждого запроса API.
2. Обязательно защитите свой токен. Любой, кто украдет ваш токен, сможет выдавать себя за вашего клиента в течение всего срока его действия.
API-заголовок запроса
В заголовок каждого запроса API включите токен доступа следующим образом:
Sample call for wire payment in cURL
curl –location –request 'POST https://sandbox.crbcos.com/Wires/v1/payments' –header 'Авторизация: Предъявитель [ВАШ ТОКЕН ЗДЕСЬ]' \
–header 'Content-Type: application/x-www-form-urlзакодировано' \
–data-raw '{
«номер счета»: «2255685659»,
«businessFunctionCode»: «CTR»,
«receiverRoutingNumber»: «021000021»,
«бенефициарFi»: {
«idCode»: «F»,
«идентификатор»: «021000021»,
«имя»: «JP Morgan Chase»
},
«бенефициар»: {
«idCode»: «D»,
«идентификатор»: «123456789»,
«имя»: «Питер Гриффин»
},
«Ссылка на бенефициара»: «XYZ123»,
«сумма»: 10000,
«цель»: «оплата»
}'
Почтальон
Чтобы использовать токен в Postman, перейдите к Авторизация вкладку в вашем запросе, выберите Токен на предъявителя В качестве типа аутентификации и вставьте свой токен в соответствующее поле. Postman автоматически добавит Предъявитель префикс и токен к Токен поле.
2.4. Webкрючки
WebХуки — важный компонент любой интеграции с Cross River. API позволяют запрашивать данные по запросу, webХуки передают обновления в режиме реального времени непосредственно в вашу систему, устраняя необходимость в постоянном опросе и сокращая задержку. Во многих случаях webХуки более эффективны и надежны, чем API, используемые отдельно, гарантируя синхронизацию вашего приложения с критически важными событиями, такими как изменения в счетах, обновления транзакций и результаты обработки.
Использовать webХуки в системах Кросс-Ривер для уведомления о различных событиях. Событие возвращает объект ресурса, содержащий релевантную информацию о теме каждого события. Полная информация о событии включается в систему и отправляется в неё.
Мы используем webхуки для обновления статуса и сообщения об изменениях в транзакциях. WebХуки отправляют в вашу систему уведомления в режиме реального времени, когда происходит событие.
Для использования необходимо зарегистрироваться через API. webкрючки:
Регистрация для получения счетов, карт и платежных событий
Зарегистрируйтесь на мероприятия по оплате картой
Зарегистрируйтесь на мероприятия по кредитованию
2.5. Песочницы
Наша песочница — это полностью изолированная среда, поэтому экспериментируйте свободно. Когда будете готовы перейти в производственную среду, сообщите нам, и мы предоставим вам учётные данные для доступа к рабочей среде.
Управление клиентами
Модуль База URL для вызовов API
Управление клиентами https://sandbox.crbcos.com/core/ Счета
Модуль База URL для вызовов API
Депозитные счета
|
https://sandbox.crbcos.com/core/ |
Депозитные зачистки https://sandbox.crbcos.com/sweepsintrafi/ Карты
Модуль База URL для вызовов API
Карты https://sandbox.crbcos.com/cardmanagement/Платежи
Модуль База URL для вызовов API
|
Мгновенные платежи |
https://sandbox.crbcos.com/rtp/ |
|
Платежи по карте: Нажмите, чтобы заплатить |
https://pushtopaystaging.crbnj.net/ |
|
Платежи по карте: Pull |
https://pullfromcardapistg.crbnj.net/ |
|
Международные платежи |
https://sandbox.crbcos.com/international/ |
|
АЧХ |
https://sandbox.crbcos.com/ach/ |
|
Провода |
https://sandbox.crbcos.com/wires/ |
Проверки https://sandbox.crbcos.com/checks/ КОСwebкрючки
Модуль База URL для вызовов API
КОС webкрючки
https://sandbox.crbcos.com/webhooks/
Кредитование
Модуль База URL для вызовов API
Оформление кредита
|
https://arixapisandbox.crbnj.net |
Принятие решения по заявке https://lendingsandbox.crbcos.com/preapproval/v1
2.6. Коллекция почтальона
Чтобы упростить разработку, мы собрали готовые решения
Коллекция почтальона Запросы для всех Кросс-Ривер. Используйте эту коллекцию для изучения, тестирования и создания конечных точек API. Ваша интеграция непосредственно в Postman. Требуется минимальное дополнительное кодирование и настройка. Чтобы немедленно создать копию нашей коллекции, нажмите
Просто заполните информацию о настройке и начните совершать звонки в коллекции Sandbox Postman. через .
Почтальон
Токен доступа (на предъявителя)
Мы создали песочницу для разработчиков Postman, чтобы обеспечить безопасное пространство для тестирования API Cross River. В коллекции Cross River Postman аутентификация осуществляется с помощью токена-предъявителя.
Чтобы получить идентификаторы, вам необходимо настроить токен доступа (предъявителя), необходимый для запуска сбора:
1. : С помощью этих учетных данных вы запрашиваете и получаете токен доступа
Получить учетные данные API
для использования при отправке API в нашей среде песочницы
2. : После того, как вы получите свои учетные данные API и прежде чем вы сможете использовать наши
Получить токен доступа
API, вы получаете токен доступа, используя клиент_id и клиент_секрет который вы получили при регистрации.
Коллекция Форк Кросс Ривер
Перейдите прямиком к нам, чтобы разделить нашу коллекцию.
Рабочее место почтальона
После разветвления не забудьте установить переменные среды для песочницы.
Настройте свою среду Postman
Чтобы использовать только что созданную коллекцию, перейдите к ней и нажмите Окружающая среда, и выберите ПесочницаСкопируйте свой идентификатор клиента Cross River и секретный код клиента и вставьте их в client_Id и клиент_секрет Для оплаты картой вставьте их в поле ptpe_client_id и ptpe_client_secret поля.
Теперь вы готовы получить токен и начать отправлять запросы.
1. Бегать Авторизация/Получение токена Чтобы сгенерировать токен. Для оплаты картой выполните Оплата картой/Авторизация/Получение токена P2PE .
2. Переменная {{token}} (или ptpe_token (для карточных платежей) автоматически добавляется в вашу среду скриптом Post-Reply. По истечении срока действия токена вам необходимо будет повторно выполнить шаг 1.
3. В зависимости от того, какую конечную точку вы используете, вам может потребоваться заполнить несколько переменных. Например,ampле, партнер_id , идентификатор_продукта , configuration_id и перезвонить_url .
4. Есть также некоторые переменные, которые заполняются через скрипты, такие как токен и ptpe_token которые не следует заполнять вручную.
Pingthesandbox
Запустите простой тест, чтобы убедиться, что вы можете подключиться к песочнице Cross River.
Чтобы отправить запрос Ping, в Postman откройте Коллекции > Коллекция API Cross River > Авторизация и запустить Пинг конечная точка.
Запросы на изменение
Чтобы обновить запрос, внесите изменения на Тело таб. Значения в формате double curlСкобки y извлекают данные из переменных окружения. Проверьте наши документы API, чтобы узнать, какие поля...
конечная точка принимает, и view запросы на предпочитаемом вами языке.
3. Построить какample app
Шаг 1
Получить учетные данные API Настраивать
Шаг 2
Получить токен доступа
Шаг 3
Использовать токен доступа
Шаг 4
Построить Sampле приложение
: Прежде чем начать, ознакомьтесь с нашим руководством по быстрому старту, чтобы подключиться к нашим API. Для тестирования вызовов API вы можете использовать cURL из командной строки или с помощью такой службы, как Postman или Swagger в нашей песочнице.
Клиенты и счета
: Прежде чем пользоваться услугами Cross River, вам необходимо создать запись клиента для каждого из ваших клиентов
Карты
: Управляйте картами своих клиентов, совместно с Cross River решив, что именно вы хотите предложить, например физические или виртуальные карты.
Кредитование
: Кредитование включает в себя набор вызовов API кредитования, которые позволяют вам создавать, обновлять, и управляйте своими кредитами.
3.1. Настраивать
Прежде чем начать, ознакомьтесь с нашим руководством по подключению к нашим API. Чтобы протестировать API, выполните следующие действия:
звонки, вы можете использовать cURL из командной строки или с помощью такой службы, как Postman или Swagger в нашей песочнице.
Чтобы создать карту или платежное приложение, необходимо создать клиентов и учетные записи.
Исследуйте песочницу
У нас есть всё для вашего исследования. Песочница — это полностью изолированная среда. из производственной среды, поэтому не стесняйтесь экспериментировать. Когда будете готовы перейти в производственную среду, обратитесь к своему менеджеру по работе с клиентами, который предоставит вам учётные данные для доступа к производственной среде.
Регистр соответствующий web события крючка
WebХуки — важный компонент любой интеграции с Cross River. API позволяют запрашивать данные по запросу, webХуки передают обновления в режиме реального времени непосредственно в вашу систему, устраняя необходимость в постоянном опросе и сокращая задержку. Во многих случаях webХуки более эффективны и надежны, чем API, используемые отдельно, гарантируя синхронизацию вашего приложения с критически важными событиями, такими как изменения в счетах, обновления транзакций и результаты обработки.
Зарегистрироваться получить webПерехват событий. Когда webсобытия-хуки срабатывают, событие объекты отправляются в зарегистрированный URLs.
3.2. Клиенты и счета
Шаг 1
Получить учетные данные API
Шаг 2
Получить токен доступа
Шаг 3
Использовать токен доступа
Шаг 4
Построить Sampле приложение
Создайте запись клиента и финансируемый счет:
Создать запись клиента
Создать депозитный счет
Пополнить счет
Создать запись клиента
Прежде чем воспользоваться услугами Cross River, вам необходимо создать запись клиента для каждого из них.
Ваши клиенты. Процесс адаптации клиентов включает в себя создание запись клиента с соответствующей информацией о клиенте.
Все клиенты автоматически сканируются на предмет соответствия нормативным требованиям, поэтому вам необходимо зарегистрироваться для получения соответствующей информации. webперехватывает события для получения обновлений статуса записей клиентов.
Запись клиента может быть для любого Личный or Бизнес Клиенты. После регистрации клиент может быть связан с одной или несколькими учётными записями.
Webкрючки
Зарегистрироваться для webкрючки. Следующие webкрючки используются:
WebОписание крючка
|
Core.Customer.Onboarded |
Уведомляет вас о создании записи о клиенте. |
|
Core.Customer.Ofac.Changed |
Уведомляет вас об обновлении статуса клиента OFAC |
Core.Customer.PepScan.Chan ged
Nуведомляет вас об обновлении статуса PEP клиента
Exampleof создание записи
В этом бывшемampИтак, мы подключим Джона Смита. Для начала создадим запись клиента. Мы регистрируем Джона как Личный клиент.
Чтобы подключить бизнес-клиента, сначала создайте для него персональную запись клиента. основной владелец этого бизнеса. После этого создайте бизнес-клиента и добавьте его персональную запись в качестве бенефициарного владельца.
1 Вызов POST /core/v1/cm/customers .
В следующем примереample вы можете видеть, что обязательны. какие атрибуты
ВАЖНЫЙ
Мы настоятельно рекомендуем вам включить в заголовок запроса ключ идемпотентности.
для обеспечения дублирующей защиты в случае сбоя.
Curl
curl -X POST /core/v1/cm/customers –header 'Content-Type: application/j {
«partnerId»: “6e80b097-693c-4592-8440-02f345335bbf”,
"имя": {
"имя": "Джон",
"фамилия": «Смит»
},
«классификация»: «Личное»,
«профи»file”: {
«регО»: ЛОЖЬ,
«политически разоблачённое лицо»: ЛОЖЬ,
«taxIdType»: «ССН»,
«taxId»: «119988776»,
"Дата рождения": «1953-09-22»,
«riskRating»: "Низкий"
«primaryAddress»: {
«addressType»: "Дом",
«классификация»: "Жилой",
«isPrimary»: истинный,
«улица1»: «123 Любая улица»,
"город": «Где угодно»,
"состояние": «Нью-Йорк»,
"Почтовый индекс": «12345»,
«код страны»: "НАС"
},
«primaryPhone»: {
«isPrimary»: истинный,
«Тип телефона»: "Дом",
"номер телефона": «2015551234»
},
«primaryEmail»: {
«isPrimary»: истинный,
«emailType»: «Личное»,
"Адрес электронной почты": «John.Smith@xxxxx.com»
}
}
Успешный вызов API возвращает ответ JSON с уникальным идентификатором клиента в первой строке тела ответа. Ваш клиент создан.
Внедрение органа реагирования на запросы клиентов
{
"идентификатор": “9052b6a5-3f09-41d1-b526-ade80104eb79”,
«cifNumber»: «32653745014»,
«классификация»: «Личное»,
"статус": «Активный»,
«Офак»: "В ожидании",
«ПепСкан»: "В ожидании",
"имя": {
"имя": "Джон",
"фамилия": «Смит»,
"полное имя": «Джон Смит»
},
«профи»file”: {
«регО»: ЛОЖЬ,
«политически разоблачённое лицо»: ЛОЖЬ,
«enableBackupWithholding»: ЛОЖЬ,
«taxIdType»: «ССН»,
«taxId»: «119988776»,
"Дата рождения": «1953-09-22»,
«riskRating»: "Низкий"
},
«создано в»: “2021-01-25T17:55:24.4422582-05:00”,
«lastModifiedAt»: “2021-01-25T17:55:24.4432543-05:00”,
«partnerId»: “6e80b097-693c-4592-8440-02f345335bbf”
}
2 The Core.Customer.Onboarded webСобытие-перехват срабатывает при создании записи о клиенте.
Событие, связанное с подключением клиента
{
"идентификатор": “3d9c5e1a-623b-4cf2-812e-ade80105048e”,
«eventName»: «Основной клиент подключен»,
"статус": "В ожидании",
«partnerId»: “30dee145-b6a2-4058-8dc3-ac4000dee91f”,
«создано в»: “2021-11-22T10:50:20.553-05:00”,
«ресурсы»: [
“core/v1/cm/customers/9052b6a5-3f09-41d1-b526-ade80104eb79” ],
"подробности": []
}
Кросс-Ривер проверяет новую клиентскую запись на предмет соответствия требованиям OFAC и PEP.
Иногда результаты сканирования требуют повторногоview нашей командой по борьбе с отмыванием денег (AML).
По завершении сканирования, Core.Customer.Ofac.Changed и
Core.Customer.PepScan.Changed webСобытия-перехваты возвращаются со статусом. Клиенты без проблем с соответствием требованиям показывают Прозрачный статус.
Изменено сканирование OFAC клиента
{
"идентификатор": “45db5592-56ee-41f5-85e7-ade8010571ce”,
«eventName»: «Core.Customer.Ofac.Changed»,
"статус": "В ожидании",
«partnerId»: “30dee145-b6a2-4058-8dc3-ac4000dee91f”,
«создано в»: “2021-11-22T10:51:53.657-05:00”,
«ресурсы»: [
“core/v1/cm/customers/9052b6a5-3f09-41d1-b526-ade80104eb79” ],
"подробности": []
}
Изменено сканирование PEP клиента
{
"идентификатор": “a5000831-3e01-4231-9ec2-ade8010571c5”,
«eventName»: «Core.Customer.PepScan.Changed»,
"статус": "В ожидании",
«partnerId»: “30dee145-b6a2-4058-8dc3-ac4000dee91f”,
«создано в»: “2021-11-22T10:51:53.597-05:00”,
«ресурсы»: [
“core/v1/cm/customers/9052b6a5-3f09-41d1-b526-ade80104eb79” ],
"подробности": []
}
Вы создали запись клиента.
Обновление записи клиента
Можно обновить данные клиента, такие как адрес, номер телефона и адрес электронной почты. Эти данные учитываются начальный Информация. Если вы добавите второй адрес, это вторичный.
1 Используйте идентификатор клиента, возвращенный при создании записи клиента, для вызова POST /core/v1/cm/customers/{id}/addresses добавить. Адрес первого клиента
Адрес, который вы добавляете, это начальный адрес. В следующем примереampле вы можете увидеть, какие атрибуты являются обязательными.
Обновить адрес клиента
POST /core/v1/cm/customers/9052b6a5-3f09-41d1-b526-ade80104eb79/addresse {
«addressType»: "Дом",
«классификация»: "Жилой",
«isPrimary»: истинный,
«улица1»: «123 Любая улица»,
"город": «Где угодно»,
"состояние": «Нью-Йорк»,
"Почтовый индекс": «12345»,
«код страны»: "НАС"
}
2 Вызов POST /core/v1/cm/customers/{id}/phones чтобы добавить
телефон клиента
Первый добавленный вами номер телефона – это начальный номер телефона.
число
Обновить номер телефона клиента
POST /core/v1/cm/customers/9052b6a5-3f09-41d1-b526-ade80104eb79/phones {
«isPrimary»: истинный,
«Тип телефона»: «Мобильный»,
"номер телефона": «2015552345»
}
3 Вызов POST /core/v1/cm/customers/{id}/email для обновления адреса электронной почты клиента.
Обновить адрес электронной почты клиента
POST /core/v1/cm/customers/9052b6a5-3f09-41d1-b526-ade80104eb79/email {
«isPrimary»: истинный,
«emailType»: «Личное»,
"Адрес электронной почты": «john.jones@xxx.com»
}
Создать депозитный счет
CR предлагает ряд различных типов счетов, включая чековые и сберегательные счета, депозитные сертификаты (CD или срочные депозитные счета) и многое другое.
Для открытия любого депозитного счета вам необходимо иметь действительный идентификатор продукта для данного типа счета и идентификатор клиента (идентификатор клиента, зарегистрированный в системе) владельца счета. Обратите внимание, что у владельца счета должен быть хотя бы один адрес и номер телефона в его клиентской базе, а также статус OFAC. Прозрачный. Кроме того, классификация клиента должна соответствовать настроенной классификации продукта. Напримерampе., к бизнес-продукту могут быть добавлены только корпоративные клиенты.
Прежде чем начать
Убедитесь, что у вас есть:
API-данные
Идентификатор партнера (который вы получили при регистрации)
Идентификатор клиента
Идентификатор продукта (определяет тип открываемого счета)
ВАЖНЫЙ
Мы настоятельно рекомендуем вам включить в заголовок запроса ключ идемпотентности. для предотвращения дублирования платежей в случае неудачи.
Конечные точки и webкрючки
Используется следующая конечная точка API:
Описание API
Открыть депозитный счет Открывает депозитный счет для клиента
Следующее webкрючок используется:
WebОписание крючка
Основной.счет.открыт Открыт новый счет.
Открыть счет
В следующем сценарии вы откроете счет для Джона Смита, клиента, которого вы успешно подключили.
Открыть счет
1 Вызов POST core/v1/dda/accounts Для этого вызова требуются некоторые атрибуты. См. полный текст.
список атрибутов
Sampзапрос
POST /core/v1/dda/accounts
{
«Идентификатор клиента»: “59e3bc15-bbec-4990-88e9-a9a600d3296c”,
«productId»: “44015e68-1afb-40fc-9497-abc1014f52da”,
"заголовок": «Джон Смит»,
«statementAddress»: {
«улица1»: «257 Далтон Гроувс»,
"город": «Бартон-Сити»,
"состояние": «МИ»,
"Почтовый индекс": «48705»,
«код страны»: "НАС"
}
}
2 Успешный вызов API возвращает ответ JSON с данными новой учетной записи.
Sampле ответ
ПОЧТА /основной/v1/дда/счета
{
«Идентификатор клиента»: “59e3bc15-bbec-4990-88e9-a9a600d3296c”,
«productId»: “44015e68-1afb-40fc-9497-abc1014f52da”,
"заголовок": «Джон Смит»,
«statementAddress»: {
«улица1»: «257 Далтон Гроувс»,
"город": «Бартон-Сити»,
"состояние": «МИ»,
"Почтовый индекс": «48705»,
«код страны»: "НАС"
}
}
3 The номер счета поле указывается номер счета для новой учетной записи.
4 В ответе эксample, счет классифицируется как Личный поскольку пользователь настроил классификацию продукта как Личный. Классификация счета всегда соответствует настроенной классификации продукта.
5 Статус учетной записи автоматически обновляется на Активный и сразу же становится доступным для использования. Это запускает Основной.счет.открыт событие.
Подробности события Core.Account.Opened
{
"идентификатор": “259cdbca-6a89-4af8-a50e-ada3010fb13f”,
«eventName»: «Основной.счет.открыт»,
"статус": "В ожидании",
«partnerId»: “e6c3824a-377f-44d5-a2f6-a9a600c9b37e”,
«создано в»: “2021-01-26T09:48:10.1011462-05:00”,
«ресурсы»: [
«core/v1/dda/accounts/2235223803»
],
"подробности": []
}
Fundanaccount
При работе в «песочнице» для тестирования платежных систем и поведения счета вам необходимо иметь средства на счете.
Вы можете использовать любую железную дорогу с входящей конечной точкой моделирования для пополнения счёта песочницы, если счёт настроен для этого. В частности, вы можете:
Моделировать входящие платежи ACH
Имитация входящего провода
Для любой симуляции вам понадобится номер счёта Cross River Sandbox, который вы хотите пополнить. Информация об инициаторе не важна, а в некоторых случаях может быть полностью вымышленной.
Следующие шаги
Проверьте нашу оплату.
учебники
3.3. Карты
Шаг 1
Получить учетные данные API
Шаг 2
Получить токен доступа
Шаг 3
Использовать токен доступа
Шаг 4
Построить Sampле приложение
Узнайте, как работать с API Cross River. На этой странице вы узнаете, как:
Создать карту
Активировать карту
Создать карту
Управляйте картами своих клиентов, сотрудничая с Cross River, чтобы решить, что вы хотите предложить, например, физические или виртуальные карты. конфигурация карты. Cross River создает профессиональную конфигурацию карты.file для вас для каждого типа выбранного вами финансового инструмента клиенты.
Прежде чем начать
Обязательно сделайте и имейте при себе:
Создать запись клиента
Создать депозитный счет
Номер счета владельца карты
Идентификатор клиента (вы получаете его при создании клиента)
Идентификатор конфигурации (Cross River предоставляет вам идентификатор при настройке вашего типа/карты)
Мы также рекомендуем вам для соответствующих webперехват событий. регистрация
Конечные точки иwebкрючки
Зарегистрироваться для webХуки. Используются следующие конечные точки API:
Описание API
Создать новую карту Запрашивает создание новой дебетовой карты
Следующее webкрючки используются:
WebОписание крючка
Карты.Карта.Создана Дебетовая карта создана
Orderacard
Вы узнаете, как заказать/создать новую дебетовую карту, создав карту для Джона Смита.
1 Вызов POST /cardmanagement/v1/cards .
В следующем примереampЗдесь вы можете увидеть, какие атрибуты необходимы. Подробнее о полном API см. здесь.
Добавить карту
Sampле создать карту
curl -X POST /cardmanagement/v1/cards –header 'Content-Type: приложение “accountNumber”: “2608927303”, \
“customerId”: “2b15a695-13dc-4b10-b4e5-af5b0138873c”, \
«configurationId»: «a6b5a94c-f8f9-462b-8ce8-afa400f5b640», \ «firstName»: «Джон», \
«фамилия»: «Смит», \
"телефон": { \
«phoneType»: «Домашний», \
«Номер телефона»: «9133413131» \
}, \
«адрес электронной почты»: «John.Smith@xxxxx.com», \
"Адрес доставки": { \
«улица1»: «Лейн Авеню», \
«улица2»: «строка», \
«город»: «Большой город», \
«государство»: «IL», \
«Почтовый индекс»: «72410», \
«код страны»: «США» \
}, \
"Адрес для выставления счета": { \
«улица1»: «Лейн Авеню», \
«улица2»: «строка», \
«город»: «Большой город», \
«государство»: «IL», \
«Почтовый индекс»: «72410», \
«код страны»: «США» \
}, \
«nameOnCard»: «Джон Смит», \
«shippingType»: «Обычный», \
«Идентификатор клиента»: «строка» \
}' 'https://sandbox.crbcos.com/CardManagement/v1/cards'
2 Успешный вызов API возвращает ответ JSON с данными новой карты. Статус карты будет неактивным до тех пор, пока вы её не активируете. В данном случае id — это идентификатор карты. example 8709163d-140c-4d95-a111-afa8009e9cd1, который вам понадобится активировать карта.
Sample заказ карты ответ
{
"идентификатор": “8709163d-140c-4d95-a111-afa8009e9cd1”, «partnerId»: “cd9c12f4-7691-424a-b38b-af5b0134c611”, «productId»: “83bed086-8182-4151-a1e3-af5b01362783”, "номер счета": «2608927303»,
"статус": «Неактивированный»,
«statusReasonCode»: «NotSet»,
"имя": "Джон",
"фамилия": «Смит»,
"Адрес доставки": {
«улица1»: «Лейн Авеню»,
«улица2»: "нить",
"город": «Большой город»,
"состояние": «ИЛ»,
"Почтовый индекс": «72410»,
«код страны»: "НАС"
},
"Адрес для выставления счета": {
«улица1»: «Лейн Авеню»,
«улица2»: "нить",
"город": «Большой город»,
"состояние": «ИЛ»,
"Почтовый индекс": «72410»,
«код страны»: "НАС"
},
"телефон": {
«Тип телефона»: "Дом",
"номер телефона": «9133413131»
},
"Адрес электронной почты": «john@anygoogle.com»,
«имяНаКарточке»: «Джон Смит»,
«isPinSet»: ЛОЖЬ,
«adminBlocked»: ЛОЖЬ,
«Подозреваемый в мошенничестве»: ЛОЖЬ,
«configurationId»: “a6b5a94c-f8f9-462b-8ce8-afa400f5b640”, «категория»: «Кредит»,
«платежный инструмент»: «VirtualPan»,
«процессор»: «имя процессора»,
«Тип доставки»: "Нормальный",
«Статус заказа»: «Заказ в ожидании»,
«replacementStatus»: "Непригодный",
«Идентификатор клиента»: “2b15a695-13dc-4b10-b4e5-af5b0138873c”, «ИдентификаторКлиента»: "нить",
«создано в»: “2023-02-13T04:37:29.4869172-05:00”,
«lastModifiedAt»: “2023-02-13T04:37:29.4869172-05:00”
}
3 The Карты.Карта.создан webСобытие-перехват срабатывает при генерации карты на процессоре.
Sample Cards.Card.Created событие
{
"идентификатор": “cea6c5b5-13e7-4c2f-ba75-afce01110fe5”,
«eventName»: «Карты.Карта.Созданы»,
"статус": "В ожидании",
«partnerId»: “cd9c12f4-7691-424a-b38b-af5b0134c611”,
«создано в»: “2023-02-13T04:42:29.4869172-05:00”,
«ресурсы»: [
“cardmanagement/v1/cards/8709163d-140c-4d95-a111-afa8009e9cd1” ],
"подробности": [
{
«cardId»: “8709163d-140c-4d95-a111-afa8009e9cd1”,
"статус": «Неактивированный»,
«statusReasonCode»: «NotSet»
}
]
}
Активироватькарту
Прежде чем начать
Убедитесь, что у вас есть:
API-данные
Идентификатор карты, указанный при заказе карты
Конечные точки иwebкрючки
Описание API
POST /cardmanagement/v1/cards/{id}/activate Активирует карту, используя идентификатор карты. В руководстве используются эти webкрючки:
WebОписание крючка
Карты.Карта.Активирована Дебетовая карта активирована
Активироватькарту
Активируйте карту, которую вы создали в сtage.
создать карту
1 Вызов POST /cardmanagement/v1/cards/{id}/activate . id Атрибут должен быть установлен на идентификатор карты. В sampниже идентификатора есть 8709163d-140c-4d95-a111 afa8009e9cd1.
Sampзапрос на активацию карты le
curl -X ПОЧТА
–header 'Принять: application/json'
–header 'Авторизация: Предъявитель'<токен>'
https://sandbox.crbcos.com/CardManagement/v1/cards/8709163d-140c-4d95-a1
2 Успешный вызов API возвращает ответ JSON с данными карты. статус сейчас активированный. Статус заказа is Завершенный.
Sample активировать ответ карты
{
"идентификатор": “8709163d-140c-4d95-a111-afa8009e9cd1”, «partnerId»: “cd9c12f4-7691-424a-b38b-af5b0134c611”, «productId»: “83bed086-8182-4151-a1e3-af5b01362783”, «processorCardId»: «804951250206718»,
"номер счета": «2608927303»,
"статус": «Активный»,
«statusReasonCode»: «NotSet»,
"имя": "Джон",
"фамилия": «Смит»,
"Адрес доставки": {
«улица1»: «Лейн Авеню»,
«улица2»: "нить",
"город": «Большой город»,
"состояние": «ИЛ»,
"Почтовый индекс": «72410»,
«код страны»: "НАС"
},
"Адрес для выставления счета": {
«улица1»: «Лейн Авеню»,
«улица2»: "нить",
"город": «Большой город»,
"состояние": «ИЛ»,
"Почтовый индекс": «72410»,
«код страны»: "НАС"
},
"телефон": {
«Тип телефона»: "Дом",
"номер телефона": «9133413131»
},
"Адрес электронной почты": «john@anygoogle.com»,
«имяНаКарточке»: «Джон Смит»,
«panLastFour»: «3629»,
«isPinSet»: ЛОЖЬ,
"Дата окончания срока": «2026-02-13»,
«adminBlocked»: ЛОЖЬ,
«Подозреваемый в мошенничестве»: ЛОЖЬ,
«configurationId»: “a6b5a94c-f8f9-462b-8ce8-afa400f5b640”, «категория»: «Кредит»,
«платежный инструмент»: «VirtualPan»,
«процессор»: «имя процессора»,
«Тип доставки»: "Нормальный",
«Статус заказа»: "Завершенный",
«replacementStatus»: "Непригодный",
«Идентификатор клиента»: “2b15a695-13dc-4b10-b4e5-af5b0138873c”,
«ИдентификаторКлиента»: "нить",
«processorCustomerId»: “T83E9D675A3N3N9O8RZ1”,
«создано в»: “2023-02-13T04:37:29.487-05:00”,
«initialActivation»: “2023-02-13T00:00:00-05:00”,
«activatedAt»: “2023-02-13T04:43:19.282287-05:00”,
«lastModifiedAt»: “2023-02-13T04:43:19.2962845-05:00”
}
3 Когда статус карты изменится на Активный , Карты.Карта.Активирована webсрабатывает событие-перехват.
Карты.Карта.Активирована webсобытие-крюк
{
"идентификатор": “95ac33ca-3d7f-49aa-bfc2-afce01113310”,
«eventName»: «Карты.Карта.Активирована»,
"статус": "В ожидании",
«partnerId»: “cd9c12f4-7691-424a-b38b-af5b0134c611”,
«создано в»: “2023-02-13T04:44:31.282287-05:00”,
«ресурсы»: [
“cardmanagement/v1/cards/8709163d-140c-4d95-a111-afa8009e9cd1” ],
"подробности": [
{
«cardId»: “8709163d-140c-4d95-a111-afa8009e9cd1”,
"статус": «Активный»,
«statusReasonCode»: «NotSet»
3.4. Кредитование
Шаг 1
Получить учетные данные API
Шаг 2
Получить токен доступа
Шаг 3
Использовать токен доступа
Шаг 4
Построить Sampле приложение
Кредитование включает набор вызовов, позволяющих создавать, обновлять и управлять API кредитования. ваши кредиты.
Чтобы начать работу с кредитованием, убедитесь, что вы:
Получите учетные данные API с областями, необходимыми для кредитования
Если вы создали учетные данные API, используя функцию самостоятельного управления
, то вам также следует отправить запрос
arix.support@crossriver.com
Оргвместе с вашим клиентским ID и MPLID, чтобы завершить творение.
Используйте правильную область действия для API, которые вы хотите использовать.
Область действия API для песочницы: CosLending:PreApproval:stg
Песочница
Модуль База URL для API-вызовов Описание
Заем происхождение
Принятие решения по заявке
|
https://arixapisandbox.crbnj. net |
База URL для вызовов API по выдаче кредитов в изолированную среду Arix |
|
https://lendingsandbox.crbco s.com/preapproval/v1 |
База URL для песочницы принятие решения по заявке |
Развязность
Модуль Swagger Link
|
API-ссылка документация |
https://arixapisandbox.crbnj.net/swagger-ui |
|
Крючки |
https://lendingsandbox.crbcos.com/hooks/swagger/inde x.html |
Продажа https://lendingsandbox.crbcos.com/selling/swagger/inde x.html
СтатусСтраница
Чтобы увидеть список предстоящих релизов, отслеживать текущий статус API, view Чтобы получать отчеты об инцидентах или уведомления о плановом техническом обслуживании, посетите нашу страницу статуса и подпишитесь на оповещения.
4. Настройка программы
Настроить SFTP: Используйте SFTP для отправки fileили загрузить их с сайта Cross River, в соответствии с вашими и нашими потребностями.
Привлечение клиентов: Управляйте информацией о своих клиентах в Кросс-Ривер операционная система (COS) с использованием API или COS Explorer
Типы и идентификаторы продуктов COS: объяснение типов и идентификаторов продуктов COS.
COS Explorer: Как работать с нашим COS Explorer.
Портал управления организацией: как работать с нашим порталом управления организацией.
4.1. Настроить SFTP
Когда вам нужно обменяться конфиденциальной информацией в file Формат с Cross River, мы требуем от вас использовать Secure File Протокол передачи данных (SFTP). Используйте SFTP для отправки fileили скачать их с Cross River, в соответствии с вашими и нашими потребностями. В некоторых случаях вы или мы зашифруем эти данные. files, особенно если они содержат какую-либо персональную идентификационную информацию (PII).
ИспользованиеSFTP
SFTP позволяет безопасно отправлять и получать конфиденциальную информацию fileФайлы и отчёты хранятся в папке, специально выделенной для вашей компании на защищённом сервере. Загрузите и скачайте fileчерез эту папку или подпапки этой папки, в соответствии с вашими конкретными потребностями.
Использование шифрования
Шифрование files добавляет дополнительный уровень защиты. Только авторизованный персонал с правильным ключом сможет расшифровать зашифрованные данные. file. В Кросс-Ривер мы используем шифрование PGP.
Начать
Для настройки и запуска нашего SFTP-сервера необходимо выполнить несколько шагов.
1 Вы заполняете форму запроса на доступ по IP для служб Cross River SFTP (из вашего RM).
Если вам нужно поделиться fileВ случае с Cross River ваш менеджер по работе с клиентами отправит вам форму запроса на IP-доступ к сервисам CRB SFTP. Помимо прочего, вам необходимо предоставить статические публичные IP-адреса, которые вы будете использовать для доступа к папке SFTP, и открытый ключ PGP для шифрования и дешифрования. files. Отправьте заполненную форму обратно своему менеджеру по работе с клиентами.
ВАЖНЫЙ
Cross River добавит вам в разрешённый список только 5 IP-адресов, так что учтите это. IP-адреса должны быть статическими. Поэтому вам необходимо проксировать всё, что не является статическим, с вашей стороны.
2 Мы настроим структуру вашей папки SFTP.
Получив ваши данные, отдел IT-инжиниринга создаст для вас стандартный набор папок и подпапок. Этот уникальный путь предназначен только для вашей компании. Другие партнёры не смогут получить к нему доступ. Отдел IT-инжиниринга отправит вам электронное письмо с информацией, необходимой для доступа к папкам. В письме будет ссылка на ваши учётные данные. Cross River не сохраняет ваш пароль!
ВАЖНЫЙ
Ссылка действительна всего несколько дней, после чего, если вы ею не воспользуетесь, вам придется запросить сброс пароля.
Учетные данные также становятся недействительными, если по ссылке получают доступ более двух человек..
3 Тестовая загрузка SFTP.
Если вы будете поставлять fileв Кросс-Ривер, ваш ИТ-отдел должен создать учетную запись службы с автоматизированным процессом загрузки этих данных. files в ваши папки SFTP. Настоятельно рекомендуем вам протестировать это, прежде чем отправлять реальные данные. По любым вопросам или проблемам обращайтесь к своему менеджеру по работе с клиентами или создайте тикет в службу поддержки первой линии.
4 Настройте PGP для отправки или получения fileиз Кросс-Ривер. (Этот шаг необходим только в том случае, если вы отправляете или получаете персональные данные. Уточните это у своего менеджера по работе с клиентами.)
Если вам нужно отправить Кросс-Ривер files, мы сначала отправим вам наш открытый ключ PGP для использования при шифровании этих files.
Вы уже должны были отправить Cross River свой открытый ключ PGP для получения fileот нас.
5 Поделитесь своими данными.
Как только ваша папка SFTP настроена и процесс запущен, вы можете начать делиться fileВаш менеджер по работе с клиентами сообщит вам, нужно ли вам сделать что-то ещё для получения отчётов или как подготовить данные для отправки нам.
Конкретные отчеты
Узнайте больше о подготовке и отправке отчетов и files для:
Счета и платежи
Карточные платежи
Кредитный риск
Кредитование
Пакетные платежи XML (ISO 20022)
4.2. Привлечение клиентов
Управляйте информацией о клиентах в операционной системе Cross River (COS) с помощью API или . Эта информация включает основные данные, необходимые для открытия банковского COS Explorer.
или использовать кредитную карту, а также более подробные данные о клиенте, если необходимо. Мы называем это запись клиента.
Прежде чем вы сможете открыть депозитный счет или создать карту, вы должны создать учетную запись клиента, иногда называемую онбординг. Затем вы можете назначить одного или нескольких клиентов на счет через службу поддержки клиентов. отношения.
Процесс адаптации клиента включает в себя создание соответствующей записи клиента. Информация о клиенте. Следуйте этому руководству, чтобы создать запись о клиенте..
Дополнительные шаги
Добавить данные удостоверения личности
Добавить бенефициарного владельца
Коды ошибок
См. , а также множество другой справочной информации о кодах ошибок системы COS COS.
страница справочных кодов.
4.2.1. Запись клиента
Запись клиента
Карточка клиента — основной ресурс, содержащий информацию о клиенте в системе Cross River. Поэтому перед созданием учётной записи для клиента необходимо зарегистрировать его. Карточка клиента поддерживает категории «Личный» и «Бизнес». После регистрации вы можете связать клиента с одной или несколькими учётными записями.
Бывшийampниже показано, как подключить клиента к работе в качестве персонального клиента.
Запрос на бортовое лицо
POST /core/v1/cm/customers {
«partnerId»: “7cc038be-fde9-4455-b27b-1497cf667362”,
"имя": {
«префикс»: "Мистер.",
"имя": "Джон",
"второе имя": "Роберт",
"фамилия": «Смит»,
"суффикс": «Младший»,
«предпочитаемое имя»: "Джим" },
«классификация»: «Личное»,
«профи»file”: {
«регО»: ЛОЖЬ,
«ГражданствоКодСтраны»: "НАС",
«политически разоблачённое лицо»: ЛОЖЬ,
«enableBackupWithholding»: ЛОЖЬ,
«backupWithholdingPercent»: 0,
«taxIdType»: «ССН»,
«taxId»: «123456789»,
"Дата рождения": «1965-09-15»,
«riskRating»: "Низкий",
«privacyOptOut»: истинный }
} Присоединяйтесь к бизнес-клиенту, например, корпорации или ООО, использующему ту же конечную точку с немного отличающимися атрибутами.
Curl
POST /core/v1/cm/customers {
«partnerId»: “a24cba49-2bb6-431d-a867-1de81d6e4127”,
"имя": {
«Имя_сущности»: «АКМЕ КО», },
«классификация»: "Бизнес",
«профи»file”: {
«ГражданствоКодСтраны»: "НАС",
«enableBackupWithholding»: ЛОЖЬ,
«backupWithholdingPercent»: 0,
«taxIdType»: «Эйн»,
«taxId»: «123456789»,
«датаФормед»: «2019-09-10»,
«entityType»: «Корпорация»,
«riskRating»: "Низкий",
«Тип собственности»: «Юридическое лицо»,
«primaryOwnerCustomerId»: “f9321f7f-3712-46e1-b965-2b79ead64dc9”, } }
Независимо от того, привлекаете ли вы частного или корпоративного клиента, Основной владелец CustomerId Атрибут должен содержать идентификатор клиента, ссылающийся на запись о клиенте типа «Персональный». Таким образом, чтобы подключить компанию, необходимо сначала создать персональную запись о клиенте для основного владельца этой компании.
ВАЖНЫЙ
Некоторые конечные точки клиентов включают Юридическая экспертиза Ресурс, который может потребоваться или не потребоваться при подключении частных клиентов. Ваш назначенный координатор по вопросам соответствия требованиям доводит до вашего сведения требования по всем полям комплексной проверки в процессе подключения.
Бенефициарные владельцы
Бенефициарный владелец — это лицо, которому принадлежит 25% или более бизнеса. В целях соблюдения законодательства вам необходимо предоставить информацию о Бизнес запись клиента создает бенефициарного владельца
для каждого бенефициара этого бизнеса. владелецCustomerId Атрибут ссылается на персональную запись клиента для каждого бенефициара. Ресурсы бенефициара обычно добавляются в запись корпоративного клиента сразу после регистрации компании.
Curl
POST /core/v1/cm/customers/{customerId}/бенефициарные-владельцы {
«владелецКлиентId»: “c1210a2d-932e-43ca-be29-f358a4382385”,
«владелецНазвание»: «Президент» }
Адрес
Физические адреса, связанные с клиентом, могут быть .
обновлено
Curl
POST /core/v1/cm/customers/{customerId}/addresses
{
«isPrimary»: истинный,
"статус": «Активный»,
«классификация»: "Жилой",
«addressType»: "Дом",
«улица1»: «123 Мейпл-стрит»,
«улица2»: «Кв. 12»,
«улица3»: “”,
"город": "Нью-Йорк",
"состояние": «Нью-Йорк»,
"Почтовый индекс": «10025»,
«код страны»: "НАС",
}
Адреса электронной почты
Обновить электронную почту
контактная информация для клиента.
Curl
POST /core/v1/cm/customers/{customerId}/emails {
«isPrimary»: истинный,
«emailType»: «Личное»,
"Адрес электронной почты": «john.smith@crossriver.com» }
Телефоны
Обновить телефон Curl
контактная информация для клиента.
POST /core/v1/cm/customers/{customerId}/phones
{
«Тип телефона»: "Дом",
«isPrimary»: истинный,
"номер телефона": «2015551234»
}
Идентификации
Идентификаторы используются для отслеживания метаданных документов, удостоверяющих личность клиента, таких как водительские права и паспорта. Может использоваться для добавления новых данных, удостоверяющих личность. Добавить данные, удостоверяющие личность.
Curl
POST /core/v1/cm/customers/{customerId}/identifications {
«isPrimary»: истинный,
«idNumber»: «DL123456789»,
«idType»: "Водительское удостоверение",
«выданная дата»: «2018-08-30»,
«expDate»: «2018-08-30»,
«Проверенная дата»: «2018-08-30»,
"орган, выдавший документ": «Департамент автотранспортных средств Нью-Джерси»,
«выдающийШтатИлиПровинция»: «Нью-Джерси»,
«код страны выдачи»: "НАС",
}
4.2.2. Типы и идентификаторы продуктов COS
В Кросс-Ривер, тип продукта — это уникальный финансовый продукт, который вы предлагаете своим клиентам. Например,ampНапример, тип продукта может быть дебетовой картой или сберегательным счётом, настроенным в соответствии с вашими потребностями и спецификациями. Вы открываете счета для своих клиентов по любому типу продукта, который определите и настроите вместе с нами. Обратитесь к своему менеджеру по работе с клиентами за более подробной информацией, включая настройку типов продуктов для ваших клиентов.
НапримерampНапример, вам может потребоваться настроить тип продукта как сберегательный счёт, использующий банковские переводы и платежи через ACH. Затем вы сможете предлагать своим клиентам сберегательные счета с этими услугами и настройками.
Cross River предоставляет вам идентификатор продукта для каждого типа продукта, который вы хотите предложить своим клиентам. Для открытия любого депозитного счета вам необходимо иметь действительный идентификатор продукта и идентификатор клиента (идентификатор клиента, зарегистрированный в системе). Обратите внимание, что у владельца счета должен быть хотя бы один адрес и номер телефона в его клиентской базе, а также статус OFAC. Прозрачный. Кроме того, классификация клиента должна соответствовать настроенной классификации продукта. Напримерampе., к бизнес-продукту могут быть добавлены только корпоративные клиенты.
4.2.3. COS Explorer
Как только вы окажетесь в системе Кросс-Ривер и получите электронное письмо с информацией о вашем прибытии
твой идентификатор клиента и Секрет вы готовы войти в COS Explorer. Доступ к порталу COSExplorer
Производство:
https://api.crbcos.com/explorer2/
Песочница:
https://sandbox.crbcos.com/explorer2/
Приветственное письмо
Вы получите приветственное письмо от CrossRiver_DO_NOT_REPLY@crossriver.com. Если вы не видите его в своем почтовом ящике, проверьте папки «Спам» или «Заблокированные».
Нажмите Создайте свою учетную запись Cross River.
Если вы в какой-то момент прервете работу с мастером, щелкните ссылку в исходном письме, чтобы вернуться к тому месту, где вы остановились.
Условия и положения
Ознакомьтесь с условиями и проверьте Приниматьи нажмите Следующий.
SMS-подтверждение (текстовое сообщение)
Мы отправляем вам SMS (текстовое сообщение) на ваше устройство для подтверждения вашей личности. Введите 6-значный код, полученный на экране входа, и нажмите кнопку Проверить код.
Создайте свой пароль
1. Введите пароль, соответствующий требованиям на экране, и введите пароль еще раз.
2. Нажмите Создать пароль.
Настройка приложения-аутентификатора
Вам необходимо завершить этот шаг, чтобы продолжить процесс регистрации и иметь возможность войти в систему в будущем.
Чтобы защитить вашу личность, учетную запись и информацию, мы требуем, чтобы вы вошли в систему, используя многофакторную/двухфакторную аутентификацию.
Если на вашем устройстве еще нет приложения для аутентификации, вам необходимо загрузить его, прежде чем продолжить.
Для Android и iOS мы рекомендуем использовать следующее приложение-аутентификатор:
Google Аутентификатор
Аутентификатор Microsoft
После установки приложения-аутентификатора вам необходимо либо отсканируйте QR-код or вручную введите ключ в приложение-аутентификатор.
QR-код
1. Отсканируйте QR-код в приложении-аутентификаторе и при необходимости введите 6-значный код на странице многофакторной аутентификации.
2. Нажмите «Продолжить».
Руководство
1. Нажмите Показать ключ
2. Скопируйте ключ как Секрет в вашем приложении-аутентификаторе.
3. Введите 6-значный код.
4. Нажмите Продолжать.
Неверный код MFA
Если вы введете неверный код MFA, красное сообщение уведомит вас о необходимости повторить попытку.
Упс! Вы ввели неверный код MFA. Вот несколько моментов, которые стоит проверить:
1. Истекло ли время ожидания кода до того, как вы нажали? ПродолжатьОставшееся время отображается в кружке обратного отсчета справа от имени учетной записи и кода MFA.
2. Если у вас настроено приложение-аутентификатор для нескольких сред или приложений, еще раз проверьте, что вы ввели правильный код.
1. Если из названий подключений MFA не ясно, какой вариант является правильным, возможно, придется попробовать разные коды, пока не найдете работающий.
2. Найдя нужное подключение, вы можете переименовать его в приложении MFA. Значок карандаша в верхней части экрана приложения MFA откроет режим редактирования. В некоторых приложениях сначала нужно выбрать (или нажать и удерживать) подключение, которое нужно отредактировать, после чего появится значок.
3. В режиме редактирования вы можете при необходимости переименовать соединения, чтобы было понятно, какое из них относится к той или иной среде.
4. Сохраните все изменения, и в следующий раз вам будет легче понять, какой код использовать.
Коды восстановления
Используйте коды восстановления для аутентификации в случае утери устройства.
1. Загрузите или скопируйте коды восстановления и сохраните их в надежном месте, которое вы не забудете.
2. Подтвердите, что вы сохранили коды восстановления.
3. Нажмите Зарегистрироваться.
Страница с кодами восстановления закрывается через 10 минут.
Коды восстановления можно загрузить только один раз.
Ваша учетная запись теперь активна, и вы можете использовать ее для входа в любое из приложений CR.
список разрешенных IP-адресов
Для доступа к COS Explorer можно использовать только статический IP-адрес. Если вам нужна помощь, обратитесь в службу поддержки вашего IP-адреса.
IP-адреса сервера идентификации:
172.67.26.222 104.22.40.134 104.22.41.134
Сервер проксируется через Cloudflare.
Вы можете разрешить следующие полные доменные имена:
idptest.crbcos.com
Поиск неисправностей
Забыли пароль
1. Нажмите Забыли пароль? и введите свой адрес электронной почты.
2. Введите 6-значный код аутентификации из вашего приложения-аутентификатора. 3. Вы получаете Забыли пароль электронная почта. Нажмите Сбросить пароль.
4. На странице сброса пароля введите новый пароль, нажмите Сбросить пароль, и Перейти к подаче заявления.
Сброс многофакторной аутентификации
Если у вас уже настроен MFA:
1. На сервере идентификации перейдите в раздел Сбросить МФА и нажмите Сбросьте настройки устройства MFA. 2. Откроется страница многофакторной аутентификации, на которой вы сможете сбросить МФА.
Вы также можете создать новые коды восстановления многофакторной аутентификации.
1. Нажмите создать новые коды восстановления многофакторной аутентификации.
2. Откроется страница кодов восстановления, на которой вы сможете скопировать или загрузить 10 новых кодов восстановления.
Если вы еще не настроили многофакторную аутентификацию, вы можете включить MFA из Настройки учетной записи.
1. Нажмите Сброс метода MFA.
2. Нажмите Настроить МФА.
3. Следуйте инструкциям в разделе Многофакторная аутентификация/Двухэтапная аутентификация.
Если ваш текущий MFA — это SMS, вы можете включить MFA с помощью приложения-аутентификатора. Настройки учетной записи
1. Нажмите Сброс метода MFA.
2. Нажмите Настроить МФА.
3. Следуйте инструкциям в разделе Многофакторная аутентификация/Двухэтапная аутентификация.
Используйте код восстановления
Если у вас нет доступа к многофакторному (двухфакторному) аутентификатору, вы можете войти в систему, используя один из ваших кодов восстановления.
1. Войти как обычно
2. На странице «Многофакторная аутентификация» у вас есть возможность использовать код восстановления в качестве варианта аутентификации.
3. Введите один из ваших кодов восстановления в текстовое поле. Код восстановления одноразовый и не может быть использован повторно. Во избежание путаницы в будущем рекомендуем отметить код восстановления как использованный.
![]()
Блокировка аккаунта
Если вы введёте неправильный пароль для своего имени пользователя 5 раз подряд, система заблокирует вашу учётную запись примерно на 5 минут. Если через 5 минут вы всё ещё не сможете получить доступ к своей учётной записи, обратитесь в службу поддержки Cross River.
Ошибка браузера - Брандмауэр
Вы входите в COS Explorer и видите следующий экран с ошибкой:
![]()
Вас заблокировал брандмауэр.
1. Обратитесь в свой ИТ-отдел, чтобы узнать, применяются ли в вашей организации правила брандмауэра для исходящего трафика. Если правил брандмауэра для исходящего трафика нет, то:
2. Обратитесь в свой ИТ-отдел, чтобы убедиться, что вы подключаетесь к порталу Cross River COS Explorer с одобренного IP-адреса. Если вам нужно зарегистрировать дополнительные IP-адреса, отправьте электронное письмо в службу поддержки COS.
4.2.3.1. Управление пользователями
Управление пользователями
Вы можете использовать Пользователи экран Админ Вкладка позволяет сгруппировать набор ресурсов, таких как клиенты, продукты и счета. После того, как ресурс (например, продукт или клиент) назначен вам, его нельзя изменить.
Вы можете использовать эту область для поддержки и внесения изменений для своих клиентов. Мы можем предоставить вам двух администраторов, чтобы вы могли создавать пользователей по запросу для своих клиентов. Это даст вам независимость в управлении клиентами и позволит вносить изменения в нерабочее время по их запросу.
Вы также можете создавать или регистрировать новых пользователей.
Создатьновогопользователя
1 В Админ вкладка, щелкните Пользователи чтобы открыть Пользователи экран поиска. 2 Нажмите + Новый пользователь. Создать пользователя отображается экран.
3 In Создать пользователя введите пользователя Электронная почта, затем отобразятся следующие поля Имя, Фамилия и Номер телефона.
4 Нажмите Статус и выберите Активный.
The Номер телефона В поле необходимо указать номер мобильного телефона, так как он будет использоваться для MFA для аутентификации пользователя.
Описание поля
|
Имя |
Имя пользователя. Введите полное имя пользователя, которое будет отображаться в окне браузера при входе пользователя в Explorer. |
|
Электронная почта |
Адрес электронной почты пользователя. Этот адрес используется для входа в Explorer, а также служит для восстановления пароля. |
|
Статус |
Выберите статус пользователя. Статус пользователя: Неактивный По умолчанию. Измените на Активный при создании пользователя. |
|
Тип пользователя |
В этом поле отображается Партнер при создании пользователя. |
|
Роли |
Выберите роли, которые нужно добавить пользователю, или нажмите Включить все роли для добавления всех доступных ролей пользователю. Примечание: Будут видны только назначенные вам роли. Некоторые роли содержат разрешения, позволяющие вам инициировать платежи в Explorer. Администраторы Explorer несут ответственность за правильную настройку пользователей, используя только соответствующие роли и разрешённые ограничения. |
Для каждого поля выберите лимит в долларах (если применимо)
5 Нажмите Статус и выберите Активный.
6 Нажмите Роли и выберите, кого хотите назначить новому пользователю. Нажмите Сохранять роли Изменения.
Все пользователи должны быть настроены с помощью Только для партнеров Core Ready роль.
Если пользователю назначен Инициирование партнерского перевода роли, вы должны настроить лимит инициирования для этого пользователя.
7 Если вы назначаете пользователю Инициирование партнерского перевода роль, введите значение в Перевод.Wire.Payments.Originate Поле для указания максимальной суммы перевода в долларах за один перевод. В противном случае вы можете проигнорировать это поле.
8 Когда вы закончите настройку всех полей, нажмите Сохранить изменения.
9 Если вы успешно создали нового пользователя, появится экран подтверждения.
10 Чтобы завершить добавление и настройку пользователя, другой администратор должен Утвердить изменения.
11 The Утвердить ожидающие изменения Экран отображает. Нажмите. Подтверждать.
12 Viewинформации о пользователях
Документы/Ресурсы
 |
Платформа API Cross River [pdf] Руководство пользователя API-платформа, API-платформа, платформа |