Plateforme API
Commencer
1. Accueillir
NOUVEAU! Le public de Cross River a des demandes préétablies pour la collection Cross Postman
Rivière. points de terminaison de l'API
Bienvenue à Cross River documentation
Découvrez, explorez et commencez à intégrer nos produits en toute simplicité.
Démarrage rapide Explorer tous les produits
Obtenir commencé
Configurez et démarrez votre voyage utilisant les API de Cross River
Concepts
Découvrez comment les solutions Cross River peuvent transformer votre parcours fintech.
Apis
Développer en utilisant les berges de la Cross River
plateforme et ensembles d'API robustes
Tutoriels
Apprenez à utiliser Cross
API River étape par étape
2. Démarrage rapide
Étape 1
Étape 2
Étape 3
Étape 4
Obtenir un jeton d'accès
Utiliser le jeton d'accès
Construisez un Sampl'application
Obtenir les identifiants API: La première étape pour utiliser les API de Cross River consiste à vous inscrire pour obtenir des identifiants API.
Obtenir un jeton d'accès: Une fois que vous avez reçu vos identifiants API et avant de pouvoir utiliser nos API, vous devez obtenir un jeton d'accès en utilisant le client_id et client_secret que vous avez reçu lors de votre inscription.
Utilisez le jeton d'accès: Une fois l'authentification réussie, un jeton d'accès Il vous est renvoyé. Veuillez inclure ce jeton dans l'en-tête de vos appels API.
Webcrochets: WebLes hooks sont un élément important de toute intégration avec Cross River. Si les API permettent de demander des données à la demande, webLes hooks envoient des mises à jour en temps réel directement à votre système, éliminant ainsi le besoin d'interrogations constantes et réduisant la latence.
Environnements de bac à sable: Le bac à sable est un environnement totalement isolé, alors n'hésitez pas à
2.1. Obtenir les identifiants API
Étape 1
Obtenir les identifiants API
Étape 2
Obtenir un jeton d'accès
Étape 3
Utiliser le jeton d'accès
Étape 4
Construisez un Sampl'application
Pour utiliser les API de Cross River, la première étape consiste à vous inscrire afin d'obtenir des identifiants API. Ces identifiants vous permettront de demander et de recevoir un jeton d'accès pour envoyer des requêtes API dans notre environnement de test.
IMPORTANT
Votre adresse IP, qui doit être publique et statique, doit figurer sur notre liste blanche. Votre service informatique interne devrait pouvoir vous la fournir. En savoir plus sur les adresses IP statiques.
Accès au bac à sable
Soumettre une demande pour accéder à l'environnement de test, afin de recevoir les identifiants API.
Une fois votre adresse IP statique ajoutée à notre liste blanche, nous vous enverrons 2 e-mails chiffrés contenant vos identifiants :
Un e-mail contient votre client_id , identifiant_partenaire et toute autre information dont vous aurez besoin en fonction de votre demande.
Le deuxième courriel, qui est chiffré, contient votre client_secret et webhook_secret Vous en aurez besoin pour l'authentification et pour travailler dans l'environnement de test.
NOTE
Si vous avez demandé l'accès aux paiements par carte, vous recevrez un ensemble d'identifiants supplémentaires, y compris un deuxième client_id et client_secret
2.2. Obtenir un jeton d'accès
Étape 1
Obtenir les identifiants API
Étape 2
Obtenir un jeton d'accès
Étape 3
Utiliser le jeton d'accès
Étape 4
Construisez un Sampl'application
Cross River utilise OAuth 2.0 pour l'authentification et l'autorisation. Ce système contrôle l'accès à notre plateforme et garantit que seules les entités autorisées peuvent accéder à nos API et autres ressources protégées. Les informations que vous saisissez dans notre système d'authentification sont confidentielles et ne sont jamais accessibles depuis d'autres applications Cross River.
Une fois que vous avez reçu votre identifiant, et avant de pouvoir utiliser nos API, vous devez obtenir des identifiants API. un jeton d'accès utilisant le client_id et client_secret Vous avez reçu ce jeton d'accès lors de votre inscription. Il vous permet d'envoyer des informations de manière sécurisée sous forme d'objet JSON pour nos API. Vous devez l'inclure dans l'en-tête de chaque requête API.
Il existe plusieurs façons de demander et de recevoir un jeton d'accès :
Utiliser l'interface de ligne de commande (CLI) avec cURL ou toute autre langue
Utilisez Postman ou tout autre outil de test d'API.
Une fois obtenu, copiez le jeton d'accès dans votre presse-papiers. Veillez à le sauvegarder.
Interface de ligne de commande
Pour demander un jeton, envoyez un POST connect/token commande contenant la client_id et client_secret et type_octroi au serveur d'authentification bac à sable approprié, comme indiqué dans le sample ci-dessous.
Veuillez vous référer à la documentation pour une explication de ces éléments. tagsTableau des composants HTTP
L'exemple suivantample utilise cURL pour demander un jeton à l'un des serveurs d'authentification.
Sampla demande en cURL pour COS
curl –location –request 'POST https://idptest.crbcos.com/connect/token' \ –header 'Content-Type: application/x-www-form-urlencodé \ -données-urlencoder 'client_id=[votre identifiant ici]' \
-données-urlencoder 'client_secret=[votre secret ici]' \
-données-urlencoder 'grant_type=client_credentials' \
-données-urlencoder 'audience=https://api.crbcos.com/'
Sampla réponse de cURL demande
{ « jeton d’accès »: « contient de nombreux personnages », \
« expire dans »: 86400, \
« type_de_jeton »: "Porteur" }
Facteur
Pour demander un jeton à l'aide de Postman, envoyez un POST connect/token commande à la authentifier serveur du bac à sable approprié. Ajoutez le type_octroi , portée (facultatif) ,
client_id et client_secret à l'appel.
Veuillez vous référer à la documentation pour une explication de ces éléments. tagsTableau des composants HTTP
Si l'authentification réussit, le code d'état est 200 (OK).
COSExplorer
Dans , cliquez sur la flèche vers le bas à côté de votre identifiant et cliquez sur Copier le jeton d'accès. COS Explorer
Le jeton d'accès est copié dans votre presse-papiers et prêt à être utilisé dans l'environnement de test.
Réponse à la requête de jeton
Description de l'attribut
|
accès_à ken |
Un JSON signé numériquement web jeton (JWT) envoyé par le serveur OAuth qui permet d'accéder à des ressources spécifiques de Cross River |
|
portée |
Une gamme de services auxquels un utilisateur peut accéder |
|
expires_i n |
Le délai avant l'expiration du jeton. – Notre équipe d'intégration vous informera de la date d'expiration ou vous pourrez également décoder votre jeton d'accès. – Nous vous recommandons de récupérer un nouveau jeton d'accès peu de temps avant l'expiration de l'ancien. – Réutiliser les jetons pendant toute leur durée de vie au lieu d'obtenir un nouveau jeton pour chaque appel à la même ressource protégée (API). IMPORTANT: Ne décodez jamais votre jeton sur un serveur public. website |
type de jeton
Jeton porteur
Composants HTTP
Les composants HTTP suivants sont utilisés à la fois dans les requêtes API et Postman.
HTTP
composant
Tag Description
|
Point final |
POSTE /connecter/prendre n |
Point de terminaison pour récupérer un jeton d'accès |
|
En-tête |
contenu taper |
application/x-www-form- urlcodé |
|
Corps |
client_id |
L'identifiant unique d'un client |
|
Corps |
client_secret |
Une chaîne de caractères chiffrée utilisée pour signer et valider les jetons d'identification. Important: Les secrets ne peuvent pas être récupérés par CR. Si vous perdez un secret, vous devrez en générer un nouveau. Ne pas Consignez vos secrets dans un système de contrôle de version. |
|
Corps |
type_octroi |
Ce champ aura toujours la valeur de identifiants_client |
|
Corps |
public facultatif |
Un moyen pour l'utilisateur de vérifier si un jeton d'accès particulier lui est destiné. |
|
Corps |
portée facultatif |
Une gamme spécifique ou un ensemble limité de services auxquels un utilisateur peut accéder avec un jeton d'accès. Si aucune étendue n'est spécifiée, le jeton renvoyé contiendra toutes les étendues associées à vos informations d'identification. Note: Plusieurs étendues peuvent être envoyées dans la même requête en ajoutant un espace entre le nom de chaque étendue. Par exemple :ampfichier : 'scope=scope1 scope2 scope3' |
Serveur d'authentificationURLs
Serveur d'authentification du module URL
|
Comptes |
https://idptest.crbcos.com/connect/token |
|
ACH |
https://idptest.crbcos.com/connect/token |
|
Fils |
https://idptest.crbcos.com/connect/token |
|
Vérifications |
https://idptest.crbcos.com/connect/token |
|
Cœur |
https://idptest.crbcos.com/connect/token |
|
paiements instantanés |
https://idptest.crbcos.com/connect/token |
|
Émission de la carte |
https://idptest.crbcos.com/connect/token |
|
paiements par carte |
https://crbcos-sandbox.auth0.com/oauth/token |
Prêt https://oauthtest.crbnj.net/connect/token
Dépannage
Si le jeton d'authentification est valide, il renverra un code 200. Si le jeton d'authentification n'est pas valide, il renverra un code 401.
Si vous n'êtes pas en mesure d'obtenir un jeton porteur et que vous n'en avez jamais reçu auparavant :
Confirmer le URL.
Vérifiez que le client_id et client_secret sont saisies correctement. Elles sont sensibles à la casse.
Vérifiez votre client_id et client_secret Vérifiez que la commande que vous avez reçue correspond bien à celle indiquée. Assurez-vous qu'il n'y a aucun problème de réseau ou de liste blanche.
Contactez notre équipe d'intégration si votre compte est bloqué suite à 3 tentatives de connexion incorrectes. tentatives.
2.3. Utilisez le jeton d'accès
Étape 1
Obtenir les identifiants API
Étape 2
Obtenir un jeton d'accès
Étape 3
Utiliser le jeton d'accès
Étape 4
Construisez un Sampl'application
Une fois que vous avez réussi, vous obtenez un jeton d'accès vous est retourné. Veuillez inclure une pièce d'identité authentifiée. ce jeton dans l'en-tête de vos appels API.
Le jeton d'accès expire après une période déterminée. La réponse contenant le jeton précise également cette durée d'expiration en secondes. Conservez et utilisez votre jeton d'accès jusqu'à son expiration. Nous vous recommandons de l'utiliser jusqu'à l'obtention d'une erreur 401 (non autorisé), puis de demander un nouveau jeton.
IMPORTANT
1. Ne demandez pas un nouveau jeton pour chaque requête API.
2. Veillez à protéger votre jeton. Toute personne qui le vole peut usurper l'identité de votre client pendant toute la durée de validité du jeton.
En-tête de requête API
Dans l'en-tête de chaque requête API, incluez le jeton d'accès comme suit :
Sampl'appel de paiement par virement bancaire en cURL
curl –location –request 'POST https://sandbox.crbcos.com/Wires/v1/payments' –header 'Authorization: Bearer [VOTRE JETON ICI]' \
–header 'Content-Type: application/x-www-form-urlencodé \
–données brutes ‘{
« numéro de compte » : « 2255685659 »,
« businessFunctionCode » : « CTR »,
« numéro de routage du récepteur » : « 021000021 »,
« bénéficiaireFi » : {
« idCode » : « F »,
« identifiant » : « 021000021 »,
« nom » : « JP Morgan Chase »
},
« bénéficiaire » : {
« idCode » : « D »,
« identifiant » : « 123456789 »,
« nom » : « Peter Griffin »
},
« Référence du bénéficiaire » : « XYZ123 »,
« montant » : 10000,
« but » : « paiement »
}'
Facteur
Pour utiliser un jeton dans Postman, accédez à Autorisation onglet dans votre requête, sélectionnez Jeton porteur Choisissez « Appareil d’authentification » comme type d’authentification et collez votre jeton dans le champ prévu à cet effet. Postman ajoutera automatiquement le jeton. Porteur préfixe et jeton vers le Jeton champ.
2.4. Webcrochets
WebLes hooks sont un élément important de toute intégration avec Cross River. Si les API permettent de demander des données à la demande, webLes hooks envoient des mises à jour en temps réel directement à votre système, éliminant ainsi le besoin d'interrogations constantes et réduisant la latence. Dans de nombreux cas, webLes hooks sont plus efficaces et fiables que les API seules, garantissant ainsi que votre application reste synchronisée avec les événements critiques tels que les modifications de compte, les mises à jour de transactions et les résultats de traitement.
Utiliser webDes points d'ancrage au sein des systèmes Cross River vous informent de la survenue de différents événements. Chaque événement renvoie un objet ressource contenant des informations détaillées sur son sujet. L'ensemble des détails de l'événement est inclus et transmis à votre système.
Nous utilisons webDes points d'extension pour vous tenir informé de l'état d'avancement et signaler les modifications apportées aux transactions. WebLes hooks transmettent des notifications en temps réel à votre système lorsqu'un événement se produit.
Vous devez vous inscrire via l'API pour utiliser webcrochets:
Inscrivez-vous pour les comptes, les cartes et les événements de paiement
Inscrivez-vous aux événements de paiement par carte
Inscrivez-vous aux événements de prêt
2.5. Environnements de bac à sable
Notre environnement de test est totalement isolé ; n'hésitez donc pas à expérimenter. Lorsque vous serez prêt à passer en production, prévenez-nous et nous vous fournirons les identifiants nécessaires pour accéder à l'environnement de production.
Gestion de la clientèle
Base de modules URL pour les appels API
Gestion de la clientèle https://sandbox.crbcos.com/core/ Comptes
Base de modules URL pour les appels API
Comptes de dépôt
|
https://sandbox.crbcos.com/core/ |
Dépôts par balayage https://sandbox.crbcos.com/sweepsintrafi/ Cartes
Base de modules URL pour les appels API
Cartes https://sandbox.crbcos.com/cardmanagement/Paiements
Base de modules URL pour les appels API
|
Paiements instantanés |
https://sandbox.crbcos.com/rtp/ |
|
Paiements par carte : Paiement sans contact |
https://pushtopaystaging.crbnj.net/ |
|
Paiements par carte : Tirer |
https://pullfromcardapistg.crbnj.net/ |
|
Paiements internationaux |
https://sandbox.crbcos.com/international/ |
|
ACH |
https://sandbox.crbcos.com/ach/ |
|
Fils |
https://sandbox.crbcos.com/wires/ |
Chèques https://sandbox.crbcos.com/checks/ COSwebcrochets
Base de modules URL pour les appels API
COS webcrochets
https://sandbox.crbcos.com/webhooks/
Prêt
Base de modules URL pour les appels API
octroi de prêts
|
https://arixapisandbox.crbnj.net |
Décision relative à l'application https://lendingsandbox.crbcos.com/preapproval/v1
2.6. Collection du facteur
Pour faciliter le développement, nous avons mis en place un ensemble de fonctionnalités pré-intégrées.
Collection du facteur Requêtes pour toutes les requêtes concernant Cross River. Utilisez cette collection pour explorer, tester et créer des points de terminaison d'API. Intégrez votre projet directement dans Postman, avec un minimum de code et de configuration supplémentaires. Pour dupliquer immédiatement notre collection, cliquez ici.
Il vous suffit de compléter les détails de configuration et de commencer à passer des appels dans la collection Sandbox Postman. à travers .
Facteur
jeton d'accès (porteur)
Nous avons créé un environnement de test Postman pour développeurs afin de fournir un espace sécurisé pour tester les API Cross River. Dans la collection Postman Cross River, l'authentification s'effectue à l'aide d'un jeton d'accès.
Pour obtenir les identifiants, vous devez configurer le jeton d'accès (jeton porteur) requis pour exécuter la collecte :
1. Avec ces identifiants, vous demandez et recevez un jeton d'accès.
Obtenir les identifiants API
à utiliser pour l'envoi d'API dans notre environnement sandbox
2. Une fois que vous aurez reçu vos identifiants API et avant de pouvoir utiliser notre
Obtenir un jeton d'accès
Pour les API, vous obtenez un jeton d'accès en utilisant l'API. client_id et client_secret que vous avez reçu lors de votre inscription.
Collection Fork Cross River
Rendez-vous directement sur notre site pour découvrir notre collection.
Espace de travail du facteur
Une fois le processus créé, n'oubliez pas de configurer vos variables d'environnement pour le sandbox.
Configurez votre environnement Postman
Pour utiliser la collection que vous venez de créer, accédez-y et cliquez Environnements, et sélectionnez Bac à sableCopiez votre identifiant client Cross River et votre clé secrète, puis collez-les dans le champ prévu à cet effet. client_Id et client_secret Les champs. Pour les paiements par carte, collez-les dans les champs. ptpe_client_id et ptpe_client_secret champs.
Vous êtes maintenant prêt à obtenir un jeton et à commencer à envoyer des requêtes.
1. Courir Jeton d'autorisation/d'obtention pour générer votre jeton. Pour les paiements par carte, exécutez Paiements par carte/Autorisation/Obtenir un jeton P2PE .
2. La variable {{token}} (ou jeton ptpe Un jeton (pour les paiements par carte) est automatiquement ajouté à votre environnement par un script de post-réponse. Lorsque ce jeton expire, vous devez répéter l'étape 1.
3. Plusieurs variables peuvent être nécessaires selon le point de terminaison utilisé. Par exemple :ample, identifiant_partenaire , identifiant_produit , configuration_id et rappel_url .
4. Certaines variables sont également renseignées par des scripts, telles que : jeton et jeton ptpe ce champ ne doit pas être rempli manuellement.
Pingthesandbox
Effectuez un test simple pour vérifier que vous pouvez vous connecter à l'environnement de test de Cross River.
Pour envoyer une requête Ping, ouvrez Postman. Collections > Collection API Cross River > Autorisation et exécutez le Ping point final.
Demandes de modification
Pour mettre à jour une demande, effectuez vos modifications sur le Corps tab. Valeurs en double curlLes crochets « y » extraient des données de vos variables d'environnement. Consultez notre documentation API pour savoir quels champs chaque champ est utilisé.
Le point de terminaison accepte, et view demandes dans votre langue préférée.
3. Construire commeample app
Étape 1
Obtenir les identifiants API Installation
Étape 2
Obtenir un jeton d'accès
Étape 3
Utiliser le jeton d'accès
Étape 4
Construisez un Sampl'application
Avant de commencer, consultez notre guide de démarrage rapide pour vous connecter à nos API. Pour tester les appels d'API, vous pouvez utiliser cURL depuis la ligne de commande, ou un service tel que Postman ou Swagger dans notre environnement de test.
Clients et comptes
Avant d'utiliser les services de Cross River, vous devez créer un compte. fiche client pour chacun de vos clients
Cartes
Gérez les cartes de vos clients en collaborant avec Cross River pour décider de ce que vous souhaitez proposer, comme des cartes physiques ou virtuelles.
Prêt
: Le module Prêts comprend un ensemble d'appels d'API de prêt vous permettant de créer, de mettre à jour, et gérer vos prêts.
3.1. Installation
Avant de commencer, consultez notre guide de connexion à nos API. Pour tester le guide de démarrage rapide de l'API, cliquez ici.
appels, vous pouvez utiliser cURL depuis la ligne de commande, ou un service tel que Postman ou Swagger dans notre environnement de test.
Pour créer une application de carte ou de paiement, vous devez créer des clients et des comptes.
Explorez le bac à sable
Nous avons tout à vous proposer pour explorer. Le bac à sable est un environnement de bac à sable totalement isolé. Vous pouvez expérimenter librement depuis l'environnement de production. Lorsque vous serez prêt à passer en production, contactez votre responsable de compte, qui vous fournira les identifiants d'accès à l'environnement réel.
Inscription pertinente web événements de crochet
WebLes hooks sont un élément important de toute intégration avec Cross River. Si les API permettent de demander des données à la demande, webLes hooks envoient des mises à jour en temps réel directement à votre système, éliminant ainsi le besoin d'interrogations constantes et réduisant la latence. Dans de nombreux cas, webLes hooks sont plus efficaces et fiables que les API seules, garantissant ainsi que votre application reste synchronisée avec les événements critiques tels que les modifications de compte, les mises à jour de transactions et les résultats de traitement.
Registre recevoir webÉvénements de crochetage. Quand webLes événements de hook sont déclenchés, l'événement Les objets sont envoyés à l'adresse enregistrée URLs.
3.2. Clients et comptes
Étape 1
Obtenir les identifiants API
Étape 2
Obtenir un jeton d'accès
Étape 3
Utiliser le jeton d'accès
Étape 4
Construisez un Sampl'application
Créer une fiche client et un compte approvisionné :
Créer une fiche client
Créer un compte de dépôt
Approvisionner un compte
Créer un enregistrement client
Avant d'utiliser les services de Cross River, vous devez créer un enregistrement client pour chacun d'eux.
vos clients. Le processus d'intégration client comprend la création d'un dossier client avec les informations client pertinentes.
Tous les clients sont automatiquement analysés à des fins de conformité réglementaire. Vous devez donc vous inscrire aux services concernés. webUtilise des hooks d'événements pour recevoir les mises à jour de l'état des dossiers clients.
Le dossier client peut concerner soit Personnel or Entreprise clients. Une fois inscrit, un client peut être associé à un ou plusieurs comptes.
Webcrochets
Registre pour webhameçons. La suite webDes crochets sont utilisés :
WebDescription du crochet
|
Core.Customer.Onboarded |
Vous informe que la fiche client a été créée. |
|
Core.Customer.Ofac.Changed |
Vous informe que le statut OFAC d'un client a été mis à jour. |
Core.Customer.PepScan.Changed
Nvous informe que le statut PEP d'un client a été mis à jour
Exampcréation d'enregistrements de Leof
Dans cet exampAlors, nous allons intégrer John Smith. Tout d'abord, créons une fiche client. Nous enregistrons John en tant que… Personnel client.
Pour intégrer un client professionnel, commencez par créer une fiche client personnelle pour celui-ci. propriétaire principal de cette entreprise. Ensuite, créez un client professionnel et ajoutez l'enregistrement personnel en tant que bénéficiaire effectif.
1 Appel POST /core/v1/cm/clients .
Dans l'exemple suivantampVous pouvez voir que les attributs requis sont ceux que vous pouvez consulter.
IMPORTANT
Nous vous recommandons vivement d'inclure une clé d'idempotence dans l'en-tête de votre requête.
afin de fournir une protection redondante en cas de défaillance.
Curl
curl -X POST /core/v1/cm/clients –header 'Content-Type: application/j {
« partnerId »: “6e80b097-693c-4592-8440-02f345335bbf”,
"nom": {
"prénom": "John",
"nom de famille": "Forgeron"
},
"classification": "Personnel",
"profile”: {
« regO »: FAUX,
«Personne politiquement exposée»: FAUX,
« taxIdType »: « SSN »,
« taxId »: « 119988776 »,
« date de naissance »: « 1953-09-22 »,
« Évaluation du risque »: "Faible"
« adresse principale »: {
« type d’adresse »: "Maison",
"classification": "Résidentiel",
« isPrimary »: vrai,
« rue 1 »: « 123 Any St »,
"ville": "N'importe où",
"État": "NEW YORK",
"Code Postal": « 12345 »,
« code pays »: "NOUS"
},
« téléphone principal »: {
« isPrimary »: vrai,
« type de téléphone »: "Maison",
« numéro de téléphone »: « 2015551234 »
},
« primaryEmail »: {
« isPrimary »: vrai,
« emailType »: "Personnel",
« adresse email »: « John.Smith@xxxxx.com »
}
}
Un appel API réussi renvoie une réponse JSON contenant l'identifiant client unique sur la première ligne du corps de la réponse. Votre client a été créé.
Intégration d'un organisme de réponse aux clients
{
"identifiant": “9052b6a5-3f09-41d1-b526-ade80104eb79”,
« numéro cif »: « 32653745014 »,
"classification": "Personnel",
"statut": "Actif",
« ofac »: "En attente",
« pepScan »: "En attente",
"nom": {
"prénom": "John",
"nom de famille": "Forgeron",
"nom et prénom": « John Smith »
},
"profile”: {
« regO »: FAUX,
«Personne politiquement exposée»: FAUX,
« activerBackupWithholding »: FAUX,
« taxIdType »: « SSN »,
« taxId »: « 119988776 »,
« date de naissance »: « 1953-09-22 »,
« Évaluation du risque »: "Faible"
},
« crééÀ »: “2021-01-25T17:55:24.4422582-05:00”,
« lastModifiedAt »: “2021-01-25T17:55:24.4432543-05:00”,
« partnerId »: “6e80b097-693c-4592-8440-02f345335bbf”
}
2 Le Core.Customer.Onboarded webL'événement de hook est déclenché lors de la création de l'enregistrement client.
Événement d'intégration client
{
"identifiant": “3d9c5e1a-623b-4cf2-812e-ade80105048e”,
« nom_événement »: « Core.Customer.Onboarded »,
"statut": "En attente",
« partnerId »: “30dee145-b6a2-4058-8dc3-ac4000dee91f”,
« crééÀ »: “2021-11-22T10:50:20.553-05:00”,
"ressources": [
“core/v1/cm/customers/9052b6a5-3f09-41d1-b526-ade80104eb79” ],
"détails": []
}
Cross River vérifie la conformité des nouveaux dossiers clients avec les normes OFAC et PEP.
Parfois, les résultats du scanner nécessitent une nouvelle analyse.view par notre équipe de lutte contre le blanchiment d'argent (LCB).
Une fois le scan terminé, Core.Customer.Ofac.Changed et
Core.Customer.PepScan.Changed webLes événements de hook renvoient un statut. Les clients sans problème de conformité affichent un Clair statut.
Scan OFAC du client modifié
{
"identifiant": “45db5592-56ee-41f5-85e7-ade8010571ce”,
« nom_événement »: « Core.Customer.Ofac.Changed »,
"statut": "En attente",
« partnerId »: “30dee145-b6a2-4058-8dc3-ac4000dee91f”,
« crééÀ »: “2021-11-22T10:51:53.657-05:00”,
"ressources": [
“core/v1/cm/customers/9052b6a5-3f09-41d1-b526-ade80104eb79” ],
"détails": []
}
Le scan PEP du client a été modifié
{
"identifiant": “a5000831-3e01-4231-9ec2-ade8010571c5”,
« nom_événement »: « Core.Customer.PepScan.Changed »,
"statut": "En attente",
« partnerId »: “30dee145-b6a2-4058-8dc3-ac4000dee91f”,
« crééÀ »: “2021-11-22T10:51:53.597-05:00”,
"ressources": [
“core/v1/cm/customers/9052b6a5-3f09-41d1-b526-ade80104eb79” ],
"détails": []
}
Vous avez maintenant créé une fiche client.
Mise à jour de la fiche client
Il est possible de mettre à jour les informations client telles que l'adresse, le numéro de téléphone et l'adresse électronique. Ces informations sont prises en compte. primaire informations. Si vous ajoutez une deuxième adresse, il s'agit de secondaire.
1 Utilisez l'identifiant client renvoyé lors de la création de l'enregistrement client pour appeler POST /core/v1/cm/customers/{id}/addresses pour ajouter le . La première adresse du client
L'adresse que vous ajoutez est l'adresse primaire adresse. Dans l'exemple suivantampvous pouvez ainsi voir quels attributs sont requis.
Mettre à jour l'adresse du client
POST /core/v1/cm/customers/9052b6a5-3f09-41d1-b526-ade80104eb79/addresse {
« type d’adresse »: "Maison",
"classification": "Résidentiel",
« isPrimary »: vrai,
« rue 1 »: « 123 Any St »,
"ville": "N'importe où",
"État": "NEW YORK",
"Code Postal": « 12345 »,
« code pays »: "NOUS"
}
2 Appel POST /core/v1/cm/customers/{id}/phones pour ajouter le
téléphone du client
Le premier numéro de téléphone que vous ajoutez est le primaire numéro de téléphone.
nombre
Mettre à jour le numéro de téléphone du client
POST /core/v1/cm/customers/9052b6a5-3f09-41d1-b526-ade80104eb79/phones {
« isPrimary »: vrai,
« type de téléphone »: "Mobile",
« numéro de téléphone »: « 2015552345 »
}
3 Appel POST /core/v1/cm/customers/{id}/email pour mettre à jour l'adresse e-mail du client
Mettre à jour l'email du client
POST /core/v1/cm/customers/9052b6a5-3f09-41d1-b526-ade80104eb79/email {
« isPrimary »: vrai,
« emailType »: "Personnel",
« adresse email »: « john.jones@xxx.com »
}
Créer un compte de dépôt
CR propose différents types de comptes, notamment des comptes chèques et d'épargne, des certificats de dépôt (CD ou comptes à terme), et bien plus encore.
Pour ouvrir un compte de dépôt, quel qu'il soit, vous devez disposer d'un identifiant de produit valide pour le type de compte souhaité, ainsi que d'un identifiant client (identifiant du dossier client enregistré) pour le titulaire du compte. Veuillez noter que le titulaire du compte doit avoir au moins une adresse et un numéro de téléphone enregistrés, et que son statut OFAC doit être valide. ClairDe plus, la classification du client doit correspondre à la classification configurée pour le produit. Par exemple :ampSeuls les clients professionnels peuvent être ajoutés à un produit destiné aux entreprises.
Avant de commencer
Assurez-vous d'avoir :
Identifiants API
Identifiant partenaire (que vous avez reçu lors de votre inscription)
ID client
Identifiant du produit (définit le type de compte ouvert)
IMPORTANT
Nous vous recommandons vivement d'inclure une clé d'idempotence dans l'en-tête de la requête. pour éviter les paiements en double en cas de défaillance.
Points d'extrémité et webcrochets
Le point de terminaison API suivant est utilisé :
Description de l'API
Ouvrir un compte de dépôt. Ouvre un compte de dépôt pour un client.
Ce qui suit webUn crochet est utilisé :
WebDescription du crochet
Compte principal ouvert Un nouveau compte a été ouvert.
Ouvrir un compte
Dans le scénario suivant, vous ouvrirez un compte pour John Smith, un client que vous avez intégré avec succès.
Ouvrir un compte
1 Appel POST core/v1/dda/accounts Pour cet appel, certains attributs sont requis. Voir la documentation complète.
liste des attributs
Sampla demande
POST /core/v1/dda/accounts
{
« customerId »: “59e3bc15-bbec-4990-88e9-a9a600d3296c”,
« productId »: “44015e68-1afb-40fc-9497-abc1014f52da”,
"titre": « John Smith »,
« adresse de déclaration »: {
« rue 1 »: « 257 Dalton Groves »,
"ville": « Barton City »,
"État": "MI",
"Code Postal": « 48705 »,
« code pays »: "NOUS"
}
}
2 Un appel API réussi renvoie une réponse JSON contenant les détails du nouveau compte.
Sampla réponse
POSTE /cœur/v1/dda/comptes
{
« customerId »: “59e3bc15-bbec-4990-88e9-a9a600d3296c”,
« productId »: “44015e68-1afb-40fc-9497-abc1014f52da”,
"titre": « John Smith »,
« adresse de déclaration »: {
« rue 1 »: « 257 Dalton Groves »,
"ville": « Barton City »,
"État": "MI",
"Code Postal": « 48705 »,
« code pays »: "NOUS"
}
}
3 Le numéro de compte Ce champ permet de saisir le numéro de compte du nouveau compte.
4 Dans la réponse example, le compte est classé comme Personnel parce que l'utilisateur a configuré la classification du produit comme PersonnelLa classification du compte correspond toujours à la classification du produit configurée.
5 Le statut du compte est automatiquement mis à jour. Actif et est immédiatement disponible à l'utilisation. Cela déclenche le Compte principal ouvert événement.
Détails de l'événement Core.Account.Opened
{
"identifiant": “259cdbca-6a89-4af8-a50e-ada3010fb13f”,
« nom_événement »: « Compte principal ouvert »,
"statut": "En attente",
« partnerId »: “e6c3824a-377f-44d5-a2f6-a9a600c9b37e”,
« crééÀ »: “2021-01-26T09:48:10.1011462-05:00”,
"ressources": [
« core/v1/dda/accounts/2235223803 »
],
"détails": []
}
Compte de fonds
Lorsque vous travaillez dans l'environnement de test pour tester les systèmes de paiement et le comportement des comptes, vous devez disposer de fonds sur un compte.
Vous pouvez utiliser n'importe quel rail disposant d'un point de terminaison de simulation entrant pour alimenter un compte sandbox, si ce compte est configuré à cet effet. Plus précisément, vous pouvez :
Simuler les paiements ACH entrants
Simuler un câble entrant
Pour toute simulation, vous aurez besoin du numéro du compte sandbox Cross River que vous souhaitez alimenter. Les informations concernant l'émetteur n'ont aucune importance et peuvent même, dans certains cas, être totalement fictives.
Prochaines étapes
Consultez notre mode de paiement.
tutoriels
3.3. Cartes
Étape 1
Obtenir les identifiants API
Étape 2
Obtenir un jeton d'accès
Étape 3
Utiliser le jeton d'accès
Étape 4
Construisez un Sampl'application
Apprenez à utiliser les API de Cross River. Cette page vous explique comment :
Créer une carte
Activer une carte
Créer une carte
Gérez les cartes de vos clients en collaborant avec Cross River pour déterminer ce que vous souhaitez proposer, comme des cartes physiques ou virtuelles. configuration de la carteCross River crée un pro de configuration de cartefile pour vous, pour chaque type que vous choisissez pour votre instrument financier clients.
Avant de commencer
Assurez-vous de faire et d'avoir :
Créer une fiche client
Créer un compte de dépôt
Numéro de compte du titulaire de la carte
Identifiant client (vous l'obtenez lors de la création d'un client)
ID de configuration (Cross River vous fournit un ID lorsque vous configurez votre type/carte)
Nous vous recommandons également de consulter les informations pertinentes. webévénements de crochet. inscription
Points d'extrémité etwebcrochets
Registre pour webpoints d'accès. Les points de terminaison d'API suivants sont utilisés :
Description de l'API
Demande de création d'une nouvelle carte de débit
Ce qui suit webDes crochets sont utilisés :
WebDescription du crochet
Cartes.Carte.Créée Carte de débit créée
Commander une carte
Vous apprendrez comment commander/créer une nouvelle carte de débit en créant une carte pour John Smith.
1 Appel POST /cardmanagement/v1/cards .
Dans l'exemple suivantampVous pouvez ainsi voir quels attributs sont requis. Consultez les détails de l'API complète.
Ajouter une carte
Sampcréer une carte
curl -X POST /cardmanagement/v1/cards –header 'Content-Type: application "accountNumber": "2608927303", \
“customerId”: “2b15a695-13dc-4b10-b4e5-af5b0138873c”, \
« configurationId » : « a6b5a94c-f8f9-462b-8ce8-afa400f5b640 », « prénom » : « John »,
« nom de famille » : « Smith », \
"téléphone": { \
« phoneType » : « Domicile », \
« phoneNumber » : « 9133413131 » \
}, \
« emailAddress » : « John.Smith@xxxxx.com », \
"adresse de livraison": { \
« rue1 » : « Lane Ave », \
« street2 » : « chaîne », \
« ville » : « Grande ville », \
« état » : « IL », \
« code postal » : « 72410 », \
« countryCode » : « US » \
}, \
"adresse de facturation": { \
« rue1 » : « Lane Ave », \
« street2 » : « chaîne », \
« ville » : « Grande ville », \
« état » : « IL », \
« code postal » : « 72410 », \
« countryCode » : « US » \
}, \
« nomSurCarte » : « John Smith », \
« shippingType » : « Normal », \
« clientIdentifier » : « chaîne » \
}' 'https://sandbox.crbcos.com/CardManagement/v1/cards'
2 Un appel API réussi renvoie une réponse JSON contenant les détails de la nouvelle carte. Le statut de la carte restera inactif jusqu'à ce que vous l'activiez. L'identifiant correspond à l'identifiant de la carte. example 8709163d-140c-4d95-a111-afa8009e9cd1, dont vous aurez besoin pour activer la carte.
Sampla réponse à la commande d'une carte
{
"identifiant": “8709163d-140c-4d95-a111-afa8009e9cd1”, « partnerId »: “cd9c12f4-7691-424a-b38b-af5b0134c611”, « productId »: “83bed086-8182-4151-a1e3-af5b01362783”, « numéro de compte »: « 2608927303 »,
"statut": « Non activé »,
« statusReasonCode »: « Non défini »,
"prénom": "John",
"nom de famille": "Forgeron",
"adresse de livraison": {
« rue 1 »: « Lane Ave »,
« rue 2 »: "chaîne",
"ville": « Grande ville »,
"État": «IL»,
"Code Postal": « 72410 »,
« code pays »: "NOUS"
},
"adresse de facturation": {
« rue 1 »: « Lane Ave »,
« rue 2 »: "chaîne",
"ville": « Grande ville »,
"État": «IL»,
"Code Postal": « 72410 »,
« code pays »: "NOUS"
},
"téléphone": {
« type de téléphone »: "Maison",
« numéro de téléphone »: « 9133413131 »
},
« adresse email »: « john@anygoogle.com »,
« nomSurCarte »: « John Smith »,
« isPinSet »: FAUX,
« adminBlocked »: FAUX,
« Suspect de fraude »: FAUX,
« configurationId »: “a6b5a94c-f8f9-462b-8ce8-afa400f5b640”, "catégorie": "Crédit",
« instrument de paiement »: « VirtualPan »,
"processeur": « nom du processeur »,
« type d’expédition »: "Normale",
« État de la commande »: « Commande en attente »,
« statut de remplacement »: « Non applicable »,
« customerId »: “2b15a695-13dc-4b10-b4e5-af5b0138873c”, « identifiantclient »: "chaîne",
« crééÀ »: “2023-02-13T04:37:29.4869172-05:00”,
« lastModifiedAt »: “2023-02-13T04:37:29.4869172-05:00”
}
3 Le Cartes.Carte.créée webL'événement de crochet est déclenché lorsque la carte est générée par le processeur.
Sampl'événement Cards.Card.Created
{
"identifiant": “cea6c5b5-13e7-4c2f-ba75-afce01110fe5”,
« nom_événement »: « Cartes.Carte.Créée »,
"statut": "En attente",
« partnerId »: “cd9c12f4-7691-424a-b38b-af5b0134c611”,
« crééÀ »: “2023-02-13T04:42:29.4869172-05:00”,
"ressources": [
“cardmanagement/v1/cards/8709163d-140c-4d95-a111-afa8009e9cd1” ],
"détails": [
{
« cardId »: “8709163d-140c-4d95-a111-afa8009e9cd1”,
"statut": « Non activé »,
« statusReasonCode »: « Non défini »
}
]
}
Activer la carte
Avant de commencer
Assurez-vous d'avoir :
Identifiants API
Identifiant de la carte utilisé lors de votre commande
Points d'extrémité etwebcrochets
Description de l'API
La requête POST /cardmanagement/v1/cards/{id}/activate active la carte à l'aide de son identifiant. Ce tutoriel utilise ces informations. webcrochets:
WebDescription du crochet
Cartes.Carte.Activée Carte de débit activée
Activer la carte
Activez la carte que vous avez créée dans le stage.
créer une carte
1 Appel POST /cardmanagement/v1/cards/{id}/activate . Le id L'attribut doit être défini sur l'identifiant de la carte. Dans le sample ci-dessous de l'ID est 8709163d-140c-4d95-a111 afa8009e9cd1.
Sampactiver la demande de carte
curl -X POSTE
–header 'Accepter: application/json'
–header 'Autorisation : Porteur '<jeton>'
https://sandbox.crbcos.com/CardManagement/v1/cards/8709163d-140c-4d95-a1
2 Un appel API réussi renvoie une réponse JSON contenant les détails de la carte. La carte statut est maintenant activé. Le État de la commande is Complété.
Sampactiver la réponse de la carte
{
"identifiant": “8709163d-140c-4d95-a111-afa8009e9cd1”, « partnerId »: “cd9c12f4-7691-424a-b38b-af5b0134c611”, « productId »: “83bed086-8182-4151-a1e3-af5b01362783”, « processorCardId »: « 804951250206718 »,
« numéro de compte »: « 2608927303 »,
"statut": "Actif",
« statusReasonCode »: « Non défini »,
"prénom": "John",
"nom de famille": "Forgeron",
"adresse de livraison": {
« rue 1 »: « Lane Ave »,
« rue 2 »: "chaîne",
"ville": « Grande ville »,
"État": «IL»,
"Code Postal": « 72410 »,
« code pays »: "NOUS"
},
"adresse de facturation": {
« rue 1 »: « Lane Ave »,
« rue 2 »: "chaîne",
"ville": « Grande ville »,
"État": «IL»,
"Code Postal": « 72410 »,
« code pays »: "NOUS"
},
"téléphone": {
« type de téléphone »: "Maison",
« numéro de téléphone »: « 9133413131 »
},
« adresse email »: « john@anygoogle.com »,
« nomSurCarte »: « John Smith »,
« panLastFour »: « 3629 »,
« isPinSet »: FAUX,
« date d’expiration »: « 2026-02-13 »,
« adminBlocked »: FAUX,
« Suspect de fraude »: FAUX,
« configurationId »: “a6b5a94c-f8f9-462b-8ce8-afa400f5b640”, "catégorie": "Crédit",
« instrument de paiement »: « VirtualPan »,
"processeur": « nom du processeur »,
« type d’expédition »: "Normale",
« État de la commande »: "Terminé",
« statut de remplacement »: « Non applicable »,
« customerId »: “2b15a695-13dc-4b10-b4e5-af5b0138873c”,
« identifiantclient »: "chaîne",
« ID du client processeur »: “T83E9D675A3N3N9O8RZ1”,
« crééÀ »: “2023-02-13T04:37:29.487-05:00”,
« activation initiale »: “2023-02-13T00:00:00-05:00”,
« activéÀ »: “2023-02-13T04:43:19.282287-05:00”,
« lastModifiedAt »: “2023-02-13T04:43:19.2962845-05:00”
}
3 Lorsque le statut de la carte passe à Actif , le Cartes.Carte.Activée webDéclenchement d'événements de crochet.
Cartes.Carte.Activée webévénement de crochet
{
"identifiant": “95ac33ca-3d7f-49aa-bfc2-afce01113310”,
« nom_événement »: « Cartes.Carte.Activée »,
"statut": "En attente",
« partnerId »: “cd9c12f4-7691-424a-b38b-af5b0134c611”,
« crééÀ »: “2023-02-13T04:44:31.282287-05:00”,
"ressources": [
“cardmanagement/v1/cards/8709163d-140c-4d95-a111-afa8009e9cd1” ],
"détails": [
{
« cardId »: “8709163d-140c-4d95-a111-afa8009e9cd1”,
"statut": "Actif",
« statusReasonCode »: « Non défini »
3.4. Prêt
Étape 1
Obtenir les identifiants API
Étape 2
Obtenir un jeton d'accès
Étape 3
Utiliser le jeton d'accès
Étape 4
Construisez un Sampl'application
Le module de prêt comprend un ensemble d'appels permettant de créer, de mettre à jour et de gérer une API de prêt. vos prêts.
Pour commencer à travailler dans le secteur du prêt, assurez-vous de :
Recevez les identifiants API avec les autorisations nécessaires pour les prêts.
Si vous avez créé les identifiants API à l'aide de la gestion en libre-service
, alors vous devriez également envoyer une demande à
arix.support@crossriver.com
Organisation, ainsi que votre identifiant client et votre MPLID, pour compléter la Création.
Utilisez le périmètre approprié pour les API que vous souhaitez utiliser.
Le périmètre de l'API pour le bac à sable est : CosLending:PreApproval:stg
Bac à sable
Base de modules URL pour les appels API Description
Prêt création
décision relative à l'application
|
https://arixapisandbox.crbnj. net |
La base URL pour les appels d'API d'octroi de prêts à l'environnement sandbox d'Arix |
|
https://lendingsandbox.crbco s.com/preapproval/v1 |
La base URL pour le bac à sable de décision d'application |
Fanfaronnade
Lien Swagger du module
|
Référence API documentation |
https://arixapisandbox.crbnj.net/swagger-ui |
|
Crochets |
https://lendingsandbox.crbcos.com/hooks/swagger/inde x.html |
Vente de https://lendingsandbox.crbcos.com/selling/swagger/index.html
Page d'état
Pour consulter la liste des prochaines versions, suivez l'état actuel de l'API, view Pour signaler un incident ou être informé des opérations de maintenance planifiées, consultez notre page d'état et abonnez-vous aux alertes.
4. Configuration du programme
Configurer le SFTP: Utilisez SFTP pour envoyer fileou de les télécharger depuis Cross River, selon vos besoins et les nôtres.
Intégration des clients: Gérez les informations de vos clients dans la région de Cross River. système d'exploitation (COS) utilisant soit des API, soit l'explorateur COS
Types et identifiants de produits COS : Explication des types et identifiants de produits COS.
Explorateur COS : Comment utiliser notre explorateur COS.
Portail de gestion des organisations : Comment utiliser notre portail de gestion des organisations.
4.1. Configurer le SFTP
Lorsque vous devez échanger des informations sensibles dans un file Pour utiliser le format Cross River, nous vous demandons d'utiliser Secure. File Protocole de transfert (SFTP). Utilisez SFTP pour envoyer fileVous pouvez les télécharger depuis Cross River, selon vos besoins et les nôtres. Dans certains cas, vous ou nous les chiffrerons. files, en particulier s’ils contiennent des informations personnelles identifiables (IPI).
Utilisation de SFTP
Le protocole SFTP vous permet d'envoyer et de recevoir en toute sécurité des données sensibles. fileTéléchargez et chargez des rapports dans un dossier dédié à votre entreprise sur un serveur sécurisé. fileparcourez ce dossier ou ses sous-dossiers, selon vos besoins spécifiques.
Utilisation du chiffrement
Cryptage files ajoute une couche de protection supplémentaire. Seul le personnel autorisé possédant la clé appropriée pourra déchiffrer les données chiffrées. fileÀ Cross River, nous utilisons le chiffrement PGP.
Commencer
Plusieurs étapes sont nécessaires pour la mise en service de notre serveur SFTP.
1 Vous remplissez le formulaire de demande d'accès IP pour les services SFTP de Cross River (depuis votre RM).
Si vous devez partager fileSi vous êtes client de Cross River, votre gestionnaire de compte vous enverra un formulaire de demande d'accès IP pour les services SFTP de CRB. Vous devrez notamment fournir les adresses IP publiques statiques que vous utiliserez pour accéder au dossier SFTP, ainsi qu'une clé publique PGP pour le chiffrement et le déchiffrement. fileVeuillez renvoyer le formulaire rempli à votre gestionnaire de compte.
IMPORTANT
Cross River n'autorisera que 5 adresses IP ; veuillez en tenir compte. Ces adresses IP doivent être statiques. Par conséquent, vous devrez configurer un proxy pour tout trafic non statique.
2 Nous configurons votre structure de dossiers SFTP.
Une fois que Cross River a reçu vos informations, notre service informatique crée pour vous un ensemble standard de dossiers et de sous-dossiers. Ce chemin d'accès unique est exclusivement réservé à votre entreprise. Aucun autre partenaire ne peut y accéder. Le service informatique vous envoie un courriel contenant les informations nécessaires pour accéder aux dossiers, ainsi qu'un lien vers vos identifiants. Cross River ne conserve jamais votre mot de passe !
IMPORTANT
Le lien n'est valable que quelques jours ; après quoi, vous devrez demander une réinitialisation de mot de passe si vous ne l'utilisez pas.
Les identifiants deviennent également invalides si plus de deux personnes accèdent au lien..
3 Test de chargement SFTP.
Si vous fournissez filePour Cross River, votre service informatique devrait créer un compte de service avec un processus automatisé pour le téléchargement de ces fichiers. fileVeuillez transférer les fichiers vers vos dossiers SFTP. Nous vous recommandons vivement de tester cette procédure avant d'envoyer des données réelles. Pour toute question ou problème, veuillez contacter votre responsable de compte ou ouvrir un ticket auprès de votre support technique de premier niveau.
4 Configurer PGP pour envoyer ou recevoir filede Cross River. (Cette étape est nécessaire uniquement si vous envoyez ou recevez des renseignements personnels. Veuillez vérifier auprès de votre responsable régional.)
Si vous devez envoyer Cross River fileNous vous enverrons d'abord notre clé publique PGP pour chiffrer ces données. files.
Vous auriez déjà dû envoyer votre clé publique PGP à Cross River pour recevoir filede notre part.
5 Partagez vos données.
Une fois votre dossier SFTP configuré et votre processus en place, vous pouvez commencer le partage. fileVous êtes en contact avec nous. Votre gestionnaire de compte vous indique s'il y a des démarches supplémentaires à effectuer pour recevoir des rapports, ou comment préparer les données à nous envoyer.
Rapports spécifiques
Apprenez-en davantage sur la préparation et l'envoi des rapports et files pour:
Comptes et paiements
paiements par carte
Risque de crédit
Prêt
Paiements par lots XML (ISO 20022)
4.2. Intégration des clients
Gérez les informations de vos clients dans le système d'exploitation Cross River (COS) via les API ou l'explorateur COS. Ces informations comprennent les données de base nécessaires à l'ouverture d'un compte bancaire.
un compte ou l'utilisation d'une carte de crédit, ainsi que des données plus spécifiques sur le client, selon les besoins. Nous appelons cela un dossier client.
Avant de pouvoir ouvrir un compte de dépôt ou créer une carte, vous devez créer le dossier client, parfois appelé IntégrationVous pouvez ensuite attribuer un ou plusieurs clients à un compte via le client. relations.
Le processus d'intégration client comprend la création d'un compte avec les informations client pertinentes. Informations client. Suivez ce tutoriel pour créer une fiche client pour chacun d'entre vous..
étapes facultatives
Ajouter les détails d'identification
Ajouter un bénéficiaire effectif
codes d'erreur
Voir, ainsi que de nombreuses autres informations de référence, les codes d'erreur du système COS.
page des codes de référence.
4.2.1. Dossier client
Dossier client
La fiche client est la principale source d'informations client dans le système Cross River. Par conséquent, avant de créer un compte pour un client, vous devez l'enregistrer. La fiche client prend en charge les catégories Particulier et Professionnel. Une fois enregistré, vous pouvez associer un client à un ou plusieurs comptes.
L'exampLe schéma ci-dessous montre comment intégrer un client pour un client particulier.
Demande de personne à bord
POST /core/v1/cm/clients {
« partnerId »: “7cc038be-fde9-4455-b27b-1497cf667362”,
"nom": {
"préfixe": "M.",
"prénom": "John",
"deuxième prénom": « Robert »,
"nom de famille": "Forgeron",
"suffixe": « Jr. »,
« nom préféré »: « Jim » },
"classification": "Personnel",
"profile”: {
« regO »: FAUX,
« citizenshipCountryCode »: "NOUS",
«Personne politiquement exposée»: FAUX,
« activerBackupWithholding »: FAUX,
« backupWithholdingPercent »: 0,
« taxIdType »: « SSN »,
« taxId »: « 123456789 »,
« date de naissance »: « 1965-09-15 »,
« Évaluation du risque »: "Faible",
« privacyOptOut »: vrai }
} Intégrez un client professionnel, tel qu'une société ou une SARL, en utilisant le même point de terminaison avec des attributs légèrement différents.
Curl
POST /core/v1/cm/clients {
« partnerId »: “a24cba49-2bb6-431d-a867-1de81d6e4127”,
"nom": {
« nom_entité »: « ACME CO », },
"classification": "Entreprise",
"profile”: {
« citizenshipCountryCode »: "NOUS",
« activerBackupWithholding »: FAUX,
« backupWithholdingPercent »: 0,
« taxIdType »: « Ein »,
« taxId »: « 123456789 »,
« dateFormed »: « 2019-09-10 »,
« type d'entité »: "Corporation",
« Évaluation du risque »: "Faible",
« type de propriété »: « Entité juridique »,
« primaryOwnerCustomerId »: “f9321f7f-3712-46e1-b965-2b79ead64dc9”, } }
Que vous intégriez un client particulier ou professionnel, le Propriétaire principal CustomerId L'attribut doit contenir un identifiant client faisant référence à un enregistrement client de type Personnel. Par conséquent, pour intégrer une entreprise, vous devez d'abord créer un enregistrement client personnel pour le propriétaire principal de cette entreprise.
IMPORTANT
Certains points de terminaison client incluent un vérifications nécessaires Cette ressource peut être nécessaire ou non lors de l'intégration de clients particuliers. Votre interlocuteur dédié à la conformité vous communiquera les exigences relatives aux vérifications préalables tout au long de votre processus d'intégration.
bénéficiaires
Un bénéficiaire effectif est une personne qui détient 25 % ou plus d'une entreprise. Pour des raisons réglementaires, vous devez prévoir des ressources dans un Entreprise L'enregistrement client crée un bénéficiaire effectif
pour chaque bénéficiaire effectif de cette entreprise. propriétaireCustomerId L'attribut fait référence à la fiche client personnelle de chaque bénéficiaire effectif. Les ressources du bénéficiaire effectif sont généralement ajoutées à la fiche client professionnelle immédiatement après l'intégration de l'entreprise.
Curl
POST /core/v1/cm/customers/{customerId}/beneficial-owners {
« ownerCustomerId »: “c1210a2d-932e-43ca-be29-f358a4382385”,
« ownerTitle »: "Président" }
Adresse
Les adresses physiques associées au client peuvent être .
mis à jour
Curl
POST /core/v1/cm/customers/{customerId}/addresses
{
« isPrimary »: vrai,
"statut": "Actif",
"classification": "Résidentiel",
« type d’adresse »: "Maison",
« rue 1 »: « 123, rue Maple »,
« rue 2 »: «Appartement 12»,
« rue 3 »: « »,
"ville": "New York",
"État": "NEW YORK",
"Code Postal": « 10025 »,
« code pays »: "NOUS",
}
adresses e-mail
Mettre à jour l'e-mail
Informations de contact pour le client.
Curl
POST /core/v1/cm/customers/{customerId}/emails {
« isPrimary »: vrai,
« emailType »: "Personnel",
« adresse email »: « john.smith@crossriver.com » }
Téléphones
Mettre à jour le téléphone Curl
Informations de contact pour le client.
POST /core/v1/cm/customers/{customerId}/phones
{
« type de téléphone »: "Maison",
« isPrimary »: vrai,
« numéro de téléphone »: « 2015551234 »
}
Identifications
Les identifiants servent à suivre les métadonnées des documents d'identité des clients, tels que les permis de conduire et les passeports. Ils peuvent être utilisés pour ajouter de nouvelles informations d'identification. Ajouter des informations d'identification
Curl
POST /core/v1/cm/customers/{customerId}/identifications {
« isPrimary »: vrai,
« numéro d’identification »: « DL123456789 »,
« idType »: "Le permis de conduire",
« date d’émission »: « 2018-08-30 »,
« expDate »: « 2018-08-30 »,
« date vérifiée »: « 2018-08-30 »,
"autorité de délivrance": « DMV du New Jersey »,
« État ou province émettrice »: "NEW JERSEY",
« émission du code pays »: "NOUS",
}
4.2.2. Types et identifiants de produits COS
À Cross River, un type de produit Il s'agit d'un produit financier personnalisé que vous proposez à vos clients. Par exemple :ampPar exemple, un type de produit peut être une carte de débit ou un compte d'épargne, configuré selon vos besoins et spécifications. Vous ouvrez des comptes pour vos clients avec n'importe quel type de produit que vous définissez et configurez avec nous. Contactez votre chargé de compte pour plus de détails, notamment sur la configuration des types de produits pour vos clients.
Par exempleampVous pourriez par exemple configurer un type de produit comme un compte d'épargne utilisant les virements bancaires et les paiements ACH. Vous pourrez ensuite proposer à vos clients des comptes d'épargne avec ces services et configurations.
Cross River vous fournit un identifiant produit pour chaque type de produit que vous souhaitez proposer à vos clients. Pour ouvrir un compte de dépôt, vous devez disposer d'un identifiant produit valide et d'un identifiant client (identifiant du dossier client enregistré) pour le titulaire du compte. Veuillez noter que le titulaire du compte doit avoir au moins une adresse et un numéro de téléphone enregistrés, et que son statut OFAC doit être conforme. ClairDe plus, la classification du client doit correspondre à la classification configurée pour le produit. Par exemple :ampSeuls les clients professionnels peuvent être ajoutés à un produit destiné aux entreprises.
4.2.3. Explorateur COS
Une fois que vous êtes intégré au système Cross River et que vous avez reçu l'e-mail de confirmation d'intégration
ton identité du client et Secrète Vous êtes prêt à vous connecter à COS Explorer. Accédez au portail COSExplorer
Production:
https://api.crbcos.com/explorer2/
Bac à sable :
https://sandbox.crbcos.com/explorer2/
Courriel de bienvenue
Vous recevrez un courriel de bienvenue de CrossRiver_NE_PAS_RÉPONDRE@crossriver.comSi vous ne le voyez pas dans votre boîte de réception, vérifiez vos dossiers de courriers indésirables ou de courriers bloqués.
Cliquez Créez votre compte Cross River.
Si vous quittez l'assistant à tout moment, cliquez sur le lien figurant dans l'e-mail d'origine pour revenir à l'endroit où vous vous étiez arrêté.
Termes et conditions
Lisez attentivement les conditions générales, vérifiez Accepter, et cliquez sur Suivant.
vérification par SMS (message texte)
Nous vous envoyons un SMS sur votre appareil pour vérifier votre identité. Saisissez le code à 6 chiffres que vous recevez sur l'écran de connexion et cliquez sur Code de vérification.
Créez votre mot de passe
1. Saisissez un mot de passe conforme aux exigences affichées à l'écran, puis confirmez-le.
2. Cliquez Créer un mot de passe.
configuration de l'application d'authentification
Vous devez accomplir cette étape pour poursuivre le processus d'inscription et pouvoir vous connecter ultérieurement.
Pour protéger votre identité, votre compte et vos informations, nous vous demandons de vous connecter avec une authentification multifacteurs/à deux facteurs.
Si vous n'avez pas déjà une application d'authentification sur votre appareil, vous devez en télécharger une avant de continuer.
Pour Android et iOS, nous recommandons d'utiliser l'application d'authentification suivante :
Google Authenticator
Authentificateur Microsoft
Une fois votre application d'authentification installée, vous devez soit scannez le code QR or Saisissez manuellement la clé dans l'application d'authentification.
Code QR
1. Scannez le code QR avec votre application d'authentification et, si nécessaire, saisissez le code à 6 chiffres sur la page d'authentification multifacteurs.
2. Cliquez sur continuer.
Manuel
1. Cliquez Afficher la touche
2. Copiez la clé comme suit : Secrète dans votre application d'authentification.
3. Entrez le code à 6 chiffres.
4. Cliquez Continuer.
Code MFA invalide
Si vous saisissez un code MFA invalide, un message rouge vous invite à réessayer.
Oups ! Vous avez saisi un code MFA invalide. Voici quelques points à vérifier :
1. Le code a-t-il expiré avant que vous ne cliquiez ? Continuer? Le temps restant est indiqué par le cercle de compte à rebours situé à droite du nom du compte et du code MFA.
2. Si vous avez configuré l'application d'authentification pour plusieurs environnements ou applications, vérifiez bien que vous avez saisi le code correct.
1. Si les noms de connexion MFA ne permettent pas de déterminer clairement l'option correcte, vous devrez peut-être essayer différents codes jusqu'à trouver celui qui fonctionne.
2. Une fois la connexion correcte trouvée, vous pouvez la renommer dans l'application. Une icône en forme de crayon en haut de l'écran de l'application vous permettra d'accéder au mode édition. Dans certaines applications, vous devrez d'abord sélectionner (ou appuyer longuement) la connexion à modifier pour que l'icône apparaisse.
3. Une fois en mode édition, vous pouvez renommer les connexions selon vos besoins afin de bien identifier celle qui correspond à quel environnement.
4. Enregistrez les modifications, et la prochaine fois, il devrait être plus facile de comprendre quel code utiliser.
codes de récupération
Utilisez les codes de récupération pour vous authentifier en cas de perte de votre appareil.
1. Téléchargez ou copiez vos codes de récupération et conservez-les dans un endroit sûr dont vous vous souviendrez.
2. Vérifiez que vous avez bien enregistré vos codes de récupération.
3. Cliquez Créer un compte.
La page des codes de récupération expire après 10 minutes.
Vous ne pouvez télécharger les codes de récupération qu'une seule fois.
Votre compte est désormais actif et vous pouvez l'utiliser pour vous connecter à toutes vos applications CR.
Liste d'autorisation d'adresse IP
Seule une adresse IP statique permet d'accéder à COS Explorer. Contactez votre fournisseur d'accès Internet si vous avez besoin d'aide.
Les adresses IP du serveur d'identité sont :
172.67.26.222 104.22.40.134 104.22.41.134
Le serveur est protégé par un proxy Cloudflare.
Vous pouvez autoriser ces noms de domaine pleinement qualifiés (FQDN) :
idptest.crbcos.com
Dépannage
Mot de passe oublié
1. Cliquez Mot de passe oublié ? et saisissez votre adresse e-mail.
2. Saisissez le code d'authentification à 6 chiffres provenant de votre application d'authentification. 3. Vous obtenez un Mot de passe oublié Courriel. Cliquez Réinitialiser le mot de passe.
4. Sur la page de réinitialisation du mot de passe, saisissez un nouveau mot de passe, cliquez Réinitialiser le mot de passe, et Poursuivez avec l'application.
Réinitialiser l'authentification multifactorielle
Si vous avez déjà configuré l'authentification multifacteur :
1. Dans Identity Server, accédez à Réinitialiser l'authentification multifacteur et cliquez Réinitialisez votre appareil MFA. 2. La page d'authentification multifacteurs s'ouvre et vous pouvez réinitialiser votre MFA.
Vous pouvez également créer de nouveaux codes de récupération pour l'authentification multifactorielle.
1. Cliquez créer de nouveaux codes de récupération pour l'authentification multifacteurs.
2. La page des codes de récupération s'ouvre et vous pouvez copier ou télécharger vos 10 nouveaux codes de récupération.
Si vous n'avez pas encore configuré l'authentification multifacteurs, vous pouvez l'activer depuis Paramètres du compte.
1. Cliquez Réinitialiser la méthode MFA.
2. Cliquez Configurer l'authentification multifacteur.
3. Suivez les instructions relatives à l'authentification multifacteurs/l'authentification en deux étapes.
Si votre authentification multifacteur actuelle se fait par SMS, vous pouvez activer l'authentification multifacteur avec votre application d'authentification. Paramètres du compte
1. Cliquez Réinitialiser la méthode MFA.
2. Cliquez Configurer l'authentification multifacteur.
3. Suivez les instructions relatives à l'authentification multifacteurs/l'authentification en deux étapes.
Utilisez un code de récupération
Si vous n’avez pas accès à votre authentificateur multifactoriel (à 2 facteurs), vous pouvez vous connecter en utilisant l’un de vos codes de récupération.
1. Connectez-vous comme d'habitude
2. Sur la page d'authentification multifacteurs, vous avez la possibilité d'utiliser un code de récupération comme option d'authentification.
3. Saisissez l'un de vos codes de récupération dans le champ prévu à cet effet. Ce code est à usage unique et ne peut être réutilisé. Afin d'éviter toute confusion ultérieure, nous vous recommandons de le marquer comme utilisé.
![]()
Blocage du compte
Si vous saisissez un mot de passe incorrect à cinq reprises, votre compte sera bloqué pendant environ cinq minutes. Si, après ce délai, vous ne parvenez toujours pas à accéder à votre compte, veuillez contacter l'assistance Cross River.
Erreur de navigateur - Pare-feu
Vous vous connectez à COS Explorer et obtenez l'écran d'erreur suivant :
![]()
Vous êtes bloqué par un pare-feu.
1. Contactez votre service informatique interne pour vérifier si votre organisation applique des règles de pare-feu pour le trafic sortant. S'il n'existe aucune règle de pare-feu pour le trafic sortant, alors :
2. Contactez votre service informatique interne pour vérifier que vous vous connectez au portail Cross River COS Explorer depuis une adresse IP autorisée. Si vous devez enregistrer d'autres adresses IP, envoyez un courriel au support COS.
4.2.3.1. Gestion des utilisateurs
Gestion des utilisateurs
Vous pouvez utiliser le Utilisateurs écran du Administrateur Utilisez l'onglet pour regrouper des ressources, comme des clients, des produits et des comptes. Une fois qu'une ressource (par exemple, un produit ou un client) vous a été attribuée, elle ne peut plus être modifiée.
Vous pouvez utiliser cet espace pour assister vos clients et effectuer des modifications pour eux. Nous pouvons vous fournir deux comptes administrateurs afin que vous puissiez créer des comptes à la demande pour vos clients. Cela vous permet de gérer vos clients en toute autonomie et d'effectuer des modifications en dehors des heures ouvrables, à leur demande.
Vous pouvez également créer ou intégrer de nouveaux utilisateurs.
Créer un nouvel utilisateur
1 Dans le Administrateur onglet, cliquez Utilisateurs pour ouvrir le Utilisateurs écran de recherche. 2 Cliquez + Nouvel utilisateur. Le Créer un utilisateur l'écran s'affiche.
3 In Créer un utilisateur saisir l'utilisateur E-mail, les champs suivants s'affichent alors Prénom, Nom de famille et Numéro de téléphone.
4 Cliquez Statut et sélectionnez Actif.
Le Numéro de téléphone Ce champ doit être un numéro de téléphone portable, car celui-ci sera utilisé pour l'authentification multifacteur (MFA) afin d'authentifier l'utilisateur.
Description du champ
|
Nom |
Nom d'utilisateur. Saisissez le nom d'utilisateur complet qui s'affichera dans la fenêtre du navigateur lorsque l'utilisateur se connectera à Explorer. |
|
|
Adresse e-mail de l'utilisateur. Cette adresse sert à se connecter à Explorer et constitue également l'adresse e-mail de récupération pour la réinitialisation du mot de passe. |
|
Statut |
Sélectionnez un statut utilisateur. Le statut utilisateur est Inactif par défaut. Modifiez-le en Actif lors de la création d'un utilisateur. |
|
Type d'utilisateur |
Ce champ affiche Partenaire lors de la création de l'utilisateur. |
|
Rôles |
Sélectionnez les rôles à ajouter à l'utilisateur, ou cliquez Inclure tous les rôles ajouter tous les rôles disponibles à l'utilisateur. Note: Seuls les rôles qui vous sont attribués seront visibles. Certains rôles contiennent des autorisations vous permettant d'initier des paiements dans Explorer. Vos administrateurs Explorer sont responsables de la configuration de vos utilisateurs, en veillant à ce qu'ils disposent des rôles appropriés et des limites d'autorisation définies. |
Pour chaque champ, sélectionnez une limite en dollars (le cas échéant).
5 Cliquez Statut et sélectionnez Actif.
6 Cliquez Rôles et sélectionnez le compte auquel vous souhaitez attribuer le nouvel utilisateur. Cliquez Sauvegarder rôles Changements.
Tous Les utilisateurs doivent être configurés avec le Partenaire Core prêt uniquement rôle.
Si l'utilisateur se voit attribuer le Origination de virements partenaires Vous devez configurer la limite d'origine de ce rôle utilisateur.
7 Si vous attribuez à l'utilisateur le Origination de virements partenaires rôle, saisissez une valeur dans le Virements.Paiements.Origine Ce champ permet d'indiquer le montant maximal par virement. Sinon, vous pouvez ignorer ce champ.
8 Une fois tous les champs configurés, cliquez sur Enregistrer les modifications.
9 Si vous avez créé un nouvel utilisateur avec succès, un écran de confirmation s'affiche.
10 Pour finaliser l'ajout et la configuration d'un utilisateur, un autre administrateur doit intervenir. Approuver les modifications.
11 Le Approuver les modifications en attente L'écran s'affiche. Cliquez Confirmer.
12 Viewinformations sur l'utilisateur
Documents / Ressources
 |
Plateforme API Cross River [pdf] Manuel de l'utilisateur Plateforme API, Plateforme API, Plateforme |