Plataforma API
Comença
1. Benvingut
NOU! Públic de Cross River amb sol·licituds predefinides per a la col·lecció Cross Postman
Riu. Punts finals de l'API
Benvinguts a Cross River documentació
Descobreix, explora i comença a integrar els nostres productes amb facilitat
Inici ràpid Explora tots els productes
Aconsegueix va començar
Configura i inicia el teu viatge utilitzant les API de Cross River
Conceptes
Descobreix com les solucions de Cross River poden transformar el teu viatge en tecnologia financera
API
Desenvolupar utilitzant la banca de Cross River
plataforma i conjunts d'API robustos
Tutorials
Aprèn a utilitzar Cross
API de River pas a pas
2. Inici ràpid
Pas 1
Pas 2
Pas 3
Pas 4
Obtenir el testimoni d'accés
Utilitza el testimoni d'accés
Construeix una Sampl'aplicació
Obtenir credencials d'API: El primer pas per treballar amb les API de Cross River és registrar-se per obtenir les credencials de l'API.
Obtén el testimoni d'accés: Un cop hàgiu rebut les vostres credencials d'API i abans de poder utilitzar les nostres API, heu d'obtenir un token d'accés mitjançant client_id i client_secret que vas rebre quan et vas registrar.
Utilitza el token d'accés: Un cop us hàgiu autenticat correctament, un testimoni_d'accés se us retorna. Incloeu aquest token a la capçalera de les vostres crides a l'API.
Webganxos: Webels hooks són un component important de qualsevol integració amb Cross River. Tot i que les API permeten sol·licitar dades sota demanda, webEls hooks envien actualitzacions en temps real directament al vostre sistema, eliminant la necessitat d'enquestes constants i reduint la latència.
Entorns de sandbox: El sorral és un entorn completament aïllat, així que no dubteu a
2.1. Obtenir credencials d'API
Pas 1
Obtenir credencials d'API
Pas 2
Obtenir el testimoni d'accés
Pas 3
Utilitza el testimoni d'accés
Pas 4
Construeix una Sampl'aplicació
El primer pas per treballar amb les API de Cross River és registrar-se per obtenir les credencials de l'API. Amb aquestes credencials podeu sol·licitar i rebre un token d'accés per utilitzar-lo per enviar API al nostre entorn de proves.
IMPORTANT
La teva adreça IP, que ha de ser pública i estàtica, ha d'estar a la nostra llista de permesos. El teu departament informàtic intern hauria de poder proporcionar-te aquesta IP. Més informació sobre les IP estàtiques.
Accés a Sandbox
Envieu una sol·licitud per a l'accés a la zona de proves, per rebre credencials d'API.
Un cop afegida la teva IP estàtica a la nostra llista de permesos, t'enviarem 2 correus electrònics xifrats amb les teves credencials:
Un correu electrònic conté el vostre client_id , id_soci i altra informació que necessiteu segons el que hàgiu sol·licitat.
El segon correu electrònic, que està xifrat, conté el vostre client_secret i webhook_secret Els necessitareu per a l'autenticació i per treballar a la zona de proves.
NOTA
Si heu sol·licitat accés a Pagaments amb targeta, rebreu un conjunt addicional de credencials, inclosa una segona client_id i client_secret
2.2. Obtén el testimoni d'accés
Pas 1
Obtenir credencials d'API
Pas 2
Obtenir el testimoni d'accés
Pas 3
Utilitza el testimoni d'accés
Pas 4
Construeix una Sampl'aplicació
Cross River utilitza OAuth 2.0 per a l'autenticació i l'autorització. Això controla l'entrada al nostre sistema i garanteix que només les entitats autoritzades puguin accedir a les nostres API i altres recursos protegits. La informació que introduïu al nostre sistema d'autenticació és confidencial i no es podrà accedir mai des de cap altra aplicació de Cross River.
Un cop hàgiu rebut el vostre , i abans de poder utilitzar les nostres API, heu d'obtenir les credencials de l'API un token d'accés utilitzant el client_id i client_secret que vau rebre quan us vau registrar. Aquest token d'accés us permet enviar informació de manera segura com a objecte JSON per utilitzar-lo a les nostres API. Heu d'incloure aquest token a la capçalera de cada sol·licitud d'API.
Hi ha diverses maneres de sol·licitar i rebre un token d'accés:
Utilitza la interfície de línia d'ordres (CLI) amb cURL o qualsevol altre idioma
Utilitzeu Postman o qualsevol altra eina de proves d'API
Un cop obtingut, copia el token d'accés al porta-retalls. Assegura't de desar-lo.
Interfície de línia d'ordres
Per sol·licitar un token, envieu un Connexió/token POST comanda que conté el client_id i client_secret i tipus_subvenció al (servidor d'autenticació) del servidor d'autenticació zona de proves adequada, tal com es mostra a la sampel més avall.
Consulteu per obtenir una explicació d'aquests tags. Taula de components HTTP
El següent example utilitza cURL per sol·licitar un token a un dels servidors d'autenticació.
Sampsol·licitud en cURL per a COS
curl –ubicació –sol·licitud 'POST https://idptest.crbcos.com/connect/token' \ –capçalera 'Tipus de contingut: aplicació/x-www-formulari-urlcodificat \ –dades-urlcodificar 'client_id=[el vostre ID aquí]' \
–dades-urlcodificar 'client_secret=[el teu secret aquí]' \
–dades-urlcodificar 'tipus_de_grant=credencials_de_client' \
–dades-urlcodificar 'audiència=https://api.crbcos.com/'
Sampresposta de cURL petició
{ "token_d'accés": "conté molts caràcters", \
"caduca_en": 86400, \
"tipus_de_token": "Portador" }
Carter
Per sol·licitar un token amb Postman, envieu un Connexió/token POST comandament a la auth servidor de la caixa de proves adequada. Afegiu el tipus_subvenció , abast (opcional) ,
client_id i client_secret a la trucada.
Consulteu per obtenir una explicació d'aquests tags. Taula de components HTTP
Si l'autenticació s'ha completat correctament, el codi d'estat és 200 (OK).
COSExplorer
A , feu clic a la fletxa avall que hi ha al costat del vostre inici de sessió i feu clic a Copiar el testimoni d'accésExplorador de COS
El token d'accés es copia al porta-retalls, llest per utilitzar-lo a la sala de proves .
Resposta a la sol·licitud de token
Descripció de l'atribut
|
accés_a ken |
Un JSON signat digitalment web testimoni (JWT) enviat des del servidor oAuth que permet l'accés a recursos específics de Cross River |
|
abast |
Una gamma de serveis als quals pot accedir un usuari |
|
caduca_i n |
El temps que falta fins que caduca el token. – El nostre equip d'integració us informarà del termini de caducitat o també podeu descodificar el vostre token d'accés. – Us recomanem que recupereu un testimoni d'accés nou poc abans que el testimoni antic caduqui. – Reutilitzar els tokens durant tota la seva vida útil en lloc d'obtenir un token nou per a cada crida al mateix recurs protegit (API). IMPORTANT: No desxifris mai el teu token en un lloc allotjat públicament weblloc |
tipus de testimoni
testimoni del portador
Components HTTP
Els components HTTP següents s'utilitzen tant a l'API com a les sol·licituds de Postman.
HTTP
component
Tag Descripció
|
Punt final |
PUBLICACIÓ /connect/toke n |
Punt final per recuperar un token d'accés |
|
Capçalera |
contingut tipus |
aplicació/x-www-formulari- urlcodificat |
|
Cos |
client_id |
L'identificador únic d'un client |
|
Cos |
client_secret t |
Una cadena de caràcters xifrada que s'utilitza per signar i validar tokens d'identificació. Important: Els secrets no es poden recuperar mitjançant CR. Si perdeu un secret, cal generar-ne un de nou. No ho facis comprometeu els vostres secrets al control de codi font. |
|
Cos |
tipus_subvenció |
Aquest camp sempre tindrà un valor de credencials_de_client |
|
Cos |
públic opcional |
Una manera perquè l'usuari validi si un token d'accés concret és per a ell. |
|
Cos |
abast opcional |
Un rang específic o un conjunt limitat de serveis als quals un usuari pot accedir amb un token d'accés. Si no s'especifica un àmbit, el testimoni retornat contindrà tots els àmbits associats a les vostres credencials. Nota: Es poden enviar diversos àmbits en la mateixa sol·licitud afegint un espai entre el nom de cada àmbit. Per exempleampli: 'abast=abast1 àmbit2 àmbit3' |
Servidor d'autoritzacióURLs
Servidor d'autenticació del mòdul URL
|
Comptes |
https://idptest.crbcos.com/connect/token |
|
ACH |
https://idptest.crbcos.com/connect/token |
|
Filferros |
https://idptest.crbcos.com/connect/token |
|
xecs |
https://idptest.crbcos.com/connect/token |
|
Nucli |
https://idptest.crbcos.com/connect/token |
|
Pagaments instantanis |
https://idptest.crbcos.com/connect/token |
|
Emissió de la targeta |
https://idptest.crbcos.com/connect/token |
|
Pagaments amb targeta |
https://crbcos-sandbox.auth0.com/oauth/token |
Préstec https://oauthtest.crbnj.net/connect/token
Resolució de problemes
Si el token d'autenticació és vàlid, retornarà un 200. Si el token d'autenticació no és vàlid, retornarà un 401.
Si no pots obtenir un token de portador i no n'has rebut cap en el passat:
Confirmeu el URL.
Comproveu que el client_id i client_secret estan escrits correctament. Distingeixen entre majúscules i minúscules.
Comproveu el vostre client_id i client_secret contra el que has rebut. Assegura't que no hi hagi problemes de xarxa o de llista permesa.
Poseu-vos en contacte amb el nostre equip d'integració si el vostre compte està bloquejat com a resultat de 3 inicis de sessió incorrectes. intents.
2.3. Utilitza el token d'accés
Pas 1
Obtenir credencials d'API
Pas 2
Obtenir el testimoni d'accés
Pas 3
Utilitza el testimoni d'accés
Pas 4
Construeix una Sampl'aplicació
Un cop ho hagis fet correctament, un token d'accés se us retorna. Incloeu autenticat aquest token a la capçalera de les crides a l'API.
El testimoni d'accés caduca després d'un període de temps definit. La resposta que conté el testimoni també especifica el temps de caducitat en segons. Emmagatzema i utilitza el teu testimoni d'accés fins que caduqui. Et recomanem que utilitzis el testimoni fins que rebis un error 401 no autoritzat i, a continuació, sol·licitis un testimoni nou.
IMPORTANT
1. No sol·licitis un token nou per a cada sol·licitud d'API.
2. Assegureu-vos de protegir el vostre token. Qualsevol persona que us el robi pot suplantar la identitat del vostre client durant la vida útil del token.
Capçalera de sol·licitud de l'API
A la capçalera de cada sol·licitud d'API, incloeu el testimoni d'accés de la manera següent:
Sampla trucada per a pagament electrònic en cURL
curl –ubicació –sol·licitud 'PUBLICA https://sandbox.crbcos.com/Wires/v1/payments' –capçalera 'Autorització: Portador [EL TEU TOKEN AQUÍ]' \
–capçalera 'Tipus de contingut: aplicació/x-www-formulari-urlcodificat \
–dades en brut '{
“Número de compte”: “2255685659”,
“CodiFuncióNegocial”: “CTR”,
"receptorNúmeroEnrutament": "021000021",
"beneficiariFi": {
"Codi d'identificació": "F",
"identificador": "021000021",
«nom»: «JP Morgan Chase»
},
«beneficiari»: {
"Codi d'identificació": "D",
"identificador": "123456789",
«nom»: «Peter Griffin»
},
“Referència del beneficiari”: “XYZ123”,
«quantitat»: 10000,
«propòsit»: «pagament»
}'
Carter
Per utilitzar un token a Postman, navegueu fins a Autorització a la pestanya de la sol·licitud, seleccioneu Token del portador com a tipus d'autenticació i enganxeu el vostre testimoni al camp proporcionat. Postman afegirà automàticament el Portador prefix i el testimoni per a la Token camp.
2.4. Webganxos
Webels hooks són un component important de qualsevol integració amb Cross River. Tot i que les API permeten sol·licitar dades sota demanda, webels hooks envien actualitzacions en temps real directament al vostre sistema, eliminant la necessitat d'enquestes constants i reduint la latència. En molts casos, webEls hooks són més eficients i fiables que les API soles, cosa que garanteix que l'aplicació es mantingui sincronitzada amb esdeveniments crítics com ara canvis de compte, actualitzacions de transaccions i resultats de processament.
Ús webhooks dins dels sistemes de Cross River per notificar-vos quan es produeixen diferents esdeveniments. L'esdeveniment retorna un objecte de recurs que conté detalls rellevants sobre el tema de cada esdeveniment. S'inclouen tots els detalls de l'esdeveniment i s'envien al vostre sistema.
Utilitzem webhooks per actualitzar-vos sobre l'estat i informar de canvis en les transaccions. WebEls hooks informen al vostre sistema amb notificacions en temps real quan es produeix un esdeveniment.
Heu de registrar-vos a través de l'API per utilitzar-lo webganxos:
Registra't per a comptes, targetes i esdeveniments de pagament
Registra't per a esdeveniments de pagament amb targeta
Registra't per a esdeveniments de préstecs
2.5. Entorns de sandbox
El nostre espai de proves és un entorn completament aïllat, així que experimenta lliurement. Quan estiguis a punt per passar a producció, fes-nos-ho saber i t'obtindrem les credencials de producció per accedir a l'entorn en directe.
Gestió de clients
Base del mòdul URL per a crides a l'API
Gestió de clients https://sandbox.crbcos.com/core/ Comptes
Base del mòdul URL per a crides a l'API
comptes de dipòsit
|
https://sandbox.crbcos.com/core/ |
Esbandides de dipòsits https://sandbox.crbcos.com/sweepsintrafi/ Targetes
Base del mòdul URL per a crides a l'API
Targetes https://sandbox.crbcos.com/cardmanagement/Pagaments
Base del mòdul URL per a crides a l'API
|
Pagaments instantanis |
https://sandbox.crbcos.com/rtp/ |
|
Pagaments amb targeta: Pagament per prémer |
https://pushtopaystaging.crbnj.net/ |
|
Pagaments amb targeta: Estirar |
https://pullfromcardapistg.crbnj.net/ |
|
Pagaments internacionals |
https://sandbox.crbcos.com/international/ |
|
ACH |
https://sandbox.crbcos.com/ach/ |
|
Filferros |
https://sandbox.crbcos.com/wires/ |
Xecs https://sandbox.crbcos.com/checks/ COSwebganxos
Base del mòdul URL per a crides a l'API
COS webganxos
https://sandbox.crbcos.com/webhooks/
Préstec
Base del mòdul URL per a crides a l'API
Originació de préstecs
|
https://arixapisandbox.crbnj.net |
Presa de decisions sobre l'aplicació https://lendingsandbox.crbcos.com/preapproval/v1
2.6. Col·lecció Carter
Per facilitar el desenvolupament, hem creat un amb elements preconstruïts
Col·lecció Carter sol·licituds per a tot el Cross River. Utilitzeu aquesta col·lecció per explorar, provar i crear punts finals d'API. la teva integració directament a Postman. amb una mínima codificació i configuració addicionals requerides. Per bifurcar immediatament la nostra col·lecció, fes clic
Només cal que completeu els detalls de configuració i comenceu a fer trucades a la col·lecció Sandbox Postman. a través de .
Carter
Token d'accés (portador)
Hem creat el nostre entorn de proves per a desenvolupadors de Postman per proporcionar un espai segur per provar les API de Cross River. A la col·lecció Postman de Cross River, l'autenticació es realitza mitjançant un token de portador.
Per obtenir els ID, cal configurar el token d'accés (portador) necessari per executar la col·lecció:
1. Amb aquestes credencials sol·licites i reps un token d'accés
Obtenir credencials d'API
per utilitzar per enviar API al nostre entorn de sandbox
2. Un cop rebeu les vostres credencials d'API i abans de poder utilitzar les nostres
Obtén el testimoni d'accés
API, obteniu un token d'accés mitjançant el client_id i client_secret que vas rebre quan et vas registrar.
Col·lecció Fork Cross River
Vés directament a la nostra pàgina per fer una ullada a la nostra col·lecció.
Espai de treball del carter
Un cop bifurcada, no us oblideu de definir les variables d'entorn per a la sandbox.
Configura el teu entorn de Postman
Per utilitzar la col·lecció que acabeu de crear, navegueu-hi, feu clic a Entorns, i seleccioneu SandboxCopieu el vostre ID de client de Cross River i el secret del client i enganxeu-los al client_Id i client_secret camps. Per a pagaments amb targeta, enganxeu-los als camps ptpe_client_id i ptpe_client_secret camps.
Ara ja esteu a punt per obtenir un token i començar a enviar sol·licituds.
1. Corre Autorització/Obtenció de token per generar el vostre token. Per a pagaments amb targeta, executeu Pagaments amb targeta/Autorització/Obtenir token P2PE .
2. La variable {{token}} (o ptpe_token per a pagaments amb targeta) s'afegeix automàticament al vostre entorn mitjançant un script de postresposta. Quan el token caduca, heu de tornar a seguir el pas 1.
3. Hi ha diverses variables que potser haureu d'introduir segons el punt final que esteu exercitant. Per exemple,ampel, id_soci , id_producte , id_configuració i devolució_de_reclamacióurl .
4. També hi ha algunes variables que s'omplen mitjançant scripts, com ara testimoni i ptpe_token que no s'hauria d'omplir manualment.
Pingthesandbox
Executeu una prova senzilla per verificar que us podeu connectar a la zona de proves de Cross River.
Per enviar una sol·licitud de Ping, obriu Postman Col·leccions > Col·lecció de l'API de Cross River > Autorització i executar el Ping punt final.
Modificar sol·licituds
Per actualitzar una sol·licitud, feu els canvis a Cos tabulació. Valors en doble curlEls claudàtors s'extreuen de les variables d'entorn. Consulteu la nostra documentació per veure quins camps té cada API.
el punt final accepta, i view sol·licituds en el vostre idioma preferit.
3. Construir com aampl'aplicació
Pas 1
Obtenir credencials d'API Configuració
Pas 2
Obtenir el testimoni d'accés
Pas 3
Utilitza el testimoni d'accés
Pas 4
Construeix una Sampl'aplicació
Abans de començar, consulteu la nostra guia d'inici ràpid per connectar-vos a les nostres API. Per provar les crides a l'API, podeu utilitzar cURL des de la línia d'ordres o un servei com ara Postman o Swagger a la nostra zona de proves.
Clients i comptes
Abans d'utilitzar els serveis de Cross River, cal crear un registre de clients per a cadascun dels vostres clients
Targetes
Gestioneu les targetes dels vostres clients treballant amb Cross River per decidir què voleu oferir, com ara targetes físiques o virtuals.
Préstec
: Els préstecs inclouen un conjunt de crides a les API de préstecs que us permeten crear, actualitzar, i gestionar els vostres préstecs.
3.1. Configuració
Abans de començar, consulteu la nostra guia per connectar-vos a les nostres API. Per provar l'inici ràpid de l'API
trucades, podeu utilitzar cURL des de la línia d'ordres o un servei com ara Postman o Swagger a la nostra zona de proves.
Per crear una targeta o una aplicació de pagament, heu de crear clients i comptes.
Explora la zona de proves
Tenim tot per explorar. La zona de sorra és un entorn de zona de sorra completament aïllat. des de l'entorn de producció, així que experimenta amb llibertat. Quan estiguis a punt per passar a la producció, parla amb el teu gestor de relacions, que t'obtindrà les credencials de producció per accedir a l'entorn en directe.
Registre rellevant web esdeveniments de ganxo
Webels hooks són un component important de qualsevol integració amb Cross River. Tot i que les API permeten sol·licitar dades sota demanda, webels hooks envien actualitzacions en temps real directament al vostre sistema, eliminant la necessitat d'enquestes constants i reduint la latència. En molts casos, webEls hooks són més eficients i fiables que les API soles, cosa que garanteix que l'aplicació es mantingui sincronitzada amb esdeveniments crítics com ara canvis de compte, actualitzacions de transaccions i resultats de processament.
Registra't rebre webesdeveniments de ganxo. Quan webes desencadenen els esdeveniments de ganxo, l'esdeveniment els objectes s'envien al registre URLs.
3.2. Clients i comptes
Pas 1
Obtenir credencials d'API
Pas 2
Obtenir el testimoni d'accés
Pas 3
Utilitza el testimoni d'accés
Pas 4
Construeix una Sampl'aplicació
Crea un registre de client i un compte finançat:
Crear un registre de client
Crea un compte de dipòsit
Finançar un compte
Crear un registre de client
Abans d'utilitzar els serveis de Cross River, cal que creeu un registre de client per a cadascun dels següents:
els vostres clients. El procés d'incorporació de clients inclou la creació d'un registre de clients amb informació rellevant del client.
Tots els clients s'escanegen automàticament per complir amb les normes, per la qual cosa cal registrar-se per obtenir informació rellevant. webenganxa esdeveniments per rebre actualitzacions de l'estat del registre del client.
El registre del client pot ser per a qualsevol de les dues opcions Personal or Negocis clients. Un cop registrat, un client pot estar associat a un o més comptes.
Webganxos
Registra't per webganxos. El següent webs'utilitzen ganxos:
WebDescripció del ganxo
|
Client principal incorporat |
T'avisa que s'ha creat el registre del client |
|
Client principal.Ofac.Canviat |
T'avisa que l'estat de l'OFAC d'un client s'ha actualitzat |
Core.Customer.PepScan.Chan ged
Nt'informa que l'estat PEP d'un client s'ha actualitzat
Exampcreació de registres de fulla
En aquest exampés a dir, incorporarem a John Smith. Primer, creem un registre de client. Estem registrant a John com a Personal client.
Per incorporar un client empresarial, primer cal crear un registre de client personal per al propietari principal d'aquesta empresa. Després d'això, creeu un client empresarial i afegiu el registre personal com a beneficiari efectiu.
1 Truca POST /core/v1/cm/clients .
En el següent exampcom podeu veure són obligatoris. quins atributs
IMPORTANT
Us recomanem que inclogueu una clau d'idempotència a la capçalera de la sol·licitud.
per proporcionar protecció duplicada en cas d'error.
Curl
curl -X POST /core/v1/cm/clients –header 'Tipus de contingut: aplicació/j {
"ID del soci": “6e80b097-693c-4592-8440-02f345335bbf”,
"nom": {
"Nom": «Joan»,
"Cognom": «Smith»
},
"classificació": "Personal",
"profile": {
«regO»: fals,
"Persona políticament exposada": fals,
"Tipus d'ID d'impost": Número de la Seguretat Social,
"Identificador fiscal": "119988776",
"Data de naixement": "1953-09-22",
"Qualificació de risc": "Baix"
"Adreça principal": {
"Tipus d'adreça": “Casa”,
"classificació": "Residencial",
"ésPrimari": cert,
carrer 1: "123 Any St",
«ciutat»: "A qualsevol lloc",
«estat»: «Nova York»,
"Codi postal": "12345",
"Codi de país": "EUA"
},
"Telèfon principal": {
"ésPrimari": cert,
"Tipus de telèfon": “Casa”,
"Número de telèfon": "2015551234"
},
"Correu electrònic principal": {
"ésPrimari": cert,
"Tipus de correu electrònic": "Personal",
"Adreça electrònica": “John.Smith@xxxxx.com”
}
}
Una crida a l'API correcta retorna una resposta JSON amb l'ID únic del client a la primera línia del cos de la resposta. El vostre client s'ha creat.
Incorporació d'un cos de resposta al client
{
«identificació»: “9052b6a5-3f09-41d1-b526-ade80104eb79”,
"cifNumber": "32653745014",
"classificació": "Personal",
"estat": "Activa",
«ofac»: "Pendent",
«pepScan»: "Pendent",
"nom": {
"Nom": «Joan»,
"Cognom": «Smith»,
"Nom complet": «Joan Smith»
},
"profile": {
«regO»: fals,
"Persona políticament exposada": fals,
"activa la retenció de còpies de seguretat": fals,
"Tipus d'ID d'impost": Número de la Seguretat Social,
"Identificador fiscal": "119988776",
"Data de naixement": "1953-09-22",
"Qualificació de risc": "Baix"
},
"creatAt": “2021-01-25T17:55:24.4422582-05:00”,
"últimamodificacióA": “2021-01-25T17:55:24.4432543-05:00”,
"ID del soci": “6e80b097-693c-4592-8440-02f345335bbf”
}
2 El Client principal incorporat webL'esdeveniment hook s'activa quan es crea el registre del client.
Esdeveniment d'incorporació del client
{
«identificació»: “3d9c5e1a-623b-4cf2-812e-ade80105048e”,
"nom_esdeveniment": "Client principal incorporat",
"estat": "Pendent",
"ID del soci": “30dee145-b6a2-4058-8dc3-ac4000dee91f”,
"creatAt": “2021-11-22T10:50:20.553-05:00”,
"recursos": [
“core/v1/cm/customers/9052b6a5-3f09-41d1-b526-ade80104eb79” ],
"detalls": []
}
Cross River escaneja el registre del nou client per comprovar el compliment de les normes OFAC i PEP.
De vegades, els resultats de l'escaneig requereixen una revisióview pel nostre equip de lluita contra el blanqueig de capitals (AML).
En completar l'escaneig, Client principal.Ofac.Canviat i
Core.Customer.PepScan.Changed webEls esdeveniments de ganxo tornen amb un estat. Els clients sense problemes de compliment mostren un Clar estat.
L'escaneig OFAC del client ha canviat
{
«identificació»: “45db5592-56ee-41f5-85e7-ade8010571ce”,
"nom_esdeveniment": "Client principal de l'Ofac ha canviat",
"estat": "Pendent",
"ID del soci": “30dee145-b6a2-4058-8dc3-ac4000dee91f”,
"creatAt": “2021-11-22T10:51:53.657-05:00”,
"recursos": [
“core/v1/cm/customers/9052b6a5-3f09-41d1-b526-ade80104eb79” ],
"detalls": []
}
L'escaneig PEP del client ha canviat
{
«identificació»: “a5000831-3e01-4231-9ec2-ade8010571c5”,
"nom_esdeveniment": "El PepScan del client principal ha canviat",
"estat": "Pendent",
"ID del soci": “30dee145-b6a2-4058-8dc3-ac4000dee91f”,
"creatAt": “2021-11-22T10:51:53.597-05:00”,
"recursos": [
“core/v1/cm/customers/9052b6a5-3f09-41d1-b526-ade80104eb79” ],
"detalls": []
}
Ara heu creat un registre de client.
Actualitzar el registre de clients
És possible actualitzar les dades del client, com ara l'adreça, el número de telèfon i el correu electrònic. Aquestes dades es consideren primària informació. Si afegiu una segona adreça, aquesta és secundària.
1 Feu servir l'ID de client que es retorna quan creeu el registre de client per trucar POST /core/v1/cm/customers/{id}/addresses per afegir el . La primera adreça del client
l'adreça que afegiu és la primària adreça. En el següent ex.ampaixí podeu veure quins atributs són obligatoris.
Actualitza l'adreça del client
POST /core/v1/cm/customers/9052b6a5-3f09-41d1-b526-ade80104eb79/addresse {
"Tipus d'adreça": “Casa”,
"classificació": "Residencial",
"ésPrimari": cert,
carrer 1: "123 Any St",
«ciutat»: "A qualsevol lloc",
«estat»: «Nova York»,
"Codi postal": "12345",
"Codi de país": "EUA"
}
2 Truca POST /core/v1/cm/customers/{id}/phones per afegir el
telèfon del client
El primer número de telèfon que afegiu és el primària número de telèfon.
nombre
Actualitzar el número de telèfon del client
POST /core/v1/cm/customers/9052b6a5-3f09-41d1-b526-ade80104eb79/phones {
"ésPrimari": cert,
"Tipus de telèfon": "Mòbil",
"Número de telèfon": "2015552345"
}
3 Truca POST /core/v1/cm/customers/{id}/correu electrònic per actualitzar el correu electrònic del client .
Actualitza el correu electrònic del client
POST /core/v1/cm/customers/9052b6a5-3f09-41d1-b526-ade80104eb79/email {
"ésPrimari": cert,
"Tipus de correu electrònic": "Personal",
"Adreça electrònica": “john.jones@xxx.com”
}
Crea un compte de dipòsit
CR ofereix diversos tipus de comptes, com ara xecs i comptes d'estalvi, certificats de dipòsit (CD o comptes de dipòsit a termini) i més.
Per obrir qualsevol tipus de compte de dipòsit, heu de tenir un ID de producte vàlid per al tipus de compte que voleu obrir i un ID de client (ID de registre de client incorporat) per al titular del compte. Tingueu en compte que el titular del compte ha de tenir com a mínim una adreça i un número de telèfon al seu registre de client, i el seu estat OFAC ha de ser ClarA més, la classificació del client ha de coincidir amb la classificació configurada per al producte. Per exempleampés a dir, només es poden afegir clients empresarials a un producte empresarial.
Abans de començar
Assegureu-vos que teniu:
Credencials de l'API
ID de soci (que vau rebre quan us vau registrar)
ID de client
ID del producte (defineix el tipus de compte que s'obre)
IMPORTANT
Us recomanem fermament que inclogueu una clau d'idempotència a la capçalera de la sol·licitud. per evitar pagaments duplicats en cas d'error.
Punts finals i webganxos
S'utilitza el següent punt final de l'API:
Descripció de l'API
Obrir un compte de dipòsit Obre un compte de dipòsit per a un client
El següent webs'utilitza el ganxo:
WebDescripció del ganxo
Compte principal obert S'ha obert un compte nou
Obre un compte
En el següent escenari, obrireu un compte per a John Smith, un client que heu incorporat correctament.
Per obrir un compte
1 Truca POST core/v1/dda/accounts Per a aquesta trucada, calen alguns atributs. Vegeu la descripció completa.
llista d'atributs
Sampla sol·licitud
POST /core/v1/dda/accounts
{
"ID del client": “59e3bc15-bbec-4990-88e9-a9a600d3296c”,
"ID del producte": “44015e68-1afb-40fc-9497-abc1014f52da”,
«títol»: «Joan Smith»,
"Adreça de declaració": {
carrer 1: «257 Dalton Groves»,
«ciutat»: Ciutat de Barton,
«estat»: «MI»,
"Codi postal": "48705",
"Codi de país": "EUA"
}
}
2 Una crida a l'API correcta retorna una resposta JSON amb els detalls del compte nou.
Sampla resposta
PUBLICACIÓ /nucli/v1/dda/comptes
{
"ID del client": “59e3bc15-bbec-4990-88e9-a9a600d3296c”,
"ID del producte": “44015e68-1afb-40fc-9497-abc1014f52da”,
«títol»: «Joan Smith»,
"Adreça de declaració": {
carrer 1: «257 Dalton Groves»,
«ciutat»: Ciutat de Barton,
«estat»: «MI»,
"Codi postal": "48705",
"Codi de país": "EUA"
}
}
3 El número de compte El camp proporciona el número de compte per al compte nou.
4 En la resposta ex.ampés a dir, el compte està classificat com a Personal perquè l'usuari ha configurat la classificació del producte com a PersonalLa classificació del compte sempre coincideix amb la classificació del producte configurada.
5 L'estat del compte s'actualitza automàticament a Actius , i està disponible per al seu ús immediatament. Això activa el Compte principal obert esdeveniment.
Detalls de l'esdeveniment Core.Account.Opened
{
«identificació»: “259cdbca-6a89-4af8-a50e-ada3010fb13f”,
"nom_esdeveniment": "Compte principal obert",
"estat": "Pendent",
"ID del soci": “e6c3824a-377f-44d5-a2f6-a9a600c9b37e”,
"creatAt": “2021-01-26T09:48:10.1011462-05:00”,
"recursos": [
“core/v1/dda/accounts/2235223803”
],
"detalls": []
}
Compte de fons
Quan treballeu a la zona de proves per provar els rails de pagament i el comportament del compte, heu de tenir fons en un compte.
Podeu utilitzar qualsevol ferrocarril que tingui un punt final de simulació d'entrada per finançar un compte de sandbox, si el compte està configurat per a això. En particular, podeu:
Simular pagaments ACH entrants
Simular un cable entrant
Per a qualsevol simulació, necessiteu el número del compte sandbox de Cross River que voleu finançar. La informació de l'originador no és important i, en alguns casos, fins i tot pot ser completament fictícia.
Passos següents
Consulta el nostre pagament.
tutorials
3.3. Targetes
Pas 1
Obtenir credencials d'API
Pas 2
Obtenir el testimoni d'accés
Pas 3
Utilitza el testimoni d'accés
Pas 4
Construeix una Sampl'aplicació
Aprèn a treballar amb les API de Cross River. Aquesta pàgina et mostra com:
Crea una targeta
Activar una targeta
Crea una targeta
Gestioneu les targetes dels vostres clients treballant amb Cross River per decidir què voleu oferir, com ara targetes físiques o virtuals. Això és el configuració de la targetaCross River crea un professional de configuració de targetesfile per a tu per a cada tipus que triïs per al teu instrument financer clients.
Abans de començar
Assegureu-vos de fer i tenir:
Crear un registre de client
Crea un compte de dipòsit
Número de compte del titular de la targeta
ID de client (l'obtindreu quan creeu un client)
ID de configuració (Cross River us proporciona l'ID quan configureu el vostre tipus/targeta)
També us recomanem que, per a la informació pertinent, webesdeveniments de ganxo. registre
Punts finals i sorrawebganxos
Registra't per webhooks. S'utilitzen els següents punts finals de l'API:
Descripció de l'API
Crear nova targeta Sol·licita la creació d'una nova targeta de dèbit
El següent webs'utilitzen ganxos:
WebDescripció del ganxo
Targetes.Carta.Creada Targeta de dèbit creada
Targeta de comanda
Aprendràs a sol·licitar/crear una nova targeta de dèbit creant una targeta per a John Smith.
1 Truca POST /gestiódetargetes/v1/targetes .
En el següent examppodeu veure quins atributs són obligatoris. Vegeu els detalls de l'API completa.
Afegeix la targeta
Sampcreeu una targeta
curl -X POST /gestiódetargetes/v1/targetes –header 'Tipus de contingut: aplicació “númeroDecompte”: “2608927303”, \
“customerId”: “2b15a695-13dc-4b10-b4e5-af5b0138873c”, \
"Identificador de configuració": "a6b5a94c-f8f9-462b-8ce8-afa400f5b640", \ "Nom": "Joan", \
"cognom": "Smith", \
«telèfon»: { \
"Tipus de telèfon": "Casa", \
"Número de telèfon": "9133413131" \
}, \
"Adreça electrònica": "John.Smith@xxxxx.com", \
"Adreça d'enviament": { \
“carrer1”: “Avinguda Lane”, \
“carrer2”: “cadena”, \
«ciutat»: «Poble gran», \
«estat»: «IL», \
"Codi postal": "72410", \
"Codi de país": "EUA" \
}, \
"Adreça de facturació": { \
“carrer1”: “Avinguda Lane”, \
“carrer2”: “cadena”, \
«ciutat»: «Poble gran», \
«estat»: «IL», \
"Codi postal": "72410", \
"Codi de país": "EUA" \
}, \
“nomA la targeta”: “John Smith”, \
"TipusEnviament": "Normal", \
"IdentificadorDeClient": "cadena" \
}' 'https://sandbox.crbcos.com/CardManagement/v1/cards'
2 Una crida a l'API correcta retorna una resposta JSON amb els detalls de la nova targeta. L'estat de la targeta serà desactivat fins que l'activeu. L'ID és l'ID de la targeta, en aquest cas example 8709163d-140c-4d95-a111-afa8009e9cd1, que hauràs de activar la targeta.
Sampresposta de la carta de comanda
{
«identificació»: “8709163d-140c-4d95-a111-afa8009e9cd1”, "ID del soci": “cd9c12f4-7691-424a-b38b-af5b0134c611”, "ID del producte": “83bed086-8182-4151-a1e3-af5b01362783”, "Número de compte": "2608927303",
"estat": "Desactivat",
"CodiMotiuD'estat": "No definit",
"Nom": «Joan»,
"Cognom": «Smith»,
"Adreça d'enviament": {
carrer 1: Avinguda Lane,
carrer 2: "corda",
«ciutat»: "Poble Gran",
«estat»: «IL»,
"Codi postal": "72410",
"Codi de país": "EUA"
},
"Adreça de facturació": {
carrer 1: Avinguda Lane,
carrer 2: "corda",
«ciutat»: "Poble Gran",
«estat»: «IL»,
"Codi postal": "72410",
"Codi de país": "EUA"
},
"telèfon": {
"Tipus de telèfon": “Casa”,
"Número de telèfon": "9133413131"
},
"Adreça electrònica": “john@anygoogle.com”,
"nom a la targeta": «Joan Smith»,
"ésPinSet": fals,
"administradorBloquejat": fals,
"Sospitós de frau": fals,
"ID de configuració": “a6b5a94c-f8f9-462b-8ce8-afa400f5b640”, «categoria»: «Crèdit»,
"Instrument de pagament": «VirtualPan»,
"processador": "nom del processador",
"Tipus d'enviament": "Normal",
"Estat de la comanda": "Comanda pendent",
"Estat de substitució": «No aplicable»,
"ID del client": “2b15a695-13dc-4b10-b4e5-af5b0138873c”, "Identificador de client": "corda",
"creatAt": “2023-02-13T04:37:29.4869172-05:00”,
"últimamodificacióA": “2023-02-13T04:37:29.4869172-05:00”
}
3 El Targetes.Card.creada webL'esdeveniment hook s'activa quan la targeta es genera al processador.
Sampl'esdeveniment Cards.Card.Created
{
«identificació»: “cea6c5b5-13e7-4c2f-ba75-afce01110fe5”,
"nom_esdeveniment": “Targetes.Targeta.Creada”,
"estat": "Pendent",
"ID del soci": “cd9c12f4-7691-424a-b38b-af5b0134c611”,
"creatAt": “2023-02-13T04:42:29.4869172-05:00”,
"recursos": [
“cardmanagement/v1/cards/8709163d-140c-4d95-a111-afa8009e9cd1” ],
"detalls": [
{
"ID de la targeta": “8709163d-140c-4d95-a111-afa8009e9cd1”,
"estat": "Desactivat",
"CodiMotiuD'estat": "No definit"
}
]
}
Activa la targeta
Abans de començar
Assegureu-vos que teniu:
Credencials de l'API
ID de la targeta des del moment en què la vau demanar
Punts finals i sorrawebganxos
Descripció de l'API
POST /cardmanagement/v1/cards/{id}/activate Activa la targeta utilitzant l'ID de la targeta. El tutorial utilitza aquests webganxos:
WebDescripció del ganxo
Targetes.Targeta.Activada Targeta de dèbit activada
Activa la targeta
Activa la targeta que vas crear a la stage.
crear una targeta
1 Truca POST /gestiódetargetes/v1/targetes/{id}/activar . El id l'atribut s'ha de definir com a ID de la targeta. A la sampsota l'ID és 8709163d-140c-4d95-a111 afa8009e9cd1.
Sampsol·licitud d'activació de la targeta
curl -X PUBLICACIÓ
–capçalera 'Accepta: aplicació/json'
–capçalera 'Autorització: Portador'<testimoni>'
https://sandbox.crbcos.com/CardManagement/v1/cards/8709163d-140c-4d95-a1
2 Una crida a l'API correcta retorna una resposta JSON amb els detalls de la targeta. La targeta estat és ara activat. El Estat de la comanda is Completat.
Sampresposta d'activació de la targeta
{
«identificació»: “8709163d-140c-4d95-a111-afa8009e9cd1”, "ID del soci": “cd9c12f4-7691-424a-b38b-af5b0134c611”, "ID del producte": “83bed086-8182-4151-a1e3-af5b01362783”, "ID de la targeta del processador": "804951250206718",
"Número de compte": "2608927303",
"estat": "Activa",
"CodiMotiuD'estat": "No definit",
"Nom": «Joan»,
"Cognom": «Smith»,
"Adreça d'enviament": {
carrer 1: Avinguda Lane,
carrer 2: "corda",
«ciutat»: "Poble Gran",
«estat»: «IL»,
"Codi postal": "72410",
"Codi de país": "EUA"
},
"Adreça de facturació": {
carrer 1: Avinguda Lane,
carrer 2: "corda",
«ciutat»: "Poble Gran",
«estat»: «IL»,
"Codi postal": "72410",
"Codi de país": "EUA"
},
"telèfon": {
"Tipus de telèfon": “Casa”,
"Número de telèfon": "9133413131"
},
"Adreça electrònica": “john@anygoogle.com”,
"nom a la targeta": «Joan Smith»,
«panLastFour»: "3629",
"ésPinSet": fals,
"datadecaducitat": "2026-02-13",
"administradorBloquejat": fals,
"Sospitós de frau": fals,
"ID de configuració": “a6b5a94c-f8f9-462b-8ce8-afa400f5b640”, «categoria»: «Crèdit»,
"Instrument de pagament": «VirtualPan»,
"processador": "nom del processador",
"Tipus d'enviament": "Normal",
"Estat de la comanda": "Completat",
"Estat de substitució": «No aplicable»,
"ID del client": “2b15a695-13dc-4b10-b4e5-af5b0138873c”,
"Identificador de client": "corda",
"ID del client del processador": “T83E9D675A3N3N9O8RZ1”,
"creatAt": “2023-02-13T04:37:29.487-05:00”,
"Activació inicial": “2023-02-13T00:00:00-05:00”,
"activatAt": “2023-02-13T04:43:19.282287-05:00”,
"últimamodificacióA": “2023-02-13T04:43:19.2962845-05:00”
}
3 Quan l'estat de la targeta canvia a Actius , el Targetes.Targeta.Activada webs'activa l'esdeveniment hook.
Targetes.Targeta.Activada webesdeveniment de ganxo
{
«identificació»: “95ac33ca-3d7f-49aa-bfc2-afce01113310”,
"nom_esdeveniment": "Targetes.Targeta.Activada",
"estat": "Pendent",
"ID del soci": “cd9c12f4-7691-424a-b38b-af5b0134c611”,
"creatAt": “2023-02-13T04:44:31.282287-05:00”,
"recursos": [
“cardmanagement/v1/cards/8709163d-140c-4d95-a111-afa8009e9cd1” ],
"detalls": [
{
"ID de la targeta": “8709163d-140c-4d95-a111-afa8009e9cd1”,
"estat": "Activa",
"CodiMotiuD'estat": "No definit"
3.4. Préstec
Pas 1
Obtenir credencials d'API
Pas 2
Obtenir el testimoni d'accés
Pas 3
Utilitza el testimoni d'accés
Pas 4
Construeix una Sampl'aplicació
Els préstecs inclouen un conjunt de crides que us permeten crear, actualitzar i gestionar l'API de préstecs. els vostres préstecs.
Per començar a treballar amb préstecs, assegureu-vos de:
Rebre credencials d'API amb els àmbits necessaris per a préstecs
Si heu creat les credencials de l'API, mitjançant l'opció de gestió d'autoservei
, també hauries d'enviar una sol·licitud a
arix.support@crossriver.com
Org, juntament amb el vostre clientID i MPLID, per completar la creació.
Feu servir l'abast correcte per a les API que voleu utilitzar.
L'abast de l'API per a la zona de proves és: CosLending:PreApproval:stg
Sandbox
Base del mòdul URL per a crides a l'API Descripció
Préstec origen
Presa de decisions sobre l'aplicació
|
https://arixapisandbox.crbnj. net |
La base URL per a crides a l'API d'origen de préstecs a l'entorn de proves d'Arix |
|
https://lendingsandbox.crbco s.com/preapproval/v1 |
La base URL per a la caixa de sorra de presa de decisions sobre l'aplicació |
Swagger
Enllaç Swagger del mòdul
|
Referència de l'API documentació |
https://arixapisandbox.crbnj.net/swagger-ui |
|
Ganxos |
https://lendingsandbox.crbcos.com/hooks/swagger/inde x.html |
Venent https://lendingsandbox.crbcos.com/selling/swagger/inde x.html
Pàgina d'estat
Per veure una llista de properes versions, monitoritza l'estat actual de l'API, view informes d'incidències o rebre notificacions de manteniment programat, visiteu la nostra pàgina d'estat i subscriviu-vos a les alertes.
4. Configuració del programa
Configura SFTP: Feu servir SFTP per enviar files o descarregar-los de Cross River, segons les vostres necessitats i les nostres.
Incorporació de clients: Gestioneu la informació dels vostres clients a Cross River sistema operatiu (COS) mitjançant API o l'explorador COS
Tipus i ID de productes COS: Explicació dels tipus i ID de productes COS.
Explorador de COS: Com treballar amb el nostre COS Explorer.
Portal de gestió d'organitzacions: Com treballar amb el nostre portal de gestió d'organitzacions.
4.1. Configura SFTP
Quan necessiteu intercanviar informació sensible en un file format amb Cross River, us demanem que utilitzeu Secure File Protocol de transferència de dades (SFTP). Feu servir SFTP per enviar fileo per descarregar-los de Cross River, segons les vostres necessitats i les nostres. En alguns casos, vosaltres o nosaltres els xifrarem files, especialment si contenen informació d'identificació personal (PII).
Ús de SFTP
SFTP us permet enviar i rebre informació sensible de manera segura filei informes mitjançant una carpeta assignada específicament a la vostra empresa en un servidor segur. Pugeu i descarregueu files a través d'aquesta carpeta o subcarpetes d'aquesta carpeta, segons les vostres necessitats específiques.
Ús del xifratge
Xifrat files afegeix una capa addicional de protecció. Només el personal autoritzat amb la clau correcta podrà desxifrar el xifrat fileA Cross River fem servir el xifratge PGP.
Comença
Hi ha diversos passos per posar-vos en funcionament amb el nostre servidor SFTP.
1 Empleneu el formulari de sol·licitud d'accés IP per als serveis SFTP de Cross River (des del vostre RM).
Si necessiteu compartir fileamb Cross River, el vostre gestor de relacions us enviarà un formulari de sol·licitud d'accés IP per als serveis SFTP de CRB. Entre altra informació, heu de proporcionar les adreces IP públiques estàtiques que utilitzareu per accedir a la carpeta SFTP i una clau pública PGP per xifrar i desxifrar. files. Envieu el formulari emplenat de nou al vostre gestor de relacions
IMPORTANT
Cross River només permetrà 5 adreces IP, així que tingueu-ho en compte. Les adreces IP han de ser estàtiques. Per tant, heu de fer servir de proxy per a qualsevol cosa que no sigui estàtica al vostre costat.
2 Configurem l'estructura de carpetes SFTP.
Un cop Cross River tingui les vostres dades, el nostre departament d'enginyeria informàtica crea un conjunt estàndard de carpetes i subcarpetes per a vosaltres. Aquesta ruta única és només per a la vostra empresa. Cap altre soci hi pot accedir. L'enginyeria informàtica us envia un correu electrònic amb la informació que necessiteu per accedir a les carpetes. El correu electrònic inclou un enllaç a les vostres credencials. Cross River no desa la vostra contrasenya!
IMPORTANT
L'enllaç només és vàlid durant uns dies, després dels quals hauràs de sol·licitar un restabliment de contrasenya si no el fas servir.
Les credencials també esdevenen invàlides si més de dues persones accedeixen a l'enllaç..
3 Prova de càrrega SFTP.
Si subministraràs files a Cross River, el vostre departament d'informàtica hauria de configurar un compte de servei amb un procés automatitzat per carregar-los files a les vostres carpetes SFTP. Us recomanem fermament que ho proveu abans d'intentar enviar dades reals. Poseu-vos en contacte amb el vostre gestor de relacions si teniu cap pregunta o problema o obriu una sol·licitud amb el vostre suport de primera línia.
4 Configura PGP per enviar o rebre files de Cross River. (Aquest pas només és necessari si envieu o rebeu informació personal identificable. Consulteu amb el vostre RM.)
Si necessiteu enviar Cross River files, primer us enviarem la nostra clau pública PGP per utilitzar-la per xifrar-les files.
Ja hauries d'haver enviat a Cross River la teva clau pública PGP per rebre-la. files de nosaltres.
5 Comparteix les teves dades.
Un cop configurada la carpeta SFTP i el procés estigui en marxa, podeu començar a compartir. files amb nosaltres. El vostre gestor de relacions us indica si hi ha alguna cosa més específica que heu de fer per rebre informes o com preparar les dades per enviar-nos-les.
Informes específics
Més informació sobre com preparar i enviar informes i files per:
Comptes i pagaments
Pagaments amb targeta
Risc de crèdit
Préstec
Pagaments per lots XML (ISO 20022)
4.2. Incorporació de clients
Gestioneu la informació dels vostres clients al sistema operatiu (COS) de Cross River mitjançant API o . Aquesta informació inclou detalls bàsics necessaris per obrir un COS Explorer bancari.
compte o utilitzar una targeta de crèdit, així com dades més específiques sobre el client, segons calgui. Anomenem això un registre de clients.
Abans de poder obrir un compte de dipòsit o crear una targeta, heu de crear el registre del client, de vegades anomenat incorporacióA continuació, podeu assignar un o més clients a un compte a través de la funció de clients. relacions.
El procés d'incorporació de clients inclou la creació d'un registre de client pertinent informació del client. Seguiu aquest tutorial per crear un registre de client per a cadascun de vosaltres..
Passos opcionals
Afegeix detalls d'identificació
Afegeix un beneficiari beneficiari
Codis d'error
Vegeu, juntament amb molta altra informació de referència, els codis d'error del sistema COS.
pàgina de codis de referència.
4.2.1. Registre de client
Registre de client
El registre de client és el recurs principal que conté informació del client al sistema Cross River. Per tant, abans de crear un compte per a un client, heu d'incorporar aquest client. El registre de client admet classificacions de tipus Personal o Empresa. Un cop incorporat, podeu associar un client a un o més comptes.
L'exampA continuació es mostra com incorporar un client per a un client personal.
Sol·licitud de persona a bord
POST /core/v1/cm/clients {
"ID del soci": “7cc038be-fde9-4455-b27b-1497cf667362”,
"nom": {
"prefix": «Sr.»,
"Nom": «Joan»,
"Segon nom": Robert,
"Cognom": «Smith»,
«sufix»: «Jr.»,
"NomPreferit": «Jim» },
"classificació": "Personal",
"profile": {
«regO»: fals,
"CodiPaís de la Ciutadania": "EUA",
"Persona políticament exposada": fals,
"activa la retenció de còpies de seguretat": fals,
"Percentatge de retenció de còpia de seguretat": 0,
"Tipus d'ID d'impost": Número de la Seguretat Social,
"Identificador fiscal": "123456789",
"Data de naixement": "1965-09-15",
"Qualificació de risc": "Baix",
"Exclusió de privadesa": veritat }
} Incorpora un client empresarial com ara una corporació o una LLC utilitzant el mateix punt final amb atributs lleugerament diferents.
Curl
POST /core/v1/cm/clients {
"ID del soci": “a24cba49-2bb6-431d-a867-1de81d6e4127”,
"nom": {
"nom de l'entitat": "ACME CO", },
"classificació": "Negocis",
"profile": {
"CodiPaís de la Ciutadania": "EUA",
"activa la retenció de còpies de seguretat": fals,
"Percentatge de retenció de còpia de seguretat": 0,
"Tipus d'ID d'impost": "Un",
"Identificador fiscal": "123456789",
"dateFormed": "2019-09-10",
"Tipus d'entitat": "Corporació",
"Qualificació de risc": "Baix",
"Tipus de propietat": "Entitat jurídica",
"ID del client del propietari principal": “f9321f7f-3712-46e1-b965-2b79ead64dc9”, } }
Independentment de si esteu incorporant un client particular o empresarial, el ID de client del propietari principal L'atribut ha de contenir un ID de client que faci referència a un registre de client de tipus Personal. Per tant, per incorporar una empresa, primer heu de crear un registre de client personal per al propietari principal d'aquesta empresa.
IMPORTANT
Alguns punts finals dels clients inclouen un due diligence recurs que pot ser o no necessari a l'hora d'incorporar clients particulars. L'enllaç de compliment assignat comunica els requisits per a qualsevol camp de diligència deguda durant el procés d'incorporació.
Beneficiaris efectius
Un beneficiari efectiu és una persona que posseeix el 25% o més d'una empresa. Per motius normatius, cal que disposeu de recursos en un Negocis registre de client crear un beneficiari beneficiari
per a cada beneficiari beneficiari d'aquesta empresa. El/La propietariID del client L'atribut fa referència al registre de client personal per a cada beneficiari efectiu. Normalment, afegiu recursos de beneficiari efectiu al registre de client empresarial immediatament després de la incorporació d'una empresa.
Curl
POST /core/v1/cm/customers/{customerId}/beneficial-owners {
"propietariID del client": “c1210a2d-932e-43ca-be29-f358a4382385”,
"Títol del propietari": "President" }
Adreça
Les adreces físiques associades amb el client poden ser .
actualitzat
Curl
POST /core/v1/cm/customers/{customerId}/addresses
{
"ésPrimari": cert,
"estat": "Activa",
"classificació": "Residencial",
"Tipus d'adreça": “Casa”,
carrer 1: «Carrer d'Auró, 123»,
carrer 2: "Apartament 12",
carrer 3: “”,
«ciutat»: «Nova York»,
«estat»: «Nova York»,
"Codi postal": "10025",
"Codi de país": "EUA",
}
Adreces de correu electrònic
Actualitza el correu electrònic
informació de contacte per al client.
Curl
POST /core/v1/cm/customers/{customerId}/emails {
"ésPrimari": cert,
"Tipus de correu electrònic": "Personal",
"Adreça electrònica": “john.smith@crossriver.com” }
Telèfons
Actualitza el telèfon Curl
informació de contacte per al client.
POST /core/v1/cm/customers/{customerId}/phones
{
"Tipus de telèfon": “Casa”,
"ésPrimari": cert,
"Número de telèfon": "2015551234"
}
Identificacions
Les identificacions s'utilitzen per fer un seguiment de les metadades dels documents d'identificació del client, com ara permisos de conduir i passaports. Es poden utilitzar per afegir noves dades d'identificació. Afegir dades d'identificació
Curl
POST /core/v1/cm/customers/{customerId}/identificacions {
"ésPrimari": cert,
"Número d'identificació": «DL123456789»,
"Tipus d'identificació": "Carnet de conduir",
"data d'emissió": "2018-08-30",
"Data d'expiració": "2018-08-30",
"Data verificada": "2018-08-30",
"Autoritat emissora": "DMV de Nova Jersey",
"Estat o província emissora": Nova Jersey,
"Codi de país emissor": "EUA",
}
4.2.2. Tipus i identificadors de productes COS
A Cross River, un tipus de producte és un producte financer configurat de manera única que ofereixes als teus clients. Per exempleampÉs a dir, un tipus de producte pot ser una targeta de dèbit o un compte d'estalvis, configurat segons les vostres necessitats i especificacions. Obriu comptes per als vostres clients amb qualsevol tipus de producte que definiu i configureu juntament amb nosaltres. Parleu amb el vostre gestor de relacions per obtenir més detalls, inclòs com configurar els tipus de producte per als vostres clients.
Per exampÉs a dir, potser voldreu configurar un tipus de producte com a producte de compte d'estalvis que utilitzi pagaments per transferència bancària i ACH. Aleshores, podeu oferir als vostres clients comptes d'estalvis amb aquests serveis i configuracions.
Cross River us proporciona un ID de producte per a cada tipus de producte que voleu oferir als vostres clients. Per obrir qualsevol tipus de compte de dipòsit, heu de tenir un ID de producte vàlid i un ID de client (ID de registre de client incorporat) per al titular del compte. Tingueu en compte que el titular del compte ha de tenir com a mínim una adreça i un número de telèfon al seu registre de client, i el seu estat OFAC ha de ser ClarA més, la classificació del client ha de coincidir amb la classificació configurada per al producte. Per exempleampés a dir, només es poden afegir clients empresarials a un producte empresarial.
4.2.3. Explorador de COS
Un cop sigueu al sistema de Cross River i hàgiu rebut el correu electrònic amb la incorporació
teu Identificador de client i Secret Esteu a punt per iniciar sessió al COS Explorer. AccediualportalCOSExplorer
Producció:
https://api.crbcos.com/explorer2/
Zona de proves:
https://sandbox.crbcos.com/explorer2/
Correu electrònic de benvinguda
Rebràs un correu electrònic de benvinguda de CrossRiver_DO_NOT_REPLY@crossriver.comSi no ho veieu a la safata d'entrada, reviseu les carpetes de correu brossa o de correu bloquejat.
Feu clic Crea el teu compte de Cross River.
Si sortiu de l'assistent en qualsevol moment, feu clic a l'enllaç del correu electrònic original per tornar on l'heu deixat.
Termes i condicions
Llegiu els termes i condicions, comproveu Acceptar, i feu clic A continuació.
Verificació per SMS (missatge de text)
T'enviem un SMS (missatge de text) al teu dispositiu per verificar la teva identitat. Introdueix el codi de 6 dígits que reps a la pantalla d'inici de sessió i fes clic a Verifica el codi.
Crea la teva contrasenya
1. Introduïu una contrasenya que compleixi els requisits que apareixen a la pantalla i torneu a introduir la contrasenya.
2. Feu clic Crea contrasenya.
Configuració de l'aplicació d'autenticació
Heu de completar aquest pas per continuar amb el procés de registre i poder iniciar sessió en el futur.
Per protegir la vostra identitat, el vostre compte i la vostra informació, us demanem que inicieu la sessió amb l'autenticació multifactor/de dos factors.
Si encara no teniu una aplicació d'autenticació al dispositiu, heu de baixar-ne una abans de continuar.
Per a Android i iOS, recomanem utilitzar l'aplicació d'autenticació següent:
Google Authenticator
Autenticador de Microsoft
Un cop hàgiu instal·lat l'aplicació d'autenticació, heu de fer una de les dues opcions: escaneja el codi QR or introduir manualment la clau a l'aplicació d'autenticació.
codi QR
1. Escaneja el codi QR a l'aplicació d'autenticació i, si cal, introdueix el codi de 6 dígits a la pàgina d'autenticació multifactor.
2. Feu clic a continuar.
Manual
1. Feu clic Mostra la clau
2. Copieu la clau com a Secret a la teva aplicació d'autenticació.
3. Introduïu el codi de 6 dígits.
4. Feu clic Continua.
Codi MFA no vàlid
Si introduïu un codi MFA no vàlid, un missatge vermell us notifica que ho torneu a intentar.
Ups! Has introduït un codi MFA no vàlid. Aquí tens algunes coses que cal comprovar:
1. El codi ha expirat abans de fer clic? ContinuaEl temps restant s'indica amb el cercle de compte enrere a la dreta del nom del compte i el codi MFA.
2. Si teniu l'aplicació d'autenticació configurada per a diversos entorns o aplicacions, comproveu que heu introduït el codi correcte.
1. Si no queda clar a partir dels noms de connexió MFA quina és l'opció correcta, és possible que hàgiu de provar diferents codis fins a trobar el que funcioni.
2. Un cop trobeu la connexió correcta, podeu canviar el nom de la connexió MFA a l'aplicació. Una icona de llapis a la part superior de la pantalla de l'aplicació MFA us portarà al mode d'edició. En algunes aplicacions, primer haureu de seleccionar (o mantenir premuda) la connexió que voleu editar i, a continuació, apareixerà la icona.
3. Un cop en mode d'edició, podeu canviar el nom de les connexions segons calgui per tal que quedi clar quina s'aplica a quin entorn.
4. Desa els canvis i la propera vegada hauria de ser més fàcil entendre quin codi utilitzar.
Codis de recuperació
Feu servir codis de recuperació per autenticar-vos en cas que perdeu el dispositiu.
1. Baixeu o copieu els vostres codis de recuperació i guardeu-los en un lloc segur que pugueu recordar.
2. Confirma que has desat els teus codis de recuperació
3. Feu clic Crea un compte.
La pàgina de codis de recuperació esgota el temps d'espera després de 10 minuts.
Només pots descarregar els codis de recuperació una vegada.
El vostre compte ara està actiu i el podeu utilitzar per iniciar sessió a qualsevol de les vostres aplicacions de CR.
Llistat de permís d'IP
Només es pot utilitzar una IP estàtica per accedir a COS Explorer. Poseu-vos en contacte amb el vostre servei d'assistència IP si necessiteu ajuda amb això.
Les adreces IP del servidor d'identificació són:
172.67.26.222 104.22.40.134 104.22.41.134
El servidor funciona com a proxy a través de Cloudflare.
Podeu permetre aquests FQDN:
idptest.crbcos.com
Resolució de problemes
Contrasenya oblidada
1. Feu clic Heu oblidat la contrasenya? i introdueix el teu correu electrònic.
2. Introdueix el codi d'autenticació de 6 dígits de l'aplicació d'autenticació. 3. Obteniu un He oblidat la contrasenya correu electrònic. Feu clic Restableix la contrasenya.
4. A la pàgina Restablir contrasenya, introduïu una contrasenya nova i feu clic a Restableix la contrasenya, i Continua amb l'aplicació.
Restableix l'autenticació multifactor
Si ja teniu configurat l'MFA:
1. Al servidor d'identitats, aneu a Restableix l'autenticació multifactor i feu clic Restableix el dispositiu MFA. 2. S'obre la pàgina Autenticació multifactor i podeu restablir l'MFA.
També podeu crear nous codis de recuperació d'autenticació multifactor.
1. Feu clic crear nous codis de recuperació d'autenticació multifactor.
2. S'obre la pàgina Codis de recuperació i podeu copiar o descarregar els 10 codis de recuperació nous.
Si encara no heu configurat l'autenticació multifactor, podeu habilitar l'MFA des de Configuració del compte.
1. Feu clic Restableix el mètode MFA.
2. Feu clic Configura l'autenticació multifactor (MFA).
3. Seguiu les instruccions de l'apartat Autenticació multifactor/Autenticació en 2 passos.
Si el vostre MFA actual és SMS, podeu habilitar l'MFA amb l'aplicació d'autenticació. Configuració del compte
1. Feu clic Restableix el mètode MFA.
2. Feu clic Configura l'autenticació multifactor (MFA).
3. Seguiu les instruccions de l'apartat Autenticació multifactor/Autenticació en 2 passos.
Utilitza un codi de recuperació
Si no teniu accés al vostre autenticador multifactor (de 2 factors), podeu iniciar la sessió amb un dels vostres codis de recuperació.
1. Inicia la sessió com de costum
2. A la pàgina Autenticació multifactor, teniu l'opció d'utilitzar un codi de recuperació com a opció d'autenticació.
3. Introduïu un dels vostres codis de recuperació al quadre de text. El codi de recuperació és d'un sol ús i no es pot reutilitzar. Per evitar futures confusions, us recomanem que marqueu el codi de recuperació com a utilitzat.
![]()
Bloqueig de compte
Si introduïu la contrasenya incorrecta per al vostre nom d'usuari 5 vegades, el sistema bloquejarà el vostre compte durant aproximadament 5 minuts. Si després de 5 minuts encara no podeu accedir al vostre compte, poseu-vos en contacte amb el servei d'assistència de Cross River.
Error del navegador - Tallafocs
Inicieu la sessió al COS Explorer i rebeu la pantalla d'error següent:
![]()
Estàs bloquejat per un tallafocs.
1. Poseu-vos en contacte amb el vostre departament informàtic intern per veure si la vostra organització aplica regles de tallafocs per al trànsit de sortida. Si no hi ha regles de tallafocs per al trànsit de sortida, aleshores:
2. Poseu-vos en contacte amb el vostre departament informàtic intern per assegurar-vos que us connecteu al portal Cross River COS Explorer des d'una adreça IP aprovada. Si necessiteu registrar més adreces IP, envieu un correu electrònic al servei d'assistència de COS.
4.2.3.1. Gestió d'usuaris
Gestió d'usuaris
Podeu utilitzar el Usuaris pantalla de la Admin Premeu la pestanya per agrupar un conjunt de recursos, com ara clients, productes i comptes. Un cop us hagin assignat un recurs (és a dir, producte o client), no es pot canviar.
Podeu utilitzar aquesta àrea per donar suport i fer canvis per als vostres clients. Us podem assignar 2 usuaris administradors perquè pugueu crear usuaris a demanda per als vostres clients. Això us dóna independència per gestionar els vostres clients i us permet fer canvis fora d'hores, a petició seva.
També podeu crear o incorporar nous usuaris.
Crea un nou usuari
1 En el Admin pestanya, feu clic Usuaris per obrir el Usuaris pantalla de cerca. 2 Feu clic + Nou usuari. El Crea usuari es mostra a la pantalla.
3 In Crea usuari introdueixi l'usuari Correu electrònic, es mostren els camps següents Nom, Cognom i Número de telèfon.
4 Feu clic Estat i seleccioneu Actius.
El Número de telèfon El camp ha de ser un número de telèfon mòbil, ja que s'utilitzarà perquè l'MFA autentiqui l'usuari.
Descripció del camp
|
Nom |
Nom d'usuari. Introduïu el nom d'usuari complet que es mostrarà a la finestra del navegador quan l'usuari iniciï sessió a l'Explorador. |
|
Correu electrònic |
Adreça electrònica de l'usuari. Aquesta adreça s'utilitza per iniciar sessió a l'Explorador i també serveix com a correu electrònic de recuperació per restablir la contrasenya. |
|
Estat |
Seleccioneu un estat d'usuari. L'estat d'usuari és Inactiu per defecte. Canvia-ho a Actius en crear un usuari. |
|
Tipus d'usuari |
Es mostra aquest camp Soci quan es crea l'usuari. |
|
Rols |
Seleccioneu els rols que voleu afegir a l'usuari o feu clic a Inclou tots els rols per afegir tots els rols disponibles per a l'usuari. Nota: Només seran visibles els rols que se us hagin assignat. Alguns rols contenen permisos que us permeten originar pagaments a l'Explorer. Els administradors de l'Explorer són responsables d'assegurar-se que els vostres usuaris estiguin configurats correctament només amb els rols d'usuari adequats, així com amb els límits autoritzats. |
Per a cada camp, seleccioneu un límit en dòlars (si escau)
5 Feu clic Estat i seleccioneu Actius.
6 Feu clic Rols i seleccioneu l'usuari que voleu assignar al nou usuari. Feu clic a Desa rols Canvis.
Tots els usuaris han d'estar configurats amb el Només disponible per a socis bàsics paper.
Si a l'usuari se li assigna el Originació de transferències bancàries de socis rol, heu de configurar el límit d'origen d'aquest usuari.
7 Si assigneu a l'usuari el Originació de transferències bancàries de socis rol, introduïu un valor a Pagaments electrònics.Originació camp per indicar el límit màxim en dòlars per transferència. En cas contrari, podeu ignorar aquest camp.
8 Quan hàgiu acabat de configurar tots els camps. Feu clic a Desa els canvis.
9 Si heu creat correctament un usuari nou, apareixerà una pantalla de confirmació.
10 Per completar l'addició i la configuració d'un usuari, cal que un administrador diferent Aprova els canvis.
11 El Aprova els canvis pendents visualitzacions de pantalla. Feu clic a Confirmeu.
12 Viewinformació de l'usuari
Documents/Recursos
 |
Plataforma API de Cross River [pdfManual d'usuari Plataforma API, Plataforma API, Plataforma |