Piattaforma API
Iniziare
1. Benvenuto
NUOVO! Cross River pubblico con richieste predefinite per la collezione Cross Postman
Fiume. Endpoint API
Benvenuti a Cross River documentazione
Scopri, esplora e inizia a integrare i nostri prodotti con facilità
Avvio rapido Esplora tutti i prodotti
Ottenere iniziato
Imposta e avvia il tuo viaggio utilizzando le API di Cross River
Concetti
Scopri come le soluzioni Cross River possono trasformare il tuo percorso fintech
API
Sviluppare utilizzando il sistema bancario Cross River
piattaforma e set di API robusti
Esercitazioni
Impara come usare Cross
API del fiume passo dopo passo
2. Avvio rapido
Passo 1
Passo 2
Passo 3
Passo 4
Ottieni il token di accesso
Usa il token di accesso
Costruisci una SampleApp
Ottieni le credenziali API: Il primo passo per lavorare con le API di Cross River è registrarsi per ottenere le credenziali API.
Ottieni il token di accesso: Una volta ricevute le credenziali API e prima di poter utilizzare le nostre API, è necessario ottenere un token di accesso utilizzando ID cliente E segreto_cliente che hai ricevuto al momento della registrazione.
Usa il token di accesso: Una volta effettuata l'autenticazione con successo, un token di accesso ti viene restituito. Includi questo token nell'intestazione delle tue chiamate API.
Webganci: WebGli hook sono una componente importante di qualsiasi integrazione con Cross River. Mentre le API consentono di richiedere dati su richiesta, webGli hook inviano aggiornamenti in tempo reale direttamente al sistema, eliminando la necessità di polling costanti e riducendo la latenza.
Ambienti sandbox: La sandbox è un ambiente completamente isolato, quindi sentiti libero di
2.1. Ottieni le credenziali API
Passo 1
Ottieni le credenziali API
Passo 2
Ottieni il token di accesso
Passo 3
Usa il token di accesso
Passo 4
Costruisci una SampleApp
Il primo passo per lavorare con le API di Cross River è registrarsi per ottenere le credenziali API. Con queste credenziali è possibile richiedere e ricevere un token di accesso da utilizzare per l'invio di API nel nostro ambiente sandbox.
IMPORTANTE
Il tuo indirizzo IP, che deve essere pubblico e statico, deve essere presente nella nostra lista consentita. Il tuo reparto IT interno dovrebbe essere in grado di fornirti questo IP. Scopri di più sugli IP statici.
Accesso Sandbox
Invia una richiesta per l'accesso sandbox, per ricevere le credenziali API.
Una volta aggiunto il tuo IP statico alla nostra lista consentita, ti invieremo 2 e-mail crittografate con le tue credenziali:
Una e-mail contiene il tuo ID cliente , partner_id e altre informazioni di cui avrai bisogno a seconda della tua richiesta.
La seconda e-mail, che è crittografata, contiene il tuo segreto_cliente E webgancio_segreto Ti serviranno per l'autenticazione e per lavorare nella sandbox.
NOTA
Se hai richiesto l'accesso ai pagamenti con carta, riceverai un set di credenziali aggiuntivo, tra cui un secondo ID cliente E segreto_cliente
2.2. Ottieni il token di accesso
Passo 1
Ottieni le credenziali API
Passo 2
Ottieni il token di accesso
Passo 3
Usa il token di accesso
Passo 4
Costruisci una SampleApp
Cross River utilizza OAuth 2.0 per l'autenticazione e l'autorizzazione. Questo protocollo controlla l'accesso al nostro sistema e garantisce che solo le entità autorizzate possano accedere alle nostre API e ad altre risorse protette. Le informazioni inserite nel nostro sistema di autenticazione sono riservate e non saranno mai accessibili da altre applicazioni Cross River.
Una volta ricevuto il tuo , e prima di poter utilizzare le nostre API, devi ottenere le credenziali API un token di accesso utilizzando il ID cliente E segreto_cliente ricevuto al momento della registrazione. Questo token di accesso consente di inviare informazioni in modo sicuro come oggetto JSON da utilizzare nelle nostre API. È necessario includere questo token nell'intestazione di ogni richiesta API.
Esistono diversi modi per richiedere e ricevere un token di accesso:
Utilizzare l'interfaccia della riga di comando (CLI) con cURL o qualsiasi altra lingua
Utilizzare Postman o qualsiasi altro strumento di test API
Una volta ottenuto, copia il token di accesso negli appunti. Assicurati di salvarlo.
Interfaccia a riga di comando
Per richiedere un token inviare un POST connessione/token comando contenente il ID cliente E segreto_cliente E Grant_type al (server di autenticazione) del server di autenticazione sandbox appropriata, come mostrato nella sampqui sotto.
Fare riferimento a per una spiegazione di questi tagsTabella dei componenti HTTP
Il seguente esempioample usa cURL per richiedere un token da uno dei server di autenticazione.
Sampla richiesta in cURL per COS
curl –posizione –richiesta 'POST https://idptest.crbcos.com/connect/token' \ –header 'Content-Type: application/x-www-form-urlcodificato' \ -dati-urlcodificare 'client_id=[il tuo ID qui]' \
-dati-urlcodificare 'client_secret=[il tuo segreto qui]' \
-dati-urlcodificare 'grant_type=client_credentials' \
-dati-urlcodificare 'pubblico=https://api.crbcos.com/'
Sampla risposta da cURL richiesta
{ “token di accesso”: "contiene molti caratteri", \
“scade_tra”: 86400, \
“tipo_token”: "Portatore" }
Postino
Per richiedere un token tramite Postman, inviare un POST connessione/token comando al autenticazione server della sandbox appropriata. Aggiungi il Grant_type , ambito (facoltativo) ,
ID cliente E segreto_cliente alla chiamata.
Fare riferimento a per una spiegazione di questi tagsTabella dei componenti HTTP
Se l'autenticazione ha esito positivo, il codice di stato è 200 (OK).
COSExplorer
In , fai clic sulla freccia in basso accanto al tuo login e fai clic su Copia token di accessoEsploratore COS
Il token di accesso viene copiato negli appunti, pronto per l'uso nella sandbox.
Risposta alla richiesta di token
Descrizione dell'attributo
|
accesso_a capire |
Un JSON firmato digitalmente web token (JWT) inviato dal server oAuth che consente l'accesso a risorse specifiche di Cross River |
|
ambito |
Una gamma di servizi a cui un utente può accedere |
|
scade_i n |
Il periodo di tempo fino alla scadenza del token. – Il nostro team di integrazione ti informerà della data di scadenza oppure potrai anche decodificare il tuo token di accesso. – Ti consigliamo di recuperare un nuovo token di accesso poco prima della scadenza del vecchio token. – Riutilizzare i token per tutta la loro durata anziché ottenere un nuovo token per ogni chiamata alla stessa risorsa protetta (API). IMPORTANTE: Non decodificare mai il tuo token su un server ospitato pubblicamente websito |
tipo di token
Gettone portatore
Componenti HTTP
I seguenti componenti HTTP vengono utilizzati sia nelle richieste API che in quelle Postman.
HTTP
componente
Tag Descrizione
|
Punto finale |
INVIARE /connetti/toke n |
Endpoint per il recupero di un token di accesso |
|
Intestazione |
contenuto tipo |
applicazione/x-www-form- urlcodificato |
|
Corpo |
ID cliente |
L'identificatore univoco per un client |
|
Corpo |
client_secre t |
Una stringa di caratteri crittografata utilizzata per firmare e convalidare i token ID. Importante: I segreti non sono recuperabili tramite CR. Se perdi un segreto, devi generarne uno nuovo. Non fare affida i tuoi segreti al controllo sorgente. |
|
Corpo |
Grant_type |
Questo campo avrà sempre un valore di credenziali_cliente |
|
Corpo |
pubblico opzionale |
Un modo per consentire all'utente di verificare se un determinato token di accesso è destinato a lui. |
|
Corpo |
ambito opzionale |
Un intervallo specifico o un insieme limitato di servizi a cui un utente può accedere tramite un token di accesso. Se non viene specificato un ambito, il token restituito conterrà tutti gli ambiti associati alle credenziali. Nota: È possibile inviare più ambiti nella stessa richiesta aggiungendo uno spazio tra il nome di ciascun ambito. Ad esempioample: 'ambito=ambito1 ambito2 ambito3' |
Server di autorizzazioneURLs
Server di autenticazione del modulo URL
|
Conti |
https://idptest.crbcos.com/connect/token |
|
ACH |
https://idptest.crbcos.com/connect/token |
|
Fili |
https://idptest.crbcos.com/connect/token |
|
Controlli |
https://idptest.crbcos.com/connect/token |
|
Nucleo |
https://idptest.crbcos.com/connect/token |
|
Pagamenti istantanei |
https://idptest.crbcos.com/connect/token |
|
Emissione della carta |
https://idptest.crbcos.com/connect/token |
|
Pagamenti con carta |
https://crbcos-sandbox.auth0.com/oauth/token |
Prestito https://oauthtest.crbnj.net/connect/token
Risoluzione dei problemi
Se il token di autenticazione è valido, verrà restituito un 200. Se il token di autenticazione non è valido, verrà restituito un 401.
Se non riesci a ottenere un token al portatore e non ne hai ricevuto uno in passato:
Confermare il URL.
Controllare che il ID cliente E segreto_cliente siano digitati correttamente. Sono sensibili alle maiuscole e alle minuscole.
Controlla il tuo ID cliente E segreto_cliente rispetto a quello ricevuto. Assicurati che non ci siano problemi di rete o di lista consentita.
Contatta il nostro team di integrazione se il tuo account è bloccato a causa di 3 accessi errati tentativi.
2.3. Usa il token di accesso
Passo 1
Ottieni le credenziali API
Passo 2
Ottieni il token di accesso
Passo 3
Usa il token di accesso
Passo 4
Costruisci una SampleApp
Una volta ottenuto con successo un token di accesso ti viene restituito. Includi autenticato questo token nell'intestazione delle chiamate API.
Il token di accesso scade dopo un periodo di tempo predefinito. La risposta contenente il token specifica anche il tempo di scadenza in secondi. Conserva e utilizza il token di accesso fino alla sua scadenza. Ti consigliamo di utilizzare il token fino alla ricezione dell'errore 401 di mancata autorizzazione e quindi di richiederne uno nuovo.
IMPORTANTE
1. Non richiedere un nuovo token per ogni richiesta API.
2. Assicurati di proteggere il tuo token. Chiunque rubi il tuo token può impersonare il tuo cliente per tutta la durata del token.
Intestazione richiesta API
Nell'intestazione di ogni richiesta API, includi il token di accesso come segue:
Sample chiamate per il pagamento tramite bonifico in cURL
curl –location –request 'POST https://sandbox.crbcos.com/Wires/v1/payments' –header 'Autorizzazione: Portatore [IL TUO TOKEN QUI]' \
–header 'Content-Type: application/x-www-form-urlcodificato' \
–dati-grezzi ‘{
“numero di conto”: “2255685659”,
“businessFunctionCode”: “CTR”,
“receiverRoutingNumber”: “021000021”,
“beneficiarioFi”: {
“idCode”: “F”,
“identificatore”: “021000021”,
“nome”: “JP Morgan Chase”
},
“beneficiario”: {
“idCode”: “D”,
“identificatore”: “123456789”,
“nome”: “Peter Griffin”
},
“beneficiarioRiferimento”: “XYZ123”,
“importo”: 10000,
“scopo”: “pagamento”
}'
Postino
Per utilizzare un token in Postman, vai a Autorizzazione scheda nella tua richiesta, seleziona Gettone portatore come tipo di autenticazione e incolla il tuo token nel campo fornito. Postman aggiungerà automaticamente Portatore prefisso e il token per il Gettone campo.
2.4. Webganci
WebGli hook sono una componente importante di qualsiasi integrazione con Cross River. Mentre le API consentono di richiedere dati su richiesta, webGli hook inviano aggiornamenti in tempo reale direttamente al sistema, eliminando la necessità di polling costanti e riducendo la latenza. In molti casi, webGli hook sono più efficienti e affidabili delle sole API, garantendo che la tua applicazione rimanga sincronizzata con eventi critici come modifiche dell'account, aggiornamenti delle transazioni e risultati dell'elaborazione.
Utilizzo webHook all'interno dei sistemi Cross River per avvisarti quando si verificano diversi eventi. L'evento restituisce un oggetto risorsa contenente dettagli rilevanti sull'oggetto di ciascun evento. I dettagli completi dell'evento vengono inclusi e inviati al tuo sistema.
Noi usiamo webganci per aggiornarti sullo stato e per segnalare le modifiche alle transazioni. Webgli hook inviano notifiche in tempo reale al tuo sistema quando si verifica un evento.
È necessario registrarsi tramite API per utilizzare webganci:
Registrati per account, carte ed eventi di pagamento
Registrati agli eventi sui pagamenti con carta
Registrati agli eventi di prestito
2.5. Ambienti sandbox
Il nostro sandbox è un ambiente completamente isolato, quindi sentiti libero di sperimentare. Quando sei pronto a passare alla produzione, faccelo sapere e ti forniremo le credenziali di produzione per accedere all'ambiente live.
Gestione dei clienti
Base del modulo URL per chiamate API
Gestione clienti https://sandbox.crbcos.com/core/ Conti
Base del modulo URL per chiamate API
Conti di deposito
|
https://sandbox.crbcos.com/core/ |
Deposit sweeps https://sandbox.crbcos.com/sweepsintrafi/ Carte
Base del modulo URL per chiamate API
Carte https://sandbox.crbcos.com/cardmanagement/Pagamenti
Base del modulo URL per chiamate API
|
Pagamenti istantanei |
https://sandbox.crbcos.com/rtp/ |
|
Pagamenti con carta: Push to pay |
https://pushtopaystaging.crbnj.net/ |
|
Pagamenti con carta: Pull |
https://pullfromcardapistg.crbnj.net/ |
|
Pagamenti internazionali |
https://sandbox.crbcos.com/international/ |
|
ACH |
https://sandbox.crbcos.com/ach/ |
|
Fili |
https://sandbox.crbcos.com/wires/ |
Controlli https://sandbox.crbcos.com/checks/ COSwebganci
Base del modulo URL per chiamate API
COS webganci
https://sandbox.crbcos.com/webhooks/
Prestito
Base del modulo URL per chiamate API
Originazione del prestito
|
https://arixapisandbox.crbnj.net |
Decisione applicativa https://lendingsandbox.crbcos.com/preapproval/v1
2.6. Collezione del postino
Per semplificare lo sviluppo, abbiamo messo insieme un con pre-costruito
Collezione del postino richieste per tutto il Cross River. Utilizza questa raccolta per esplorare, testare e creare endpoint API la tua integrazione direttamente in Postman, con una codifica e una configurazione aggiuntive minime richieste. Per effettuare immediatamente il fork della nostra collezione, clicca
Basta completare i dettagli di configurazione e iniziare a effettuare chiamate nella raccolta Sandbox Postman Attraverso .
Postino
token di accesso (portatore)
Abbiamo creato il nostro ambiente sandbox per sviluppatori Postman per fornire uno spazio sicuro in cui testare le API di Cross River. Nella raccolta Cross River Postman, l'autenticazione viene eseguita tramite un bearer token.
Per ottenere gli ID è necessario impostare il token di accesso (bearer) necessario per eseguire la raccolta:
1. : Con queste credenziali richiedi e ricevi un token di accesso
Ottieni le credenziali API
da utilizzare per l'invio di API nel nostro ambiente sandbox
2. : Una volta ricevute le credenziali API e prima di poter utilizzare il nostro
Ottieni il token di accesso
API, si ottiene un token di accesso utilizzando il ID cliente E segreto_cliente che hai ricevuto al momento della registrazione.
Collezione Fork Cross River
Vai direttamente alla nostra collezione per acquistarla.
Postazione di lavoro del postino
Una volta effettuato il fork, non dimenticare di impostare le variabili di ambiente per la sandbox.
Configura il tuo ambiente Postman
Per utilizzare la raccolta appena creata, accedi ad essa, fai clic Ambienti, e seleziona SabbieraCopia il tuo ID client e il segreto client di Cross River e incollali nel ID_cliente E segreto_cliente campi. Per i pagamenti con carta, incollali nel ptpe_client_id E ptpe_client_secret campi.
Ora sei pronto a ottenere un token e iniziare a inviare richieste.
1. Correre Autorizzazione/Ottieni token per generare il tuo token. Per i pagamenti con carta, esegui Pagamenti con carta/Autorizzazione/Ottieni token P2PE .
2. La variabile {{token}} (O ptpe_token per i pagamenti con carta) viene aggiunto automaticamente al tuo ambiente tramite uno script di post-risposta. Alla scadenza del token, è necessario ripetere il passaggio 1.
3. Ci sono diverse variabili che potresti dover popolare a seconda dell'endpoint che stai allenando. Ad esempioampLui, partner_id , ID prodotto , ID configurazione E richiamare_url .
4. Ci sono anche alcune variabili che vengono popolate tramite script, come gettone E ptpe_token che non dovrebbe essere compilato manualmente.
Pingthesandbox
Esegui un semplice test per verificare se riesci a connetterti alla sandbox di Cross River.
Per inviare una richiesta Ping, in Postman apri Raccolte > Raccolta API Cross River > Autorizzazione e esegui il Segnale acustico punto finale.
Richieste di modifica
Per aggiornare una richiesta, apporta le modifiche su Corpo tab. Valori in doppia curlLe parentesi y vengono estratte dalle variabili d'ambiente. Consulta la nostra documentazione API per vedere quali campi vengono utilizzati da ciascuna API.
l'endpoint accetta e view richieste nella tua lingua preferita.
3. Costruisci comeampl'app
Passo 1
Ottieni le credenziali API Impostare
Passo 2
Ottieni il token di accesso
Passo 3
Usa il token di accesso
Passo 4
Costruisci una SampleApp
: Prima di iniziare, consulta la nostra guida rapida per connetterti alle nostre API. Per testare le chiamate API, puoi usare cURL dalla riga di comando o da un servizio come Postman o Swagger nella nostra sandbox.
Clienti e conti
: Prima di utilizzare i servizi Cross River, è necessario creare un record cliente per ciascuno dei tuoi clienti
Carte
: Gestisci le carte dei tuoi clienti collaborando con Cross River per decidere cosa offrire, ad esempio carte fisiche o virtuali.
Prestito
: Il prestito include una serie di chiamate API di prestito che consentono di creare, aggiornare, e gestire i tuoi prestiti.
3.1. Impostare
Prima di iniziare, consulta la nostra guida per connetterti alle nostre API. Per testare la guida rapida all'API
chiamate, puoi usare cURL dalla riga di comando o da un servizio come Postman o Swagger nella nostra sandbox.
Per creare una carta o un'app di pagamento, è necessario creare clienti e account.
Esplora sandbox
Abbiamo tutto ciò che puoi esplorare. La sandbox è un ambiente sandbox completamente isolato. dall'ambiente di produzione, quindi sentiti libero di sperimentare. Quando sei pronto a passare alla produzione, parla con il tuo relationship manager, che ti fornirà le credenziali di produzione per accedere all'ambiente live.
Registrati pertinente web eventi di collegamento
WebGli hook sono una componente importante di qualsiasi integrazione con Cross River. Mentre le API consentono di richiedere dati su richiesta, webGli hook inviano aggiornamenti in tempo reale direttamente al sistema, eliminando la necessità di polling costanti e riducendo la latenza. In molti casi, webGli hook sono più efficienti e affidabili delle sole API, garantendo che la tua applicazione rimanga sincronizzata con eventi critici come modifiche dell'account, aggiornamenti delle transazioni e risultati dell'elaborazione.
Registro ricevere webeventi di aggancio. Quando webvengono attivati gli eventi hook, l'evento gli oggetti vengono inviati al registrato URLs.
3.2. Clienti e conti
Passo 1
Ottieni le credenziali API
Passo 2
Ottieni il token di accesso
Passo 3
Usa il token di accesso
Passo 4
Costruisci una SampleApp
Crea un record cliente e un conto finanziato:
Crea un record cliente
Crea un conto deposito
Finanzia un conto
Crea un record cliente
Prima di utilizzare i servizi Cross River, è necessario creare un record cliente per ciascuno di essi
i tuoi clienti. Il processo di onboarding del cliente include la creazione di un record del cliente con informazioni rilevanti sui clienti.
Tutti i clienti vengono automaticamente scansionati per scopi di conformità normativa, quindi è necessario registrarsi per i pertinenti webaggancia gli eventi per ricevere aggiornamenti sullo stato dei record dei clienti.
Il record del cliente può essere per entrambi Personale or Attività commerciale clienti. Una volta registrato, un cliente può essere associato a uno o più account.
Webganci
Registro per webganci. Il seguente webi ganci vengono utilizzati:
WebDescrizione del gancio
|
Core.Customer.Onboarded |
Ti avvisa che il record del cliente è stato creato |
|
Core.Customer.Ofac.Changed |
Ti avvisa che lo stato OFAC di un cliente è stato aggiornato |
Core.Customer.PepScan.Chan ged
Nti informa che lo stato PEP di un cliente è stato aggiornato
Exampcreazione di record di leof
In questo exampOra, inseriamo John Smith. Per prima cosa, creiamo un record cliente. Registreremo John come Personale cliente.
Per integrare un cliente aziendale, creare prima un record cliente personale per il proprietario principale di quell'attività. Dopodiché, crea un cliente aziendale e aggiungi il record personale come beneficiario effettivo.
1 Chiamata POST /core/v1/cm/clienti .
Nel seguente esempioamppuoi vedere quali attributi sono richiesti
IMPORTANTE
Ti consigliamo vivamente di includere una chiave di idempotenza nell'intestazione della tua richiesta
per fornire una doppia protezione in caso di guasto.
Curl
curl -X POST /core/v1/cm/clienti –header 'Content-Type: application/j {
“partnerId”: “6e80b097-693c-4592-8440-02f345335bbf”,
"nome": {
"nome di battesimo": "Giovanni",
"cognome": "Fabbro"
},
"classificazione": "Personale",
“professionistafile”: {
“regO”: falso,
“PersonaPoliticamenteEsposta”: falso,
“taxIdType”: “SSN”,
“taxId”: “119988776”,
"Data di nascita": “1953-09-22”,
“riskRating”: "Basso"
“indirizzoprimario”: {
“tipoindirizzo”: "Casa",
"classificazione": "Residenziale",
“èPrimaria”: VERO,
“strada1”: “123 Qualsiasi St”,
"città": "Ovunque",
"stato": “NY”,
"Codice Postale": “12345”,
“CodicePaese”: "NOI"
},
“telefonoprimario”: {
“èPrimaria”: VERO,
“tipo di telefono”: "Casa",
“numero di telefono”: “2015551234”
},
“email primaria”: {
“èPrimaria”: VERO,
“tipoemail”: "Personale",
"indirizzo e-mail": “John.Smith@xxxxx.com”
}
}
Una chiamata API andata a buon fine restituisce una risposta JSON con l'ID cliente univoco nella prima riga del corpo della risposta. Il tuo cliente è stato creato.
Inserimento di un organismo di risposta al cliente
{
"id": “9052b6a5-3f09-41d1-b526-ade80104eb79”,
“cifNumero”: “32653745014”,
"classificazione": "Personale",
"stato": "Attivo",
“ofac”: "In attesa di",
“pepScan”: "In attesa di",
"nome": {
"nome di battesimo": "Giovanni",
"cognome": "Fabbro",
"nome e cognome": “Giovanni Smith”
},
“professionistafile”: {
“regO”: falso,
“PersonaPoliticamenteEsposta”: falso,
“abilitare il backup con ritenuta”: falso,
“taxIdType”: “SSN”,
“taxId”: “119988776”,
"Data di nascita": “1953-09-22”,
“riskRating”: "Basso"
},
"creatoA": “2021-01-25T17:55:24.4422582-05:00”,
“lastModifiedAt”: “2021-01-25T17:55:24.4432543-05:00”,
“partnerId”: “6e80b097-693c-4592-8440-02f345335bbf”
}
2 IL Core.Customer.Onboarded webL'evento hook viene attivato quando viene creato il record del cliente.
Evento di onboarding del cliente
{
"id": “3d9c5e1a-623b-4cf2-812e-ade80105048e”,
“nomeevento”: “Core.Cliente.Integrato”,
"stato": "In attesa di",
“partnerId”: “30dee145-b6a2-4058-8dc3-ac4000dee91f”,
"creatoA": “2021-11-22T10:50:20.553-05:00”,
“risorse”: [
“core/v1/cm/customers/9052b6a5-3f09-41d1-b526-ade80104eb79” ],
"dettagli": []
}
Cross River analizza i dati del nuovo cliente per verificarne la conformità agli standard OFAC e PEP.
A volte i risultati della scansione richiedono una nuovaview dal nostro team Antiriciclaggio (AML).
Al termine della scansione, Core.Customer.Ofac.Changed E
Core.Customer.PepScan.Changed webGli eventi hook restituiscono uno stato. I clienti senza problemi di conformità mostrano un Chiaro stato.
La scansione OFAC del cliente è cambiata
{
"id": “45db5592-56ee-41f5-85e7-ade8010571ce”,
“nomeevento”: “Core.Customer.Ofac.Changed”,
"stato": "In attesa di",
“partnerId”: “30dee145-b6a2-4058-8dc3-ac4000dee91f”,
"creatoA": “2021-11-22T10:51:53.657-05:00”,
“risorse”: [
“core/v1/cm/customers/9052b6a5-3f09-41d1-b526-ade80104eb79” ],
"dettagli": []
}
La scansione PEP del cliente è cambiata
{
"id": “a5000831-3e01-4231-9ec2-ade8010571c5”,
“nomeevento”: “Core.Customer.PepScan.Changed”,
"stato": "In attesa di",
“partnerId”: “30dee145-b6a2-4058-8dc3-ac4000dee91f”,
"creatoA": “2021-11-22T10:51:53.597-05:00”,
“risorse”: [
“core/v1/cm/customers/9052b6a5-3f09-41d1-b526-ade80104eb79” ],
"dettagli": []
}
Hai creato un record cliente.
Aggiornare il record del cliente
È possibile aggiornare i dati del cliente come indirizzo, numero di telefono ed e-mail. Questi dati sono considerati primario informazioni. Se aggiungi un secondo indirizzo, questo è secondario.
1 Utilizzare l'ID cliente restituito quando si crea il record cliente per chiamare POST /core/v1/cm/customers/{id}/addresses per aggiungere il . Il primo indirizzo del cliente
l'indirizzo che aggiungi è il primario indirizzo. Nel seguente esempioamppuoi vedere quali attributi sono richiesti.
Aggiorna l'indirizzo del cliente
POST /core/v1/cm/customers/9052b6a5-3f09-41d1-b526-ade80104eb79/addresse {
“tipoindirizzo”: "Casa",
"classificazione": "Residenziale",
“èPrimaria”: VERO,
“strada1”: “123 Qualsiasi St”,
"città": "Ovunque",
"stato": “NY”,
"Codice Postale": “12345”,
“CodicePaese”: "NOI"
}
2 Chiamata POST /core/v1/cm/customers/{id}/phones per aggiungere il
telefono del cliente
Il primo numero di telefono che aggiungi è il primario numero di telefono.
numero
Aggiorna il numero di telefono del cliente
POST /core/v1/cm/customers/9052b6a5-3f09-41d1-b526-ade80104eb79/phones {
“èPrimaria”: VERO,
“tipo di telefono”: "Mobile",
“numero di telefono”: “2015552345”
}
3 Chiamata POST /core/v1/cm/clienti/{id}/email per aggiornare l'email del cliente
Aggiorna l'email del cliente
POST /core/v1/cm/customers/9052b6a5-3f09-41d1-b526-ade80104eb79/email {
“èPrimaria”: VERO,
“tipoemail”: "Personale",
"indirizzo e-mail": “john.jones@xxx.com”
}
Crea un conto deposito
CR offre diversi tipi di conti, tra cui conti correnti e conti di risparmio, certificati di deposito (CD o conti di deposito a tempo) e molto altro.
Per aprire qualsiasi tipo di conto deposito è necessario disporre di un ID prodotto valido per il tipo di conto che si desidera aprire e di un ID cliente (ID del record cliente integrato) per il titolare del conto. Si noti che il titolare del conto deve avere almeno un indirizzo e un numero di telefono nel proprio record cliente e il suo stato OFAC deve essere ChiaroInoltre, la classificazione del cliente deve corrispondere alla classificazione configurata per il prodotto. Ad esempioample, solo i clienti aziendali possono essere aggiunti a un prodotto aziendale.
Prima di iniziare
Assicurati di avere:
Credenziali API
ID partner (ricevuto al momento della registrazione)
ID cliente
ID prodotto (definisce il tipo di conto aperto)
IMPORTANTE
Si consiglia vivamente di includere una chiave di idempotenza nell'intestazione della richiesta per evitare pagamenti doppi in caso di fallimento.
Punti finali e webganci
Viene utilizzato il seguente endpoint API:
Descrizione dell'API
Aprire un conto deposito Apre un conto deposito per un cliente
Il seguente webil gancio è usato:
WebDescrizione del gancio
Core.Account.Opened È stato aperto un nuovo conto
Apri un conto
Nello scenario seguente, aprirai un account per John Smith, un cliente che hai integrato con successo.
Per aprire un conto
1 Chiamata POST core/v1/dda/account Per questa chiamata, alcuni attributi sono obbligatori. Vedi il file completo.
elenco degli attributi
Sample richiesta
POST /core/v1/dda/accounts
{
“customerId”: “59e3bc15-bbec-4990-88e9-a9a600d3296c”,
“productId”: “44015e68-1afb-40fc-9497-abc1014f52da”,
"titolo": “Giovanni Smith”,
“indirizzodichiarazione”: {
“strada1”: “257 Dalton Groves”,
"città": “Barton City”,
"stato": "MI",
"Codice Postale": “48705”,
“CodicePaese”: "NOI"
}
}
2 Una chiamata API riuscita restituisce una risposta JSON con i dettagli del nuovo account.
Sampla risposta
INVIARE /nucleo/v1/dda/conti
{
“customerId”: “59e3bc15-bbec-4990-88e9-a9a600d3296c”,
“productId”: “44015e68-1afb-40fc-9497-abc1014f52da”,
"titolo": “Giovanni Smith”,
“indirizzodichiarazione”: {
“strada1”: “257 Dalton Groves”,
"città": “Barton City”,
"stato": "MI",
"Codice Postale": “48705”,
“CodicePaese”: "NOI"
}
}
3 IL numero di conto Il campo fornisce il numero di conto per il nuovo conto.
4 Nella risposta example, l'account è classificato come Personale perché l'utente ha configurato la classificazione del prodotto come PersonaleLa classificazione dell'account corrisponde sempre alla classificazione del prodotto configurata.
5 Lo stato dell'account viene aggiornato automaticamente a Attivo ed è immediatamente disponibile per l'uso. Ciò attiva il Core.Account.Opened evento.
Dettagli dell'evento Core.Account.Opened
{
"id": “259cdbca-6a89-4af8-a50e-ada3010fb13f”,
“nomeevento”: “Conto principale aperto”,
"stato": "In attesa di",
“partnerId”: “e6c3824a-377f-44d5-a2f6-a9a600c9b37e”,
"creatoA": “2021-01-26T09:48:10.1011462-05:00”,
“risorse”: [
“core/v1/dda/accounts/2235223803”
],
"dettagli": []
}
Fundanaccount
Quando si lavora nella sandbox per testare i sistemi di pagamento e il comportamento dell'account, è necessario disporre di fondi in un account.
È possibile utilizzare qualsiasi ferrovia dotata di un endpoint di simulazione in entrata per finanziare un account sandbox, se l'account è configurato per questo scopo. In particolare, è possibile:
Simulare i pagamenti ACH in entrata
Simulare un cavo in entrata
Per qualsiasi simulazione, è necessario il numero del conto sandbox di Cross River che si desidera finanziare. Le informazioni sull'originatore non sono importanti e, in alcuni casi, possono persino essere completamente fittizie.
Prossimi passi
Dai un'occhiata ai nostri metodi di pagamento.
tutorial
3.3. Carte
Passo 1
Ottieni le credenziali API
Passo 2
Ottieni il token di accesso
Passo 3
Usa il token di accesso
Passo 4
Costruisci una SampleApp
Scopri come utilizzare le API di Cross River. Questa pagina ti mostra come:
Crea una carta
Attiva una carta
Crea una carta
Gestisci le carte dei tuoi clienti collaborando con Cross River per decidere cosa vuoi offrire, come carte fisiche o virtuali. Questo è il configurazione della schedaCross River crea un professionista della configurazione delle cartefile per te per ogni tipologia che scegli per il tuo strumento finanziario clienti.
Prima di iniziare
Assicurati di fare e avere:
Crea un record cliente
Crea un conto deposito
Numero di conto del titolare della carta
ID cliente (lo ottieni quando crei un cliente)
ID di configurazione (Cross River ti fornisce l'ID quando configuri il tuo tipo/scheda)
Ti consigliamo inoltre di consultare il relativo webeventi di hook. registrati
Punti finali ewebganci
Registro per webhook. Vengono utilizzati i seguenti endpoint API:
Descrizione dell'API
Crea nuova carta Richiede la creazione di una nuova carta di debito
Il seguente webi ganci vengono utilizzati:
WebDescrizione del gancio
Carte.Carta.Create Carta di debito creata
Ordina una carta
Imparerai come ordinare/creare una nuova carta di debito creando una carta per John Smith.
1 Chiamata POST /cardmanagement/v1/cards .
Nel seguente esempioampQui puoi vedere quali attributi sono richiesti. Vedi i dettagli dell'API completa.
Aggiungi carta
Sampcreare una carta
curl -X POST /cardmanagement/v1/cards –header 'Content-Type: applicatio “accountNumber”: “2608927303”, \
“customerId”: “2b15a695-13dc-4b10-b4e5-af5b0138873c”, \
“configurationId”: “a6b5a94c-f8f9-462b-8ce8-afa400f5b640”, \ “firstName”: “John”, \
“cognome”: “Smith”, \
"telefono": { \
“phoneType”: “Casa”, \
“numero di telefono”: “9133413131” \
}, \
"indirizzo email": "John.Smith@xxxxx.com", \
"Indirizzo di spedizione": { \
“street1”: “Lane Ave”, \
“street2”: “stringa”, \
“città”: “Grande città”, \
“stato”: “IL”, \
“codice postale”: “72410”, \
“CodicePaese”: “US” \
}, \
"Indirizzo di fatturazione": { \
“street1”: “Lane Ave”, \
“street2”: “stringa”, \
“città”: “Grande città”, \
“stato”: “IL”, \
“codice postale”: “72410”, \
“CodicePaese”: “US” \
}, \
“nomeSuCarta”: “John Smith”, \
“shippingType”: “Normale”, \
“clientIdentifier”: “stringa” \
}' 'https://sandbox.crbcos.com/CardManagement/v1/cards'
2 Una chiamata API riuscita restituisce una risposta JSON con i dettagli della nuova carta. Lo stato della carta rimarrà inattivo finché non la si attiva. L'ID è l'ID della carta, in questo caso example 8709163d-140c-4d95-a111-afa8009e9cd1, di cui avrai bisogno attivare la carta.
Sample ordina una risposta alla carta
{
"id": “8709163d-140c-4d95-a111-afa8009e9cd1”, “partnerId”: “cd9c12f4-7691-424a-b38b-af5b0134c611”, “productId”: “83bed086-8182-4151-a1e3-af5b01362783”, “numero di conto”: “2608927303”,
"stato": “Non attivato”,
“statusReasonCode”: "Non impostato",
"nome di battesimo": "Giovanni",
"cognome": "Fabbro",
"Indirizzo di spedizione": {
“strada1”: “Lane Ave”,
“strada2”: "corda",
"città": “Grande città”,
"stato": “IL”,
"Codice Postale": “72410”,
“CodicePaese”: "NOI"
},
"Indirizzo di fatturazione": {
“strada1”: “Lane Ave”,
“strada2”: "corda",
"città": “Grande città”,
"stato": “IL”,
"Codice Postale": “72410”,
“CodicePaese”: "NOI"
},
"telefono": {
“tipo di telefono”: "Casa",
“numero di telefono”: “9133413131”
},
"indirizzo e-mail": “john@anygoogle.com”,
“nomesullacarta”: “Giovanni Smith”,
“isPinSet”: falso,
“adminBloccato”: falso,
“sospetto di frode”: falso,
“ID configurazione”: “a6b5a94c-f8f9-462b-8ce8-afa400f5b640”, "categoria": "Credito",
“strumento di pagamento”: “VirtualPan”,
"processore": “nome del processore”,
“tipo di spedizione”: "Normale",
“statoordine”: "Ordine in sospeso",
“stato di sostituzione”: "Non applicabile",
“customerId”: “2b15a695-13dc-4b10-b4e5-af5b0138873c”, “clientIdentifier”: "corda",
"creatoA": “2023-02-13T04:37:29.4869172-05:00”,
“lastModifiedAt”: “2023-02-13T04:37:29.4869172-05:00”
}
3 IL Carte.Carta.create webL'evento hook viene attivato quando la scheda viene generata dal processore.
Sampl'evento Cards.Card.Created
{
"id": “cea6c5b5-13e7-4c2f-ba75-afce01110fe5”,
“nomeevento”: “Carte.Carta.Create”,
"stato": "In attesa di",
“partnerId”: “cd9c12f4-7691-424a-b38b-af5b0134c611”,
"creatoA": “2023-02-13T04:42:29.4869172-05:00”,
“risorse”: [
“cardmanagement/v1/cards/8709163d-140c-4d95-a111-afa8009e9cd1” ],
"dettagli": [
{
“cardId”: “8709163d-140c-4d95-a111-afa8009e9cd1”,
"stato": “Non attivato”,
“statusReasonCode”: "Non impostato"
}
]
}
Attiva la carta
Prima di iniziare
Assicurati di avere:
Credenziali API
ID della carta dal momento in cui hai ordinato la carta
Punti finali ewebganci
Descrizione dell'API
POST /cardmanagement/v1/cards/{id}/activate Attiva la carta utilizzando l'ID della carta Il tutorial utilizza questi webganci:
WebDescrizione del gancio
Carte.Carta.Attivate Carta di debito attivata
Attiva la carta
Attiva la carta che hai creato nel stage.
creare una carta
1 Chiamata POST /cardmanagement/v1/cards/{id}/activate . IL id l'attributo deve essere impostato sull'ID della carta. Nel sampsotto l'ID c'è 8709163d-140c-4d95-a111 afa8009e9cd1.
Samprichiesta di attivazione della carta
curl -X INVIARE
–header 'Accetta: application/json'
–header 'Autorizzazione: Titolare'<gettone>'
https://sandbox.crbcos.com/CardManagement/v1/cards/8709163d-140c-4d95-a1
2 Una chiamata API riuscita restituisce una risposta JSON con i dettagli della carta. La carta stato è adesso attivato. IL Stato dell'ordine is Completato.
Sampattiva la risposta della carta
{
"id": “8709163d-140c-4d95-a111-afa8009e9cd1”, “partnerId”: “cd9c12f4-7691-424a-b38b-af5b0134c611”, “productId”: “83bed086-8182-4151-a1e3-af5b01362783”, “processorCardId”: “804951250206718”,
“numero di conto”: “2608927303”,
"stato": "Attivo",
“statusReasonCode”: "Non impostato",
"nome di battesimo": "Giovanni",
"cognome": "Fabbro",
"Indirizzo di spedizione": {
“strada1”: “Lane Ave”,
“strada2”: "corda",
"città": “Grande città”,
"stato": “IL”,
"Codice Postale": “72410”,
“CodicePaese”: "NOI"
},
"Indirizzo di fatturazione": {
“strada1”: “Lane Ave”,
“strada2”: "corda",
"città": “Grande città”,
"stato": “IL”,
"Codice Postale": “72410”,
“CodicePaese”: "NOI"
},
"telefono": {
“tipo di telefono”: "Casa",
“numero di telefono”: “9133413131”
},
"indirizzo e-mail": “john@anygoogle.com”,
“nomesullacarta”: “Giovanni Smith”,
“panLastFour”: “3629”,
“isPinSet”: falso,
“data di scadenza”: “2026-02-13”,
“adminBloccato”: falso,
“sospetto di frode”: falso,
“ID configurazione”: “a6b5a94c-f8f9-462b-8ce8-afa400f5b640”, "categoria": "Credito",
“strumento di pagamento”: “VirtualPan”,
"processore": “nome del processore”,
“tipo di spedizione”: "Normale",
“statoordine”: "Completato",
“stato di sostituzione”: "Non applicabile",
“customerId”: “2b15a695-13dc-4b10-b4e5-af5b0138873c”,
“clientIdentifier”: "corda",
“processorCustomerId”: “T83E9D675A3N3N9O8RZ1”,
"creatoA": “2023-02-13T04:37:29.487-05:00”,
“attivazione iniziale”: “2023-02-13T00:00:00-05:00”,
“attivatoAt”: “2023-02-13T04:43:19.282287-05:00”,
“lastModifiedAt”: “2023-02-13T04:43:19.2962845-05:00”
}
3 Quando lo stato della carta cambia in Attivo , IL Carte.Carta.Attivate webviene attivato l'evento hook.
Carte.Carta.Attivate webevento di aggancio
{
"id": “95ac33ca-3d7f-49aa-bfc2-afce01113310”,
“nomeevento”: “Carte.Carta.Attivate”,
"stato": "In attesa di",
“partnerId”: “cd9c12f4-7691-424a-b38b-af5b0134c611”,
"creatoA": “2023-02-13T04:44:31.282287-05:00”,
“risorse”: [
“cardmanagement/v1/cards/8709163d-140c-4d95-a111-afa8009e9cd1” ],
"dettagli": [
{
“cardId”: “8709163d-140c-4d95-a111-afa8009e9cd1”,
"stato": "Attivo",
“statusReasonCode”: "Non impostato"
3.4. Prestito
Passo 1
Ottieni le credenziali API
Passo 2
Ottieni il token di accesso
Passo 3
Usa il token di accesso
Passo 4
Costruisci una SampleApp
Il prestito include una serie di chiamate che ti consentono di creare, aggiornare e gestire l'API di prestito i tuoi prestiti.
Per iniziare a lavorare con i prestiti, assicurati di:
Ricevi le credenziali API con gli ambiti necessari per il prestito
Se hai creato le credenziali API, utilizzando la gestione self-service
, allora dovresti anche inviare una richiesta a
arix.support@crossriver.com
Organizzazione, insieme al tuo clientid e MPLID, per completare la creazione.
Utilizzare l'ambito corretto per le API che si desidera utilizzare.
L'ambito API per sandbox è: CosLending:PreApproval:stg
Sabbiera
Base del modulo URL per le chiamate API Descrizione
Prestito origine
Decisione applicativa
|
https://arixapisandbox.crbnj. net |
La base URL per le chiamate API di erogazione dei prestiti all'ambiente sandbox Arix |
|
https://lendingsandbox.crbco s.com/preapproval/v1 |
La base URL per sandbox di decisione applicativa |
Spavalderia
Modulo Swagger Link
|
Riferimento API documentazione |
https://arixapisandbox.crbnj.net/swagger-ui |
|
Ganci |
https://lendingsandbox.crbcos.com/hooks/swagger/inde x.html |
Vendita https://lendingsandbox.crbcos.com/selling/swagger/inde x.html
StatoPagina
Per visualizzare un elenco delle prossime versioni, monitorare lo stato attuale dell'API, view segnalazioni di incidenti o ricevi notifiche sulla manutenzione programmata, visita la nostra pagina di stato e iscriviti agli avvisi
4. Configurazione del programma
Imposta SFTP: Utilizzare SFTP per inviare fileo scaricarli da Cross River, in base alle vostre e alle nostre esigenze.
Onboarding del cliente: Gestisci le informazioni dei tuoi clienti a Cross River sistema operativo (COS) utilizzando API o COS Explorer
Tipi e ID di prodotto COS: spiegazione dei tipi e degli ID di prodotto COS.
Esploratore COS: Come lavorare con il nostro COS Explorer.
Portale di gestione dell'organizzazione: come utilizzare il nostro portale di gestione dell'organizzazione.
4.1. Imposta SFTP
Quando è necessario scambiare informazioni sensibili in un file formato con Cross River, ti chiediamo di utilizzare Secure File Protocollo di trasferimento (SFTP). Utilizzare SFTP per inviare fileo scaricarli da Cross River, in base alle tue esigenze e alle nostre. In alcuni casi, tu o noi criptiamo questi files, in particolare se contengono informazioni di identificazione personale (PII).
Utilizzo di SFTP
SFTP ti consente di inviare e ricevere in modo sicuro dati sensibili filee report utilizzando una cartella assegnata specificamente alla tua attività su un server sicuro. Carica e scarica filetramite quella cartella o sottocartelle di quella cartella, in base alle tue esigenze specifiche.
Utilizzo della crittografia
Crittografia files aggiunge un ulteriore livello di protezione. Solo il personale autorizzato con la chiave corretta sarà in grado di decifrare i dati crittografati fileA Cross River utilizziamo la crittografia PGP.
Iniziare
Per iniziare a utilizzare il nostro server SFTP sono necessari diversi passaggi.
1 Compila il modulo di richiesta di accesso IP per i servizi SFTP di Cross River (dal tuo RM).
Se hai bisogno di condividere fileCon Cross River, il tuo Relationship Manager ti invierà un modulo di richiesta di accesso IP per i servizi SFTP CRB. Tra le altre informazioni, dovrai fornire gli indirizzi IP pubblici statici che utilizzerai per accedere alla cartella SFTP e una chiave pubblica PGP per la crittografia e la decrittografia. files. Invia il modulo compilato al tuo Relationship Manager
IMPORTANTE
Cross River ti consentirà di accedere solo a 5 indirizzi IP, quindi tienilo a mente. Gli indirizzi IP devono essere statici. Pertanto, devi utilizzare un proxy per tutto ciò che non è statico.
2 Impostiamo la struttura delle cartelle SFTP.
Una volta che Cross River avrà ricevuto i tuoi dati, il nostro reparto di ingegneria IT creerà per te un set standard di cartelle e sottocartelle. Questo percorso univoco è riservato esclusivamente alla tua azienda. Nessun altro partner può accedervi. Il reparto di ingegneria IT ti invierà un'e-mail con le informazioni necessarie per accedere alle cartelle. L'e-mail include un link alle tue credenziali. Cross River non salva la tua password!
IMPORTANTE
Il link è valido solo per pochi giorni, dopodiché se non lo utilizzi dovrai richiedere la reimpostazione della password.
Le credenziali diventano inoltre non valide se più di due persone accedono al link.
3 Prova il caricamento SFTP.
Se fornirai fileper Cross River, il tuo reparto IT dovrebbe impostare un account di servizio con un processo automatizzato per caricare tali filealle tue cartelle SFTP. Ti consigliamo vivamente di testare questa funzionalità prima di provare a inviare dati reali. Contatta il tuo relationship manager per qualsiasi domanda o problema o apri un ticket con il tuo supporto di prima linea.
4 Imposta PGP per inviare o ricevere fileda Cross River. (Questo passaggio è necessario solo se si inviano o si ricevono PII. Verificare con il proprio RM.)
Se devi inviare Cross River files, ti invieremo prima la nostra chiave pubblica PGP da utilizzare per crittografare tali files.
Dovresti aver già inviato a Cross River la tua chiave pubblica PGP per ricevere fileda noi.
5 Condividi i tuoi dati.
Una volta che la cartella SFTP è impostata e il processo è in atto, puoi iniziare a condividere filecon noi. Il tuo relationship manager ti dirà se c'è qualcosa di più specifico che devi fare per ricevere i report o come preparare i dati da inviarci.
Rapporti specifici
Scopri di più sulla preparazione e l'invio di report e files per:
Conti e pagamenti
Pagamenti con carta
Rischio di credito
Prestito
Pagamenti batch XML (ISO 20022)
4.2. Onboarding del cliente
Gestisci le informazioni dei tuoi clienti nel sistema operativo Cross River (COS) tramite API o . Queste informazioni includono i dettagli di base necessari per aprire un account bancario COS Explorer.
conto o utilizzare una carta di credito, nonché dati più specifici sul cliente, se necessario. Chiamiamo questo un record del cliente.
Prima di poter aprire un conto deposito o creare una carta, è necessario creare il record del cliente, a volte chiamato inserimentoÈ quindi possibile assegnare uno o più clienti a un account tramite il cliente relazioni.
Il processo di onboarding del cliente include la creazione di un record cliente pertinente informazioni sui clienti. Segui questo tutorial per creare per ognuno di voi un record cliente..
Fasi facoltative
Aggiungi dettagli ID
Aggiungere un beneficiario effettivo
Codici di errore
Vedere, insieme a molte altre informazioni di riferimento, sui codici di errore del sistema COS COS
pagina dei codici di riferimento.
4.2.1. Scheda cliente
Scheda cliente
Il record cliente è la risorsa principale contenente le informazioni sui clienti nel sistema Cross River. Pertanto, prima di creare un account per un cliente, è necessario registrarlo. Il record cliente supporta le classificazioni di tipo Personale o Aziendale. Una volta registrato, è possibile associare un cliente a uno o più account.
L'exampDi seguito viene mostrato come integrare un cliente per un cliente personale.
Richiesta di persona a bordo
POST /core/v1/cm/clienti {
“partnerId”: “7cc038be-fde9-4455-b27b-1497cf667362”,
"nome": {
"prefisso": "Sig.",
"nome di battesimo": "Giovanni",
“secondo nome”: “Roberto”,
"cognome": "Fabbro",
"suffisso": "Giovane",
“PreferredName”: "Jim" },
"classificazione": "Personale",
“professionistafile”: {
“regO”: falso,
“codicepaesecittadinanza”: "NOI",
“PersonaPoliticamenteEsposta”: falso,
“abilitare il backup con ritenuta”: falso,
“backupWithholdingPercent”: 0,
“taxIdType”: “SSN”,
“taxId”: “123456789”,
"Data di nascita": “1965-09-15”,
“riskRating”: "Basso",
“privacyOptOut”: VERO }
} Acquisisci un cliente aziendale, ad esempio una società o una LLC, utilizzando lo stesso endpoint con attributi leggermente diversi.
Curl
POST /core/v1/cm/clienti {
“partnerId”: “a24cba49-2bb6-431d-a867-1de81d6e4127”,
"nome": {
“nomeentità”: “ACME CO”, },
"classificazione": "Attività commerciale",
“professionistafile”: {
“codicepaesecittadinanza”: "NOI",
“abilitare il backup con ritenuta”: falso,
“backupWithholdingPercent”: 0,
“taxIdType”: “Ein”,
“taxId”: “123456789”,
“dataFormata”: “2019-09-10”,
“tipoentità”: "Società",
“riskRating”: "Basso",
“tipoproprietà”: “Entità Legale”,
“primaryOwnerCustomerId”: “f9321f7f-3712-46e1-b965-2b79ead64dc9”, } }
Indipendentemente dal fatto che tu stia integrando un cliente personale o aziendale, il Proprietario primario CustomerId L'attributo deve contenere un ID cliente che faccia riferimento a un record cliente di tipo Personale. Pertanto, per integrare un'azienda, è necessario prima creare un record cliente personale per il proprietario principale di tale azienda.
IMPORTANTE
Alcuni endpoint del cliente includono un diligenza dovuta Risorse che potrebbero essere necessarie o meno durante l'onboarding di clienti privati. Il referente per la conformità assegnato comunicherà i requisiti per tutti i campi di Due Diligence durante il processo di onboarding.
Beneficiari effettivi
Il beneficiario effettivo è una persona che possiede il 25% o più di un'azienda. Per motivi normativi, è necessario disporre di risorse in un Attività commerciale record cliente crea un beneficiario effettivo
per ogni beneficiario effettivo di tale attività. Il ownerCustomerId L'attributo fa riferimento al record cliente personale di ciascun beneficiario effettivo. Solitamente, le risorse relative al beneficiario effettivo vengono aggiunte al record cliente aziendale subito dopo l'onboarding di un'azienda.
Curl
POST /core/v1/cm/customers/{customerId}/beneficial-owners {
“ownerCustomerId”: “c1210a2d-932e-43ca-be29-f358a4382385”,
“ownerTitle”: "Presidente" }
Indirizzo
Gli indirizzi fisici associati al cliente possono essere .
aggiornato
Curl
POST /core/v1/cm/customers/{customerId}/addresses
{
“èPrimaria”: VERO,
"stato": "Attivo",
"classificazione": "Residenziale",
“tipoindirizzo”: "Casa",
“strada1”: “123 Via dell'Acero”,
“strada2”: “Appartamento 12”,
“strada3”: “”,
"città": "New York",
"stato": “NY”,
"Codice Postale": “10025”,
“CodicePaese”: "NOI",
}
Indirizzi email
Aggiorna email
informazioni di contatto del cliente.
Curl
POST /core/v1/cm/customers/{customerId}/emails {
“èPrimaria”: VERO,
“tipoemail”: "Personale",
"indirizzo e-mail": “john.smith@crossriver.com” }
Telefoni
Aggiorna telefono Curl
informazioni di contatto del cliente.
POST /core/v1/cm/customers/{customerId}/phones
{
“tipo di telefono”: "Casa",
“èPrimaria”: VERO,
“numero di telefono”: “2015551234”
}
Identificazioni
Le identificazioni vengono utilizzate per tracciare i metadati dei documenti identificativi dei clienti, come patenti di guida e passaporti. Possono essere utilizzate per aggiungere nuovi dettagli di identificazione. Aggiungi dettagli di identificazione
Curl
POST /core/v1/cm/customers/{customerId}/identifications {
“èPrimaria”: VERO,
“idNumero”: “DL123456789”,
“idType”: “Patente di guida”,
“data di emissione”: “2018-08-30”,
“data di scadenza”: “2018-08-30”,
“dataverificata”: “2018-08-30”,
"autorità rilasciante": “Motorizzazione del New Jersey”,
“Stato o provincia emittente”: “NJ”,
“codice paese di emissione”: "NOI",
}
4.2.2. Tipi di prodotto e ID COS
A Cross River, un tipo di prodotto è un prodotto finanziario configurato in modo univoco che offri ai tuoi clienti. Ad esempioampAd esempio, una tipologia di prodotto potrebbe essere una carta di debito o un conto di risparmio, configurati in base alle tue esigenze e specifiche. Puoi aprire conti per i tuoi clienti con qualsiasi tipologia di prodotto tu definisca e configuri insieme a noi. Rivolgiti al tuo relationship manager per maggiori dettagli, incluso come impostare le tipologie di prodotto per i tuoi clienti.
Per esempioampAd esempio, potresti voler configurare un tipo di prodotto come conto di risparmio che utilizza bonifici e pagamenti ACH. Potrai quindi offrire ai tuoi clienti conti di risparmio con questi servizi e configurazioni.
Cross River ti fornisce un ID prodotto per ogni tipo di prodotto che desideri offrire ai tuoi clienti. Per aprire qualsiasi tipo di conto deposito, devi disporre di un ID prodotto valido e di un ID cliente (ID del record cliente integrato) per il titolare del conto. Tieni presente che il titolare del conto deve avere almeno un indirizzo e un numero di telefono nel suo record cliente e il suo stato OFAC deve essere ChiaroInoltre, la classificazione del cliente deve corrispondere alla classificazione configurata per il prodotto. Ad esempioample, solo i clienti aziendali possono essere aggiunti a un prodotto aziendale.
4.2.3. Esploratore COS
Una volta che sei nel sistema Cross River e hai ricevuto l'e-mail con l'onboarding
tuo ID cliente E Segreto sei pronto per accedere a COS Explorer. Accedi al portale COSE Explorer
Produzione:
https://api.crbcos.com/explorer2/
Sandbox:
https://sandbox.crbcos.com/explorer2/
Email di benvenuto
Riceverai un'email di benvenuto da CrossRiver_DO_NOT_REPLY@crossriver.comSe non lo vedi nella posta in arrivo, controlla la cartella spam o la posta bloccata.
Clic Crea il tuo account Cross River.
Se in qualsiasi momento decidi di abbandonare la procedura guidata, clicca sul collegamento presente nell'e-mail originale per tornare al punto in cui eri rimasto.
Termini e Condizioni
Leggi attentamente i termini e le condizioni, controlla Accettaree fai clic Prossimo.
Verifica tramite SMS (messaggio di testo)
Ti invieremo un SMS (messaggio di testo) sul tuo dispositivo per verificare la tua identità. Inserisci il codice di 6 cifre che hai ricevuto nella schermata di accesso e clicca su Verifica codice.
Crea la tua password
1. Inserisci una password che soddisfi i requisiti visualizzati sullo schermo e reinseriscila.
2. Clic Crea password.
Configurazione dell'app Authenticator
È necessario completare questo passaggio per continuare il processo di registrazione e poter effettuare l'accesso in futuro
Per proteggere la tua identità, il tuo account e le tue informazioni, ti chiediamo di effettuare l'accesso con l'autenticazione a più fattori/a due fattori.
Se non hai ancora un'app di autenticazione sul tuo dispositivo, devi scaricarne una prima di continuare.
Per Android e iOS, consigliamo di utilizzare la seguente app di autenticazione:
Autenticazione Google
Microsoft Authenticator
Una volta installata l'app di autenticazione, è necessario: scansiona il codice QR or inserire manualmente la chiave nell'app di autenticazione.
Codice QR
1. Scansiona il codice QR nella tua app di autenticazione e, se necessario, inserisci il codice a 6 cifre nella pagina di autenticazione a più fattori.
2. Fare clic su Continua.
Manuale
1. Clic Mostra chiave
2. Copia la chiave come Segreto nella tua app di autenticazione.
3. Inserisci il codice a 6 cifre.
4. Clic Continuare.
Codice MFA non valido
Se inserisci un codice MFA non valido, un messaggio rosso ti avvisa di riprovare.
Ops! Hai inserito un codice MFA non valido. Ecco alcuni aspetti da verificare:
1. Il codice è scaduto prima di aver cliccato Continuare? Il tempo rimanente è indicato dal cerchio del conto alla rovescia a destra del nome dell'account e del codice MFA.
2. Se hai configurato l'app di autenticazione per più ambienti o applicazioni, verifica di aver inserito il codice corretto.
1. Se dai nomi delle connessioni MFA non è chiaro quale sia l'opzione corretta, potrebbe essere necessario provare codici diversi fino a trovare quello che funziona.
2. Una volta trovata la connessione corretta, puoi rinominarla nell'app. Un'icona a forma di matita nella parte superiore della schermata dell'app MFA ti porterà alla modalità di modifica. In alcune app, dovrai prima selezionare (o tenere premuta) la connessione da modificare, dopodiché apparirà l'icona.
3. Una volta in modalità di modifica, è possibile rinominare le connessioni in base alle proprie esigenze, in modo che sia chiaro quale si applica a quale ambiente.
4. Salva le modifiche e la prossima volta sarà più facile capire quale codice utilizzare.
Codici di recupero
Utilizza i codici di ripristino per autenticarti nel caso in cui perdessi il dispositivo.
1. Scarica o copia i tuoi codici di recupero e conservali in un luogo sicuro e facile da ricordare.
2. Conferma di aver memorizzato i tuoi codici di recupero
3. Clic Creare un account.
La pagina dei codici di ripristino scade dopo 10 minuti.
Puoi scaricare i codici di recupero solo una volta.
Il tuo account è ora attivo e puoi utilizzarlo per accedere a tutte le tue app CR.
Elenco IP consentiti
Per accedere a COS Explorer è possibile utilizzare solo un IP statico. Contatta il supporto IP se hai bisogno di aiuto.
Gli indirizzi IP del server di identità sono:
172.67.26.222 104.22.40.134 104.22.41.134
Il server è proxy tramite Cloudflare.
È possibile consentire questi FQDN:
idptest.crbcos.com
Risoluzione dei problemi
Ha dimenticato la password
1. Clic Ha dimenticato la password? e inserisci la tua email.
2. Inserisci il codice di autenticazione a 6 cifre dall'app di autenticazione. 3. Ottieni un Ha dimenticato la password e-mail. Clicca Reimposta password.
4. Nella pagina Reimpostazione password, inserisci una nuova password, fai clic su Reimposta password, E Continua all'applicazione.
Reimposta l'autenticazione multifattoriale
Se hai già configurato MFA:
1. In Identity Server, vai a Reimposta MFA e clicca Reimposta il tuo dispositivo MFA. 2. Si apre la pagina Autenticazione a più fattori e puoi reimpostare l'MFA.
È anche possibile creare nuovi codici di ripristino per l'autenticazione a più fattori.
1. Clic creare nuovi codici di ripristino per l'autenticazione a più fattori.
2. Si aprirà la pagina Codici di recupero e potrai copiare o scaricare i tuoi 10 nuovi codici di recupero.
Se non hai ancora configurato l'autenticazione a più fattori, puoi abilitare MFA da Impostazioni dell'account.
1. Clic Reimposta metodo MFA.
2. Clic Configurare MFA.
3. Seguire le istruzioni in Autenticazione a più fattori/Autenticazione in due passaggi.
Se il tuo MFA attuale è SMS, puoi abilitare MFA con la tua app di autenticazione. In Impostazioni dell'account
1. Clic Reimposta metodo MFA.
2. Clic Configurare MFA.
3. Seguire le istruzioni in Autenticazione a più fattori/Autenticazione in due passaggi.
Utilizzare un codice di recupero
Se non hai accesso al tuo sistema di autenticazione multifattoriale (a 2 fattori), puoi effettuare l'accesso utilizzando uno dei tuoi codici di recupero.
1. Accedi come al solito
2. Nella pagina Autenticazione a più fattori, hai la possibilità di utilizzare un codice di ripristino come opzione di autenticazione.
3. Inserisci uno dei tuoi codici di recupero nella casella di testo. Il codice di recupero è monouso e non può essere riutilizzato. Per evitare futuri malintesi, ti consigliamo di contrassegnare il codice di recupero come utilizzato.
![]()
Blocco dell'account
Se inserisci la password errata per 5 volte consecutive, il sistema bloccherà il tuo account per circa 5 minuti. Se dopo 5 minuti non riesci ancora ad accedere al tuo account, contatta l'assistenza Cross River.
Errore del browser -Firewall
Accedendo a COS Explorer viene visualizzata la seguente schermata di errore:
![]()
Sei bloccato da un firewall.
1. Contatta il tuo reparto IT interno per verificare se la tua organizzazione applica regole firewall per il traffico in uscita. Se non ci sono regole firewall per il traffico in uscita, allora:
2. Contatta il tuo reparto IT interno per assicurarti di connetterti al portale Cross River COS Explorer da un indirizzo IP approvato. Se devi registrare altri indirizzi IP, invia un'e-mail al supporto COS.
4.2.3.1. Gestione degli utenti
Gestione degli utenti
Puoi usare il Utenti schermata del Amministratore scheda per raggruppare un insieme di risorse, come clienti, prodotti e account. Una volta assegnata una risorsa (ad esempio, un prodotto o un cliente), non è più possibile modificarla.
Puoi utilizzare quest'area per supportare e apportare modifiche per i tuoi clienti. Possiamo fornirti 2 utenti amministratori in modo che tu possa creare utenti su richiesta per i tuoi clienti. Questo ti dà indipendenza nella gestione dei tuoi clienti e ti consente di apportare modifiche fuori orario, su loro richiesta.
Puoi anche creare o integrare nuovi utenti.
Crea un nuovo utente
1 Nel Amministratore scheda, clicca Utenti per aprire il Utenti schermata di ricerca. 2 Clic + Nuovo utente. IL Crea utente viene visualizzato sullo schermo.
3 In Crea utente inserisci l'utente E-mail, vengono quindi visualizzati i seguenti campi Nome di battesimo, Cognome E Numero di telefono.
4 Clic Stato e seleziona Attivo.
IL Numero di telefono Il campo deve essere un numero di cellulare poiché verrà utilizzato dall'MFA per autenticare l'utente.
Descrizione campo
|
Nome |
Nome utente. Inserisci il nome utente completo da visualizzare nella finestra del browser quando l'utente accede a Explorer. |
|
|
Indirizzo email dell'utente. Questo indirizzo viene utilizzato per accedere a Explorer e funge anche da email di recupero per la reimpostazione della password. |
|
Stato |
Seleziona uno stato utente. Lo stato utente è Inattivo per impostazione predefinita. Cambialo in Attivo durante la creazione di un utente. |
|
Tipo di utente |
Viene visualizzato questo campo Partner quando l'utente viene creato. |
|
Ruoli |
Seleziona i ruoli da aggiungere all'utente oppure fai clic su Includi tutti i ruoli per aggiungere tutti i ruoli disponibili all'utente. Nota: Saranno visibili solo i ruoli a te assegnati. Alcuni ruoli contengono autorizzazioni che ti consentono di effettuare pagamenti in Explorer. Gli amministratori di Explorer sono tenuti a garantire che i tuoi utenti siano configurati correttamente, con i ruoli utente appropriati e i limiti autorizzati. |
Per ogni campo, seleziona un limite in dollari (se applicabile)
5 Clic Stato e seleziona Attivo.
6 Clic Ruoli e seleziona l'utente a cui vuoi assegnare il nuovo utente. Fai clic Salva ruoli Cambiamenti.
Tutto gli utenti devono essere configurati con Solo Partner Core Ready ruolo.
Se all'utente viene assegnato il Originazione dei cavi partner ruolo è necessario configurare il limite di origine di quell'utente.
7 Se stai assegnando all'utente il Originazione dei cavi partner ruolo, immettere un valore nel Bonifico.Pagamenti.Originate campo per indicare il limite massimo in dollari per bonifico. In caso contrario, puoi ignorare questo campo.
8 Una volta completata la configurazione di tutti i campi, fare clic su Salva le modifiche.
9 Se hai creato correttamente un nuovo utente, verrà visualizzata una schermata di conferma.
10 Per completare l'aggiunta e la configurazione di un utente, è necessario un amministratore diverso Approva le modifiche.
11 IL Approva le modifiche in sospeso viene visualizzata la schermata. Fare clic Confermare.
12 Viewinformazioni utente
Documenti / Risorse
 |
Piattaforma API Cross River [pdf] Manuale d'uso Piattaforma API, Piattaforma API, Piattaforma |