API-platform
Kom godt i gang
1. Velkomst
NY! Cross River-publikum med præbyggede anmodninger til Cross Postman-samlingen
Flod. API-slutpunkter
Velkommen til Cross River dokumentation
Opdag, udforsk og begynd nemt at integrere vores produkter
Hurtigstart Udforsk alle produkter
Få startede
Opsæt og start din rejse ved hjælp af Cross River API'er
Begreber
Opdag, hvordan Cross Rivers løsninger kan transformere din fintech-rejse
API'er
Udvikl ved hjælp af Cross River-bredden
platform og robuste API-sæt
Selvstudier
Lær hvordan du bruger Cross
River API'er trin for trin
2. Quickstart
Trin 1
Trin 2
Trin 3
Trin 4
Få adgangstoken
Brug adgangstoken
Byg en Sample App
Få API-legitimationsoplysninger: Dit første skridt til at arbejde med Cross River API'er er at registrere dig for API-legitimationsoplysninger.
Få adgangstoken: Når du har modtaget dine API-legitimationsoplysninger, og før du kan bruge vores API'er, skal du få et adgangstoken ved hjælp af klient_id og klient_hemmelighed du modtog, da du registrerede dig.
Brug adgangstoken: Når du har godkendt dig, vil en adgangstoken returneres til dig. Medtag dette token i headeren på dine API-kald.
Webkroge: WebHooks er en vigtig komponent i enhver integration med Cross River. Mens API'er giver dig mulighed for at anmode om data on-demand, webHooks sender realtidsopdateringer direkte til dit system – hvilket eliminerer behovet for konstant polling og reducerer latenstid.
Sandkassemiljøer: Sandkassen er et fuldstændig isoleret miljø, så du er velkommen til at
2.1. Få API-legitimationsoplysninger
Trin 1
Få API-legitimationsoplysninger
Trin 2
Få adgangstoken
Trin 3
Brug adgangstoken
Trin 4
Byg en Sample App
Dit første skridt til at arbejde med Cross River API'er er at registrere dig for API-legitimationsoplysninger. Med disse legitimationsoplysninger kan du anmode om og modtage et adgangstoken, der skal bruges til at sende API'er i vores sandbox-miljø.
VIGTIG
Din IP-adresse, som skal være offentlig og statisk, skal være på vores tilladelsesliste. Din interne IT-afdeling burde kunne give dig denne IP-adresse. Lær mere om statiske IP-adresser.
SandboxAdgang
Send en anmodning for sandbox-adgang, for at modtage API-legitimationsoplysninger.
Når din statiske IP-adresse er føjet til vores tilladelsesliste, sender vi dig 2 krypterede e-mails med dine loginoplysninger:
Én e-mail indeholder din klient_id , partner_id og andre oplysninger, du skal bruge, afhængigt af hvad du har anmodet om.
Den anden e-mail, som er krypteret, indeholder din klient_hemmelighed og webkrog_hemmelighed Du skal bruge disse til godkendelse og til at arbejde i sandkassen.
NOTE
Hvis du har bedt om adgang til kortbetalinger, modtager du et ekstra sæt loginoplysninger, herunder et andet klient_id og klient_hemmelighed
2.2. Få adgangstoken
Trin 1
Få API-legitimationsoplysninger
Trin 2
Få adgangstoken
Trin 3
Brug adgangstoken
Trin 4
Byg en Sample App
Cross River bruger OAuth 2.0 til godkendelse og autorisation. Dette kontrollerer adgang til vores system og sikrer, at kun autoriserede enheder kan få adgang til vores API'er og andre beskyttede ressourcer. De oplysninger, du indtaster i vores godkendelsessystem, er fortrolige og kan aldrig tilgås fra andre Cross River-applikationer.
Når du har modtaget din [navn], og før du kan bruge vores API'er, skal du have API-legitimationsoplysninger en adgangstoken ved hjælp af klient_id og klient_hemmelighed du modtog, da du registrerede dig. Denne adgangstoken giver dig mulighed for at sende oplysninger sikkert som et JSON-objekt til brug i vores API'er. Du skal inkludere denne token i headeren på hver API-anmodning.
Der er flere måder at anmode om og modtage en adgangstoken på:
Brug kommandolinjegrænsefladen (CLI) med cURL eller et hvilket som helst andet sprog
Brug Postman eller et andet API-testværktøj
Når du har fået adgangstokenet, skal du kopiere det til din udklipsholder. Sørg for at gemme det.
Kommandolinjegrænseflade
For at anmode om et token, send en POST-forbindelse/token kommandoen, der indeholder klient_id og klient_hemmelighed og tilskudstype til (godkendelsesserveren) for godkendelsesserveren passende sandkasse, som vist i sample nedenfor.
Se for en forklaring af disse tagsTabel over HTTP-komponenter
Følgende example bruger cURL at anmode om et token fra en af godkendelsesserverne.
Sampanmodningen i cURL til COS
curl –placering –anmodning 'POST https://idptest.crbcos.com/connect/token' \ –header 'Indholdstype: application/x-www-form-'urlkodet' \ –data-urlencode 'client_id=[dit id her]' \
–data-urlencode 'client_secret=[din hemmelighed her]' \
–data-urlencode 'grant_type=klient_legitimationsoplysninger' \
–data-urlencode 'publikum=https://api.crbcos.com/'
Sampsvaret fra cURL anmodning
{ "adgangstoken": "indeholder mange tegn", \
"udløber_om": 86400, \
"token_type": "Bærer" }
Postbud
For at anmode om en token ved hjælp af Postman, send en POST-forbindelse/token kommandoen til auth server af den relevante sandkasse. Tilføj tilskudstype , omfang (valgfrit) ,
klient_id og klient_hemmelighed til opkaldet.
Se for en forklaring af disse tagsTabel over HTTP-komponenter
Hvis godkendelsen lykkes, er statuskoden 200 (OK).
COSExplorer
I skal du klikke på pil ned ud for dit login og klikke på Kopiér adgangstokenCOS Explorer
Adgangstokenet kopieres til dit udklipsholder, klar til brug i .sandkassen
Svar på tokenanmodning
Attributbeskrivelse
|
adgang_til ken |
En digitalt signeret JSON web token (JWT) sendt fra oAuth-serveren, der giver adgang til specifikke Cross River-ressourcer |
|
omfang |
En række tjenester, som en bruger kan få adgang til |
|
udløber_i n |
Den tid, der går, indtil tokenet udløber. – Vores integrationsteam vil informere dig om udløbstiden, eller du kan også afkode din adgangstoken. – Vi anbefaler, at du henter et nyt adgangstoken kort tid før det gamle token udløber. – Genbrug tokens i hele deres levetid i stedet for at få et nyt token for hvert kald til den samme beskyttede ressource (API). VIGTIG: Afkod aldrig din token på en offentligt hostet webwebsted |
tokentype
Bærertoken
HTTP-komponenter
Følgende HTTP-komponenter bruges i både API- og Postman-anmodninger.
HTTP
komponent
Tag Beskrivelse
|
Slutpunkt |
STOLPE /connect/toke n |
Slutpunkt til hentning af et adgangstoken |
|
Overskrift |
tilfreds type |
ansøgning/x-www-formular- urlkodet |
|
Legeme |
klient_id |
Den unikke identifikator for en klient |
|
Legeme |
klient_hemmelighed t |
En krypteret tegnstreng, der bruges til at underskrive og validere ID-tokens. Vigtig: Hemmeligheder kan ikke gendannes via CR. Hvis du mister en hemmelighed, skal der genereres en ny. Gør ikke overgiv dine hemmeligheder til kildekontrol. |
|
Legeme |
tilskudstype |
Dette felt vil altid have værdien klientlegitimationsoplysninger |
|
Legeme |
publikum valgfri |
En måde hvorpå brugeren kan validere, om et bestemt adgangstoken er beregnet til dem. |
|
Legeme |
omfang valgfri |
Et specifikt udvalg eller et begrænset sæt af tjenester, som en bruger kan få adgang til med et adgangstoken. Hvis der ikke er angivet et omfang, vil det returnerede token indeholde alle omfang, der er knyttet til dine legitimationsoplysninger. Note: Flere scopes kan sendes i samme anmodning ved at tilføje et mellemrum mellem navnet på hvert scope. For eksempelample: 'scope=scope1 scope2 scope3' |
Aut.serverURLs
Modulgodkendelsesserver URL
|
Regnskaber |
https://idptest.crbcos.com/connect/token |
|
ACH |
https://idptest.crbcos.com/connect/token |
|
Ledninger |
https://idptest.crbcos.com/connect/token |
|
Checks |
https://idptest.crbcos.com/connect/token |
|
Kerne |
https://idptest.crbcos.com/connect/token |
|
Øjeblikkelige betalinger |
https://idptest.crbcos.com/connect/token |
|
Kortudstedelse |
https://idptest.crbcos.com/connect/token |
|
Kortbetalinger |
https://crbcos-sandbox.auth0.com/oauth/token |
Udlån https://oauthtest.crbnj.net/connect/token
Fejlfinding
Hvis godkendelsestokenet er gyldigt, returnerer det en 200. Hvis godkendelsestokenet ikke er gyldigt, returnerer det en 401.
Hvis du ikke kan få en bearer-token, og du ikke har modtaget en tidligere:
Bekræft URL.
Tjek, at klient_id og klient_hemmelighed er skrevet korrekt. De skelner mellem store og små bogstaver.
Tjek din klient_id og klient_hemmelighed i forhold til den, du har modtaget. Sørg for, at der ikke er problemer med netværket eller tilladelseslisten.
Kontakt vores integrationsteam, hvis din konto er låst som følge af 3 forkerte login-angivelser. forsøg.
2.3. Brug adgangstoken
Trin 1
Få API-legitimationsoplysninger
Trin 2
Få adgangstoken
Trin 3
Brug adgangstoken
Trin 4
Byg en Sample App
Når du har gjort det, vil en adgangstoken returneres til dig. Inkluder godkendt dette token i headeren på dine API-kald.
Adgangstokenet udløber efter et bestemt tidsrum. Svaret, der indeholder tokenet, angiver også udløbstiden i sekunder. Gem og brug dit adgangstoken, indtil det udløber. Vi anbefaler, at du bruger tokenet, indtil du modtager en uautoriseret fejl 401, og derefter anmoder om et nyt token.
VIGTIG
1. Anmod ikke om et nyt token for hver API-anmodning.
2. Sørg for at beskytte din token. Enhver, der stjæler din token, kan udgive sig for at være din klient, så længe tokenen er gældende.
API-anmodningsheader
I headeren på hver API-anmodning skal du inkludere adgangstokenet som følger:
Sampopkald til bankbetaling i cURL
curl –placering –anmodning 'POST https://sandbox.crbcos.com/Wires/v1/payments' –header 'Godkendelse: Bærer [DIN TOKEN HER]' \
–header 'Indholdstype: application/x-www-form-'urlkodet' \
–data-rå ‘{
"Kontonummer": "2255685659",
"forretningsfunktionskode": "CTR",
"modtagerrutingsnummer": "021000021",
"modtagerFi": {
"id-kode": "F",
"identifikator": "021000021",
"navn": "JP Morgan Chase"
},
"modtager": {
"id-kode": "D",
"identifikator": "123456789",
"navn": "Peter Griffin"
},
"modtagerreference": "XYZ123",
"beløb": 10000,
"formål": "betaling"
}'
Postbud
For at bruge en token i Postman skal du navigere til Bemyndigelse fanen i din anmodning, vælg Bærertoken som godkendelsestype, og indsæt din token i det angivne felt. Postman vil automatisk tilføje Bærer præfikset og tokenet til Token felt.
2.4. Webkroge
WebHooks er en vigtig komponent i enhver integration med Cross River. Mens API'er giver dig mulighed for at anmode om data on-demand, webHooks sender realtidsopdateringer direkte til dit system, hvilket eliminerer behovet for konstant polling og reducerer latenstid. I mange tilfælde webHooks er mere effektive og pålidelige end API'er alene, hvilket sikrer, at din applikation forbliver synkroniseret med kritiske hændelser som kontoændringer, transaktionsopdateringer og behandlingsresultater.
Bruge webhooks i Cross River-systemerne for at give dig besked, når forskellige hændelser indtræffer. Hændelsen returnerer et ressourceobjekt, der indeholder relevante detaljer om emnet for hver hændelse. De fulde hændelsesdetaljer inkluderes og sendes til dit system.
vi bruger webkroge til at opdatere dig om status og rapportere transaktionsændringer. WebHooks rapporterer til dit system med realtidsnotifikationer, når en hændelse indtræffer.
Du skal registrere dig via API for at bruge webkroge:
Tilmelding til konti, kort og betalingshændelser
Tilmelding til kortbetalingsarrangementer
Tilmeld dig udlånsarrangementer
2.5. Sandkassemiljøer
Vores sandkasse er et fuldstændig isoleret miljø, så du er velkommen til at eksperimentere. Når du er klar til at gå over til produktion, så giv os besked, så giver vi dig produktionsoplysninger, så du kan få adgang til live-miljøet.
Kundestyring
Modulbase URL til API-kald
Kundehåndtering https://sandbox.crbcos.com/core/ Regnskaber
Modulbase URL til API-kald
Indlånskonti
|
https://sandbox.crbcos.com/core/ |
Indskudskontrol https://sandbox.crbcos.com/sweepsintrafi/ Kort
Modulbase URL til API-kald
Kort https://sandbox.crbcos.com/cardmanagement/Betalinger
Modulbase URL til API-kald
|
Øjeblikkelige betalinger |
https://sandbox.crbcos.com/rtp/ |
|
Kortbetalinger: Tryk for at betale |
https://pushtopaystaging.crbnj.net/ |
|
Kortbetalinger: Træk |
https://pullfromcardapistg.crbnj.net/ |
|
Internationale betalinger |
https://sandbox.crbcos.com/international/ |
|
ACH |
https://sandbox.crbcos.com/ach/ |
|
Ledninger |
https://sandbox.crbcos.com/wires/ |
Checks https://sandbox.crbcos.com/checks/ COSwebkroge
Modulbase URL til API-kald
COS webkroge
https://sandbox.crbcos.com/webhooks/
Udlån
Modulbase URL til API-kald
Låneoprettelse
|
https://arixapisandbox.crbnj.net |
Ansøgningsbeslutning https://lendingsandbox.crbcos.com/preapproval/v1
2.6. Postbud-samling
For at gøre udviklingen nemmere har vi sammensat en med præbyggede
Postbud-samling anmodninger for alle Cross River. Brug denne samling til at udforske, teste og bygge API-slutpunkter din integration direkte i Postman. med minimal ekstra kodning og opsætning. For at dele vores samling med det samme, klik
Bare udfyld opsætningsdetaljerne, og begynd at foretage opkald i Sandbox Postman-samlingen igennem.
Postbud
Adgangs(bærer)token
Vi har oprettet vores Postman-udvikler-sandkassemiljø for at give et sikkert sted at teste Cross River API'erne. I Cross River Postman-samlingen udfører du godkendelse ved hjælp af et bearer-token.
For at få ID'erne skal du konfigurere den adgangstoken (bearer), der kræves for at køre samlingen:
1. Med disse legitimationsoplysninger anmoder du om og modtager et adgangstoken
Få API-legitimationsoplysninger
til brug for at sende API'er i vores sandkassemiljø
2. Når du har modtaget dine API-legitimationsoplysninger, og før du kan bruge vores
Få adgangstoken
API'er, du får en adgangstoken ved hjælp af klient_id og klient_hemmelighed du modtog, da du registrerede dig.
Fork Cross River-samlingen
Gå direkte til vores for at dele vores kollektion.
Postbuddets arbejdsplads
Når forked er udført, skal du ikke glemme at indstille dine miljøvariabler for sandbox.
Konfigurer dit Postman-miljø
For at bruge den samling, du lige har oprettet, skal du navigere til den og klikke på Miljøer, og vælg SandkasseKopier dit Cross River-klient-ID og klienthemmelighed, og indsæt dem i klient_id og klient_hemmelighed felter. For kortbetalinger skal du indsætte dem i ptpe_klient_id og ptpe_klient_hemmelighed felter.
Nu er du klar til at få et token og begynde at sende anmodninger.
1. Løbe Autorisation/Hent token for at generere din token. For kortbetalinger skal du køre Kortbetalinger/Autorisation/Hent P2PE-token .
2. Variablen {{token}} (eller ptpe_token (for kortbetalinger) tilføjes automatisk til dit miljø via et post-response-script. Når tokenet udløber, skal du følge trin 1 igen.
3. Der er flere variabler, som du muligvis skal udfylde, afhængigt af hvilket endepunkt du træner. For eksempelample, partner_id , produkt-id , konfigurations-id og tilbagekald_url .
4. Der er også nogle variabler, der udfyldes via scripts, f.eks. token og ptpe_token som ikke skal udfyldes manuelt.
Pingthesandbox
Kør en simpel test for at bekræfte, at du kan oprette forbindelse til Cross River-sandkassen.
For at sende en Ping-anmodning skal du åbne i Postman Samlinger > Cross River API-samling > Autorisation og køre Ping endepunkt.
Ændringsanmodninger
For at opdatere en anmodning skal du foretage dine ændringer på Legeme Tab. Værdier i dobbelt curly-parenteser henter fra dine miljøvariabler. Se vores API-dokumentation for at se, hvilke felter hver
endpoint accepterer, og view anmodninger på dit foretrukne sprog.
3. Byg somampden app
Trin 1
Få API-legitimationsoplysninger Opsætning
Trin 2
Få adgangstoken
Trin 3
Brug adgangstoken
Trin 4
Byg en Sample App
Før du starter, skal du se vores hurtigstartguide for at få forbindelse til vores API'er. For at teste API-kaldene kan du bruge cURL fra kommandolinjen eller en tjeneste som Postman eller Swagger i vores sandkasse.
Kunder og konti
Før du bruger Cross River-tjenester, skal du oprette en kunderegister for hver af dine kunder
Kort
Administrer dine kunders kort ved at samarbejde med Cross River for at beslutte, hvad du vil tilbyde, f.eks. fysiske eller virtuelle kort.
Udlån
Lending inkluderer et sæt af API-kald til udlån, der giver dig mulighed for at oprette, opdatere og administrere dine lån.
3.1. Opsætning
Før du starter, skal du læse vores guide for at få forbindelse til vores API'er. Sådan tester du API-hurtigstarten
opkald, kan du bruge cURL fra kommandolinjen eller en tjeneste som Postman eller Swagger i vores sandkasse.
For at oprette en kort- eller betalingsapp skal du oprette kunde- og kontooplysninger.
Udforsk sandkassen
Vi har masser at udforske. Sandkassen er fuldstændig isolerede sandkassemiljøer. fra produktionsmiljøet, så du er velkommen til at eksperimentere. Når du er klar til at gå over til produktion, skal du tale med din kunderådgiver, som vil give dig produktionsoplysninger, så du kan få adgang til livemiljøet.
Registrer relevant web krogbegivenheder
WebHooks er en vigtig komponent i enhver integration med Cross River. Mens API'er giver dig mulighed for at anmode om data on-demand, webHooks sender realtidsopdateringer direkte til dit system – hvilket eliminerer behovet for konstant polling og reducerer latenstid. I mange tilfælde webHooks er mere effektive og pålidelige end API'er alene, hvilket sikrer, at din applikation forbliver synkroniseret med kritiske hændelser som kontoændringer, transaktionsopdateringer og behandlingsresultater.
Register at modtage webhook-begivenheder. Når webhook-hændelser udløses, hændelsen objekter sendes til den registrerede URLs.
3.2. Kunder og konti
Trin 1
Få API-legitimationsoplysninger
Trin 2
Få adgangstoken
Trin 3
Brug adgangstoken
Trin 4
Byg en Sample App
Opret en kundeprofil og en konto med indskud:
Opret en kundepost
Opret en indlånskonto
Indsæt penge på en konto
Opret en kundepost
Før du bruger Cross River-tjenester, skal du for hver af følgende oprette en kundepost:
dine kunder. Kundeopstartsprocessen omfatter oprettelse af en kunderegister med relevante kundeoplysninger.
Alle kunder scannes automatisk med henblik på overholdelse af lovgivningen, så du skal registrere dig for relevante webHooks-hændelser for at modtage statusopdateringer for kundernes poster.
Kunderegistreringen kan være for enten Personlig or Forretning kunder. Når en kunde er registreret, kan vedkommende knyttes til en eller flere konti.
Webkroge
Register for webkroge. Følgende webkroge bruges:
WebBeskrivelse af krog
|
Kernekunde.Onboarding |
Giver dig besked om, at kundeposten er blevet oprettet |
|
Kernekundeafdeling.Ændret |
Giver dig besked om, at en kundes OFAC-status er blevet opdateret |
Core.Customer.PepScan.Change ged
Ngiver dig besked om, at en kundes PEP-status er blevet opdateret
ExampLeof Recordcreation
I dette exampSå får vi John Smith onboardet. Lad os først oprette en kunderegistrering. Vi registrerer John som en Personlig kunde.
For at onboarde en erhvervskunde skal du først oprette en personlig kundeprofil for primær ejer af den pågældende virksomhed. Derefter skal du oprette en erhvervskunde og tilføje den personlige registrering som en reel ejer.
1 Ring POST /core/v1/cm/kunder .
I det følgende examphvilke attributter du kan se er påkrævet.
VIGTIG
Vi anbefaler kraftigt, at du inkluderer en idempotensnøgle i din anmodningsheader
at yde dobbeltbeskyttelse i tilfælde af fejl.
Curl
curl -X POST /core/v1/cm/kunder –header 'Indholdstype: application/j {
"partner-ID": “6e80b097-693c-4592-8440-02f345335bbf”,
"navn": {
"Fornavn": "Johannes",
"Efternavn": "Smith"
},
"klassifikation": "Personlig",
"profile": {
"regO": falsk,
"Politisk eksponeret person": falsk,
"skatte-ID-type": "Ssn",
"skatte-ID": "119988776",
"fødselsdato": "1953-09-22",
"Risikovurdering": "Lav"
"Primæradresse": {
"adressetype": "Hjem",
"klassifikation": "Bolig",
"erPrimær": ægte,
"gade1": "123 Any St",
"by": "Hvor som helst",
"tilstand": "NY",
"postnummer": "12345",
"Landekode": "OS"
},
"Primærtelefon": {
"erPrimær": ægte,
"Telefontype": "Hjem",
"Telefonnummer": "2015551234"
},
"Primær e-mail": {
"erPrimær": ægte,
"e-mailtype": "Personlig",
"E-mailadresse": "John.Smith@xxxxx.com"
}
}
Et vellykket API-kald returnerer et JSON-svar med det unikke kunde-ID i den første linje af svarteksten. Din kunde er blevet oprettet.
Onboarding af en kunderesponsgruppe
{
"id": “9052b6a5-3f09-41d1-b526-ade80104eb79”,
"cifnummer": "32653745014",
"klassifikation": "Personlig",
"status": "Aktiv",
"ofac": "Indtil",
"pepScan": "Indtil",
"navn": {
"Fornavn": "Johannes",
"Efternavn": "Smith",
"fuldt navn": "John Smith"
},
"profile": {
"regO": falsk,
"Politisk eksponeret person": falsk,
"Aktiver sikkerhedskopieringstilbageholdelse": falsk,
"skatte-ID-type": "Ssn",
"skatte-ID": "119988776",
"fødselsdato": "1953-09-22",
"Risikovurdering": "Lav"
},
"oprettet ved": “2021-01-25T17:55:24.4422582-05:00”,
"sidst ændret ved": “2021-01-25T17:55:24.4432543-05:00”,
"partner-ID": “6e80b097-693c-4592-8440-02f345335bbf”
}
2 De Kernekunde.Onboarding webHook-hændelsen udløses, når kundeposten oprettes.
Kunde onboarding-begivenhed
{
"id": “3d9c5e1a-623b-4cf2-812e-ade80105048e”,
"begivenhedsnavn": "Kernekunde.Onboardet",
"status": "Indtil",
"partner-ID": “30dee145-b6a2-4058-8dc3-ac4000dee91f”,
"oprettet ved": “2021-11-22T10:50:20.553-05:00”,
"ressourcer": [
“core/v1/cm/customers/9052b6a5-3f09-41d1-b526-ade80104eb79” ],
"detaljer": []
}
Cross River scanner den nye kundejournal for OFAC- og PEP-overholdelse.
Nogle gange kræver resultaterne af scanningen en nyview af vores team til bekæmpelse af hvidvaskning af penge (AML).
Når scanningen er færdig, Kernekundeafdeling.Ændret og
Core.Customer.PepScan.Ændret webHook-hændelser returneres med en status. Kunder uden compliance-problemer viser en Klar status.
Kundens OFAC-scanning er ændret
{
"id": “45db5592-56ee-41f5-85e7-ade8010571ce”,
"begivenhedsnavn": "Kernekundeafdeling. Ændret",
"status": "Indtil",
"partner-ID": “30dee145-b6a2-4058-8dc3-ac4000dee91f”,
"oprettet ved": “2021-11-22T10:51:53.657-05:00”,
"ressourcer": [
“core/v1/cm/customers/9052b6a5-3f09-41d1-b526-ade80104eb79” ],
"detaljer": []
}
Kundens PEP-scanning er ændret
{
"id": “a5000831-3e01-4231-9ec2-ade8010571c5”,
"begivenhedsnavn": "Kernekunde.PepScan.Ændret",
"status": "Indtil",
"partner-ID": “30dee145-b6a2-4058-8dc3-ac4000dee91f”,
"oprettet ved": “2021-11-22T10:51:53.597-05:00”,
"ressourcer": [
“core/v1/cm/customers/9052b6a5-3f09-41d1-b526-ade80104eb79” ],
"detaljer": []
}
Du har nu oprettet en kunderegistrering.
Opdater kunderegister
Det er muligt at opdatere kundeoplysninger såsom adresse, telefonnummer og e-mail. Disse oplysninger betragtes som primær oplysninger. Hvis du tilføjer en anden adresse, er dette sekundær.
1 Brug det kunde-ID, der returneres, når du opretter kundeposten, til at ringe op POST /core/v1/cm/customers/{id}/addresses for at tilføje den. Den første kundeadresse
adressen du tilføjer er primær adresse. I det følgende eksempelampså kan du se hvilke attributter der kræves.
Opdater kundeadresse
POST /core/v1/cm/customers/9052b6a5-3f09-41d1-b526-ade80104eb79/addresse {
"adressetype": "Hjem",
"klassifikation": "Bolig",
"erPrimær": ægte,
"gade1": "123 Any St",
"by": "Hvor som helst",
"tilstand": "NY",
"postnummer": "12345",
"Landekode": "OS"
}
2 Ring POST /core/v1/cm/customers/{id}/phones at tilføje
kundens telefon
Det første telefonnummer, du tilføjer, er primær telefonnummer.
antal
Opdater kundens telefonnummer
POST /core/v1/cm/customers/9052b6a5-3f09-41d1-b526-ade80104eb79/phones {
"erPrimær": ægte,
"Telefontype": "Mobil",
"Telefonnummer": "2015552345"
}
3 Ring POST /core/v1/cm/kunder/{id}/email for at opdatere kundens e-mail.
Opdater kundens e-mail
POST /core/v1/cm/customers/9052b6a5-3f09-41d1-b526-ade80104eb79/email {
"erPrimær": ægte,
"e-mailtype": "Personlig",
"E-mailadresse": "john.jones@xxx.com"
}
Opret en indlånskonto
CR tilbyder en række forskellige typer konti, herunder check- og opsparingskonti, indlånsbeviser (CD'er eller tidsindskudskonti) og mere.
For at åbne en indlånskonto skal du have et gyldigt produkt-ID for den type konto, du ønsker at åbne, og et kunde-ID (onboarded customer record ID) for kontohaveren. Bemærk, at kontohaveren skal have mindst én adresse og et telefonnummer i sin kunderegister, og deres OFAC-status skal være KlarDerudover skal kundens klassificering stemme overens med den konfigurerede klassificering for produktet. F.eks.ampDet er kun erhvervskunder, der kan tilføjes til et erhvervsprodukt.
Før du begynder
Sørg for, at du har:
API-legitimationsoplysninger
Partner-ID (som du modtog, da du registrerede dig)
Kunde-id
Produkt-ID (definerer den type konto, der åbnes)
VIGTIG
Vi anbefaler kraftigt, at du inkluderer en idempotensnøgle i anmodningsheaderen for at forhindre dobbeltbetalinger i tilfælde af fejl.
Slutpunkter og webkroge
Følgende API-slutpunkt bruges:
API-beskrivelse
Åbn en indlånskonto Åbner en indlånskonto for en kunde
Følgende webkrogen bruges:
WebBeskrivelse af krog
Kernekonto.Åbnet En ny konto blev åbnet
Åbn en konto
I følgende scenarie åbner du en konto for John Smith, en kunde, som du har onboardet.
For at åbne en konto
1 Ring POST core/v1/dda/konti For dette opkald kræves visse attributter. Se den fulde .
liste over attributter
Sampen anmodning
POST /core/v1/dda/accounts
{
"kunde-ID": “59e3bc15-bbec-4990-88e9-a9a600d3296c”,
"produkt-ID": “44015e68-1afb-40fc-9497-abc1014f52da”,
"titel": "John Smith",
"udsagnsadresse": {
"gade1": "257 Dalton Groves",
"by": "Barton City",
"tilstand": "MI",
"postnummer": "48705",
"Landekode": "OS"
}
}
2 Et vellykket API-kald returnerer et JSON-svar med detaljerne for den nye konto.
Sampsvaret
STOLPE /kerne/v1/dda/regnskaber
{
"kunde-ID": “59e3bc15-bbec-4990-88e9-a9a600d3296c”,
"produkt-ID": “44015e68-1afb-40fc-9497-abc1014f52da”,
"titel": "John Smith",
"udsagnsadresse": {
"gade1": "257 Dalton Groves",
"by": "Barton City",
"tilstand": "MI",
"postnummer": "48705",
"Landekode": "OS"
}
}
3 De kontonummer Feltet angiver kontonummeret for den nye konto.
4 I svaret f.eks.ampkontoen er klassificeret som Personlig fordi brugeren konfigurerede produktklassificeringen som PersonligKontoklassificeringen matcher altid den konfigurerede produktklassificering.
5 Kontostatus opdateres automatisk til Aktiv , og er øjeblikkeligt tilgængelig til brug. Dette udløser Kernekonto.Åbnet tilfælde.
Core.Account.Opened-hændelsesdetaljer
{
"id": “259cdbca-6a89-4af8-a50e-ada3010fb13f”,
"begivenhedsnavn": "Kernekonto.Åbnet",
"status": "Indtil",
"partner-ID": “e6c3824a-377f-44d5-a2f6-a9a600c9b37e”,
"oprettet ved": “2021-01-26T09:48:10.1011462-05:00”,
"ressourcer": [
"core/v1/dda/accounts/2235223803"
],
"detaljer": []
}
Fundkonto
Når du arbejder i sandkassen for at teste betalingssystemer og kontoadfærd, skal du have penge på en konto.
Du kan bruge enhver skinne, der har et indgående simuleringsslutpunkt, til at finansiere en sandkassekonto, hvis kontoen er konfigureret til det. Du kan især:
Simuler indgående ACH-betalinger
Simuler en indgående ledning
Til enhver simulering skal du bruge nummeret på den Cross River sandbox-konto, du vil finansiere. Oplysningerne om den oprindelige konto er ikke vigtige, og i nogle tilfælde kan de endda være helt fiktive.
Næste skridt
Tjek vores betaling.
tutorials
3.3. Kort
Trin 1
Få API-legitimationsoplysninger
Trin 2
Få adgangstoken
Trin 3
Brug adgangstoken
Trin 4
Byg en Sample App
Lær, hvordan du arbejder med Cross River API'er. Denne side viser dig, hvordan du:
Opret et kort
Aktivér et kort
Opret et kort
Administrer dine kunders kort ved at samarbejde med Cross River om at beslutte, hvad du vil tilbyde, f.eks. fysiske eller virtuelle kort. Dette er kortkonfigurationCross River skaber en professionel kortkonfigurationfile for dig for hver type du vælger til dit finansielle instrument kunder.
Før du begynder
Sørg for at du gør og har:
Opret en kundepost
Opret en indlånskonto
Kortholders kontonummer
Kunde-ID (du får dette, når du opretter en kunde)
Konfigurations-ID (Cross River giver dig ID, når du konfigurerer din type/dit kort)
Vi anbefaler også, at du for de relevante webHook-begivenheder. Tilmeld dig
Endepunkter ogwebkroge
Register for webhooks. Følgende API-slutpunkter bruges:
API-beskrivelse
Opret nyt kort Anmoder om oprettelse af et nyt betalingskort
Følgende webkroge bruges:
WebBeskrivelse af krog
Kort.Kort.Oprettet. Debetkort oprettet
Ordrekort
Du lærer, hvordan du bestiller/opretter et nyt debetkort ved at oprette et kort til John Smith.
1 Ring POST /korthåndtering/v1/kort .
I det følgende exampså kan du se hvilke attributter der kræves. Se detaljer om den komplette API.
Tilføj kort
Sampopret et kort
curl -X POST /korthåndtering/v1/kort –header 'Indholdstype: applikation “kontonummer”: “2608927303”, \
“customerId”: “2b15a695-13dc-4b10-b4e5-af5b0138873c”, \
"konfigurations-ID": "a6b5a94c-f8f9-462b-8ce8-afa400f5b640", \ "fornavn": "John", \
"Efternavn": "Smith", \
"telefon": { \
"Telefontype": "Hjem", \
"Telefonnummer": "9133413131" \
}, \
"E-mailadresse": "John.Smith@xxxxx.com", \
"Leveringsadresse": { \
“gade1”: “Lane Ave”, \
“street2”: “streng”, \
"by": "Storby", \
"Stat": "IL", \
"Postnummer": "72410",
"Landekode": "US" \
}, \
"faktureringsadresse": { \
“gade1”: “Lane Ave”, \
“street2”: “streng”, \
"by": "Storby", \
"Stat": "IL", \
"Postnummer": "72410",
"Landekode": "US" \
}, \
"navnPåKort": "John Smith",
"forsendelsestype": "Normal", \
"klientIdentifikator": "streng" \
}' 'https://sandbox.crbcos.com/CardManagement/v1/cards'
2 Et vellykket API-kald returnerer et JSON-svar med detaljerne om det nye kort. Kortets status vil være inaktiveret, indtil du aktiverer kortet. Id'et er kort-ID'et i dette tilfælde. example 8709163d-140c-4d95-a111-afa8009e9cd1, som du bliver nødt til at aktivere kortet.
Sample ordre et kort svar
{
"id": “8709163d-140c-4d95-a111-afa8009e9cd1”, "partner-ID": “cd9c12f4-7691-424a-b38b-af5b0134c611”, "produkt-ID": “83bed086-8182-4151-a1e3-af5b01362783”, "kontonummer": "2608927303",
"status": "Ikke-aktiveret",
"statusÅrsagskode": "Ikke indstillet",
"Fornavn": "Johannes",
"Efternavn": "Smith",
"Leveringsadresse": {
"gade1": "Lane Ave",
"gade2": "snor",
"by": "Storby",
"tilstand": "IL",
"postnummer": "72410",
"Landekode": "OS"
},
"faktureringsadresse": {
"gade1": "Lane Ave",
"gade2": "snor",
"by": "Storby",
"tilstand": "IL",
"postnummer": "72410",
"Landekode": "OS"
},
"telefon": {
"Telefontype": "Hjem",
"Telefonnummer": "9133413131"
},
"E-mailadresse": "john@anygoogle.com",
"navnPåKort": "John Smith",
"isPinSet": falsk,
"adminBlokeret": falsk,
"Mistænkt bedrageri": falsk,
"konfigurations-ID": “a6b5a94c-f8f9-462b-8ce8-afa400f5b640”, "kategori": "Kredit",
"betalingsinstrument": "Virtuel panorering",
"processor": "processornavn",
"forsendelsestype": "Normal",
"Ordrestatus": "Ordre afventer",
"erstatningsstatus": "Ikke relevant",
"kunde-ID": “2b15a695-13dc-4b10-b4e5-af5b0138873c”, "klientidentifikator": "snor",
"oprettet ved": “2023-02-13T04:37:29.4869172-05:00”,
"sidst ændret ved": “2023-02-13T04:37:29.4869172-05:00”
}
3 De Kort.Kort.oprettet. webHook-hændelsen udløses, når kortet genereres af processoren.
Sample Cards.Card.Created-begivenheden
{
"id": “cea6c5b5-13e7-4c2f-ba75-afce01110fe5”,
"begivenhedsnavn": "Kort.Kort.Oprettet",
"status": "Indtil",
"partner-ID": “cd9c12f4-7691-424a-b38b-af5b0134c611”,
"oprettet ved": “2023-02-13T04:42:29.4869172-05:00”,
"ressourcer": [
“cardmanagement/v1/cards/8709163d-140c-4d95-a111-afa8009e9cd1” ],
"detaljer": [
{
"kort-ID": “8709163d-140c-4d95-a111-afa8009e9cd1”,
"status": "Ikke-aktiveret",
"statusÅrsagskode": "Ikke indstillet"
}
]
}
Aktivér kortet
Før du begynder
Sørg for, at du har:
API-legitimationsoplysninger
Kort-ID fra da du bestilte kortet
Endepunkter ogwebkroge
API-beskrivelse
POST /cardmanagement/v1/cards/{id}/activate Aktiverer kortet ved hjælp af kort-ID'et Vejledningen bruger disse webkroge:
WebBeskrivelse af krog
Kort.Kort.Aktiveret Debetkort aktiveret
Aktivér kortet
Aktivér det kort, du oprettede i stage.
opret et kort
1 Ring POST /korthåndtering/v1/kort/{id}/aktiver . De id Attributten skal indstilles til kort-ID'et. I sample under ID'et er 8709163d-140c-4d95-a111 afa8009e9cd1.
Sampanmodning om aktivering af kort
curl -X STOLPE
–header 'Accepter: application/json'
–header 'Autorisation: Indehaver'<token>'
https://sandbox.crbcos.com/CardManagement/v1/cards/8709163d-140c-4d95-a1
2 Et vellykket API-kald returnerer et JSON-svar med detaljerne om kortet. Kortet status er nu aktiveret. De Ordrestatus is Afsluttet.
Sample aktivering af kortrespons
{
"id": “8709163d-140c-4d95-a111-afa8009e9cd1”, "partner-ID": “cd9c12f4-7691-424a-b38b-af5b0134c611”, "produkt-ID": “83bed086-8182-4151-a1e3-af5b01362783”, "processorkort-id": "804951250206718",
"kontonummer": "2608927303",
"status": "Aktiv",
"statusÅrsagskode": "Ikke indstillet",
"Fornavn": "Johannes",
"Efternavn": "Smith",
"Leveringsadresse": {
"gade1": "Lane Ave",
"gade2": "snor",
"by": "Storby",
"tilstand": "IL",
"postnummer": "72410",
"Landekode": "OS"
},
"faktureringsadresse": {
"gade1": "Lane Ave",
"gade2": "snor",
"by": "Storby",
"tilstand": "IL",
"postnummer": "72410",
"Landekode": "OS"
},
"telefon": {
"Telefontype": "Hjem",
"Telefonnummer": "9133413131"
},
"E-mailadresse": "john@anygoogle.com",
"navnPåKort": "John Smith",
"panLast Four": "3629",
"isPinSet": falsk,
"Udløbsdato": "2026-02-13",
"adminBlokeret": falsk,
"Mistænkt bedrageri": falsk,
"konfigurations-ID": “a6b5a94c-f8f9-462b-8ce8-afa400f5b640”, "kategori": "Kredit",
"betalingsinstrument": "Virtuel panorering",
"processor": "processornavn",
"forsendelsestype": "Normal",
"Ordrestatus": "Afsluttet",
"erstatningsstatus": "Ikke relevant",
"kunde-ID": “2b15a695-13dc-4b10-b4e5-af5b0138873c”,
"klientidentifikator": "snor",
"processorKunde-ID": “T83E9D675A3N3N9O8RZ1”,
"oprettet ved": “2023-02-13T04:37:29.487-05:00”,
"Initialaktivering": “2023-02-13T00:00:00-05:00”,
"aktiveret ved": “2023-02-13T04:43:19.282287-05:00”,
"sidst ændret ved": “2023-02-13T04:43:19.2962845-05:00”
}
3 Når kortets status ændres til Aktiv , den Kort.Kort.Aktiveret webkroghændelsesbrande.
Kort.Kort.Aktiveret webkrogbegivenhed
{
"id": “95ac33ca-3d7f-49aa-bfc2-afce01113310”,
"begivenhedsnavn": "Kort.Kort.Aktiveret",
"status": "Indtil",
"partner-ID": “cd9c12f4-7691-424a-b38b-af5b0134c611”,
"oprettet ved": “2023-02-13T04:44:31.282287-05:00”,
"ressourcer": [
“cardmanagement/v1/cards/8709163d-140c-4d95-a111-afa8009e9cd1” ],
"detaljer": [
{
"kort-ID": “8709163d-140c-4d95-a111-afa8009e9cd1”,
"status": "Aktiv",
"statusÅrsagskode": "Ikke indstillet"
3.4. Udlån
Trin 1
Få API-legitimationsoplysninger
Trin 2
Få adgangstoken
Trin 3
Brug adgangstoken
Trin 4
Byg en Sample App
Udlån inkluderer et sæt kald, der giver dig mulighed for at oprette, opdatere og administrere udlåns-API'en dine lån.
For at begynde at arbejde med udlån, skal du sørge for at:
Modtag API-legitimationsoplysninger med de nødvendige omfang til udlån
Hvis du har oprettet API-legitimationsoplysningerne ved hjælp af selvbetjeningsadministrationen
så skal du også sende en anmodning til
arix.support@crossriver.com
Org, sammen med dit klient-id og MPLID, for at fuldføre skabelsen.
Brug det korrekte omfang for de API'er, du vil bruge.
API-området for sandkassen er: CosLending:PreApproval:stg
Sandkasse
Modulbase URL for API-kald Beskrivelse
Lån oprindelse
Afgørelse af ansøgning
|
https://arixapisandbox.crbnj. net |
Basen URL til API-kald til låneoprettelse til Arix-sandkassemiljøet |
|
https://lendingsandbox.crbco s.com/preapproval/v1 |
Basen URL til sandkassen ansøgningsafgørelse |
Swagger
Modul Swagger Link
|
API reference dokumentation |
https://arixapisandbox.crbnj.net/swagger-ui |
|
Kroge |
https://lendingsandbox.crbcos.com/hooks/swagger/inde x.html |
Salg https://lendingsandbox.crbcos.com/selling/swagger/inde x.html
Statusside
For at se en liste over kommende udgivelser, overvåg den aktuelle API-status, view Hændelsesrapporter, eller få besked om planlagt vedligeholdelse, kan du besøge vores statusside og abonnere på beskeder.
4. Program opsætning
Opsæt SFTP: Brug SFTP til at sende fileeller at downloade dem fra Cross River, alt efter dine og vores behov.
Kundeopstart: Administrer dine kundeoplysninger i Cross River operativsystem (COS) ved hjælp af enten API'er eller COS Explorer
COS-produkttyper og -id'er: Forklaring af COS-produkttyper og -id'er.
COS Explorer: Sådan arbejder du med vores COS Explorer.
Organisationsstyringsportal: Sådan arbejder du med vores organisationsstyringsportal.
4.1. Opsæt SFTP
Når du har brug for at udveksle følsomme oplysninger i en file format med Cross River, kræver vi, at du bruger Secure File Transfer Protocol (SFTP). Brug SFTP til enten at sende fileeller at downloade dem fra Cross River, alt efter dine og vores behov. I nogle tilfælde vil du eller vi kryptere disse files, især hvis de indeholder personligt identificerende oplysninger (PII).
Brug af SFTP
SFTP giver dig mulighed for sikkert at sende og modtage følsomme oplysninger fileog rapporter ved hjælp af en mappe, der er specifikt tildelt din virksomhed på en sikker server. Upload og download filegennem den mappe eller undermapper i den mappe, alt efter dine specifikke behov.
Brug af kryptering
Kryptering files tilføjer et ekstra lag af beskyttelse. Kun autoriseret personale med den korrekte nøgle vil være i stand til at dekryptere den krypterede fileI Cross River bruger vi PGP-kryptering.
Kom godt i gang
Der er flere trin for at komme i gang med vores SFTP-server.
1 Du udfylder formularen "Anmodning om IP-adgang til Cross River SFTP-tjenester" (fra din RM).
Hvis du har brug for at dele fileMed Cross River vil din relationsadministrator sende dig en formular til anmodning om IP-adgang til CRB SFTP-tjenester. Blandt andet skal du angive de statiske offentlige IP-adresser, du vil bruge til at få adgang til SFTP-mappen, og en offentlig PGP-nøgle til kryptering og dekryptering. files. Send den udfyldte formular tilbage til din kunderådgiver
VIGTIG
Cross River tillader kun 5 IP-adresser for dig, så tag det i betragtning. IP-adresserne skal være statiske. Derfor skal du proxy alt, der ikke er statisk fra din side.
2 Vi opsætter din SFTP-mappestruktur.
Når Cross River har dine oplysninger, opretter vores IT-ingeniørafdeling et standardsæt af mapper og undermapper til dig. Denne unikke sti er kun til din virksomhed. Ingen andre partnere kan få adgang til den. IT-ingeniørafdelingen sender dig en e-mail med de oplysninger, du skal bruge for at få adgang til mapperne. E-mailen indeholder et link til dine loginoplysninger. Cross River gemmer ikke din adgangskode!
VIGTIG
Linket er kun gyldigt i et par dage, hvorefter du skal anmode om en nulstilling af adgangskoden, hvis du ikke bruger det.
Loginoplysningerne bliver også ugyldige, hvis mere end to personer tilgår linket.
3 Test SFTP-upload.
Hvis du vil levere filetil Cross River, bør din IT-afdeling oprette en servicekonto med en automatiseret proces til upload af disse. files til dine SFTP-mapper. Vi anbefaler kraftigt, at du tester dette, før du forsøger at sende rigtige data. Kontakt din kundeservicemedarbejder, hvis du har spørgsmål eller problemer, eller opret en sag hos din førstelinjesupport.
4 Konfigurer PGP til at sende eller modtage files fra Cross River. (Dette trin er kun nødvendigt, hvis du sender eller modtager personligt identificerbare oplysninger. Kontakt din RM.)
Hvis du har brug for at sende Cross River files, sender vi dig først vores offentlige PGP-nøgle til brug for kryptering af disse files.
Du burde allerede have sendt din offentlige PGP-nøgle til Cross River for at modtage den. files fra os.
5 Del dine data.
Når din SFTP-mappe er konfigureret, og din proces er på plads, kan du begynde at dele files med os. Din kunderådgiver fortæller dig, om der er noget mere specifikt, du skal gøre for at modtage rapporter, eller hvordan du forbereder data, der skal sendes til os.
Specifikke Rapporter
Lær mere om udarbejdelse og afsendelse af rapporter og files for:
Konti og betalinger
Kortbetalinger
Kreditrisiko
Udlån
XML-batchbetalinger (ISO 20022)
4.2. Kundeopstart
Administrer dine kundeoplysninger i Cross River-operativsystemet (COS) ved hjælp af enten API'er eller . Disse oplysninger inkluderer grundlæggende detaljer, der er nødvendige for at åbne en bank-COS Explorer.
konto eller bruge et kreditkort, samt mere specifikke data om kunden, efter behov. Vi kalder dette en kunderegister.
Før du kan åbne en indlånskonto eller oprette et kort, skal du oprette kunderegistreringen, undertiden kaldet onboardingDu kan derefter tildele en eller flere kunder til en konto via kunde relationer.
Kundeopstartsprocessen omfatter oprettelse af en med relevant kunderegistrering kundeoplysninger. Følg denne vejledning for at oprette en kundepost for hver af jer..
Valgfrie trin
Tilføj ID-oplysninger
Tilføj en reel ejer
Fejlkoder
Se, sammen med masser af andre referenceoplysninger, om COS COS-systemets fejlkoder.
side med referencekoder.
4.2.1. Kunderegister
Kunderegister
Kundeposten er den primære ressource, der indeholder kundeoplysninger i Cross River-systemet. Derfor skal du onboarde en kunde, før du opretter en konto for den pågældende kunde. Kundeposten understøtter klassifikationer af typen Personlig eller Erhverv. Når du er onboardet, kan du knytte en kunde til en eller flere konti.
EksampNedenfor vises, hvordan man onboarderer en kunde for en privatkunde.
Anmodning om person ombord
POST /core/v1/cm/kunder {
"partner-ID": “7cc038be-fde9-4455-b27b-1497cf667362”,
"navn": {
"præfiks": "Hr.",
"Fornavn": "Johannes",
"Mellemnavn": "Robert",
"Efternavn": "Smith",
"suffiks": "Jr.",
"foretrukket navn": "Jim" },
"klassifikation": "Personlig",
"profile": {
"regO": falsk,
"Landskode for statsborgerskab": "OS",
"Politisk eksponeret person": falsk,
"Aktiver sikkerhedskopieringstilbageholdelse": falsk,
"backupTilbageholdelsesprocent": 0,
"skatte-ID-type": "Ssn",
"skatte-ID": "123456789",
"fødselsdato": "1965-09-15",
"Risikovurdering": "Lav",
"Privatlivsfravalg": ægte }
} Registrer en erhvervskunde, f.eks. en virksomhed eller et LLC, der bruger det samme slutpunkt med lidt forskellige attributter.
Curl
POST /core/v1/cm/kunder {
"partner-ID": “a24cba49-2bb6-431d-a867-1de81d6e4127”,
"navn": {
"enhedsnavn": "ACME CO", },
"klassifikation": "Forretning",
"profile": {
"Landskode for statsborgerskab": "OS",
"Aktiver sikkerhedskopieringstilbageholdelse": falsk,
"backupTilbageholdelsesprocent": 0,
"skatte-ID-type": "En",
"skatte-ID": "123456789",
"Datoformet": "2019-09-10",
"Enhedstype": "Selskab",
"Risikovurdering": "Lav",
"ejerskabstype": "Juridisk enhed",
"primærEjerKunde-ID": “f9321f7f-3712-46e1-b965-2b79ead64dc9”, } }
Uanset om du onboarder en privat- eller erhvervskunde, Primær ejer Kunde-ID Attributten skal indeholde et kunde-ID, der refererer til en kundepost af typen Personlig. Så for at registrere en virksomhed skal du først oprette en personlig kundepost for den primære ejer af den pågældende virksomhed.
VIGTIG
Nogle kundeslutpunkter inkluderer en dueDiligence ressource, der muligvis eller muligvis ikke er påkrævet ved onboarding af privatkunder. Din tildelte compliance-kontaktperson kommunikerer krav til eventuelle due diligence-felter under din onboarding-proces.
Reelle ejere
En reel ejer er en person, der ejer 25 % eller mere af en virksomhed. Af lovgivningsmæssige årsager skal du ressource i en Forretning kundeoprettelse af en reel ejer
for hver reel ejer af den pågældende virksomhed. ejerKunde-ID Attributten refererer til den personlige kundepost for hver reel ejer. Du tilføjer normalt ressourcer for reelle ejere til virksomhedens kundepost umiddelbart efter onboarding af en virksomhed.
Curl
POST /core/v1/cm/customers/{customerId}/beneficial-owners {
"ejerKunde-ID": “c1210a2d-932e-43ca-be29-f358a4382385”,
"ejertitel": "Formand" }
Adresse
De fysiske adresser, der er knyttet til kunden, kan være .
opdateret
Curl
POST /core/v1/cm/customers/{customerId}/addresses
{
"erPrimær": ægte,
"status": "Aktiv",
"klassifikation": "Bolig",
"adressetype": "Hjem",
"gade1": "Maple Street 123",
"gade2": "Lejlighed 12",
"gade3": "",
"by": “New York”,
"tilstand": "NY",
"postnummer": "10025",
"Landekode": "OS",
}
E-mailadresser
Opdater e-mail
kontaktoplysninger til kunden.
Curl
POST /core/v1/cm/kunder/{kunde-ID}/emails {
"erPrimær": ægte,
"e-mailtype": "Personlig",
"E-mailadresse": "john.smith@crossriver.com" }
Telefoner
Opdater telefon Curl
kontaktoplysninger til kunden.
POST /core/v1/cm/customers/{customerId}/phones
{
"Telefontype": "Hjem",
"erPrimær": ægte,
"Telefonnummer": "2015551234"
}
Identifikationer
Identifikationer bruges til at spore metadata for kundeidentificerende dokumenter såsom kørekort og pas. kan bruges til at tilføje nye ID-oplysninger. Tilføj ID-oplysninger
Curl
POST /core/v1/cm/kunder/{kundeId}/identifikationer {
"erPrimær": ægte,
"id-nummer": "DL123456789",
"id-type": "Kørekort",
"Udstedsdato": "2018-08-30",
"Udløbsdato": "2018-08-30",
"verificeret dato": "2018-08-30",
"udstedende myndighed": "NJ DMV",
"udstedende stat eller provins": "NJ",
"udstedende landekode": "OS",
}
4.2.2. COS-produkttyper og -id'er
I Cross River, en produkttype er et unikt konfigureret finansielt produkt, du tilbyder dine kunder. For eksempelampEn produkttype kan f.eks. være et betalingskort eller en opsparingskonto, konfigureret efter dine behov og specifikationer. Du åbner konti for dine kunder under enhver produkttype, som du definerer og konfigurerer sammen med os. Tal med din kundeservicemedarbejder for at få flere oplysninger, herunder hvordan du konfigurerer produkttyper for dine kunder.
F.eksampDu kan f.eks. konfigurere en produkttype til at være et opsparingskontoprodukt, der bruger bankoverførsler og ACH-betalinger. Du kan derefter tilbyde dine kunder opsparingskonti med disse tjenester og konfigurationer.
Cross River giver dig et produkt-ID for hver produkttype, du vil tilbyde dine kunder. For at åbne en indlånskonto skal du have et gyldigt produkt-ID og et kunde-ID (onboarded customer record ID) for kontohaveren. Bemærk, at kontohaveren skal have mindst én adresse og et telefonnummer i sin kunderegister, og deres OFAC-status skal være KlarDerudover skal kundens klassificering stemme overens med den konfigurerede klassificering for produktet. F.eks.ampDet er kun erhvervskunder, der kan tilføjes til et erhvervsprodukt.
4.2.3. COS Explorer
Når du er i Cross River-systemet og har modtaget e-mailen med onboarding
dine kunde-id og Hemmelighed Du er klar til at logge ind på COS Explorer. Få adgang til COSExplorer-portalen
Produktion:
https://api.crbcos.com/explorer2/
Sandkasse:
https://sandbox.crbcos.com/explorer2/
Velkomstmail
Du vil modtage en velkomstmail fra CrossRiver_DO_NOT_REPLY@crossriver.comHvis du ikke kan se den i din indbakke, skal du tjekke dine spam- eller blokerede mailmapper.
Klik Opret din Cross River-konto.
Hvis du forlader guiden på noget tidspunkt, skal du klikke på linket i den oprindelige e-mail for at gå tilbage til, hvor du slap.
Vilkår og betingelser
Læs vilkår og betingelser igennem, tjek Acceptere, og klik Næste.
SMS-bekræftelse
Vi sender dig en SMS (tekstbesked) til din enhed for at bekræfte din identitet. Indtast den 6-cifrede kode, du modtager på loginskærmen, og klik på Bekræft kode.
Opret din adgangskode
1. Indtast en adgangskode, der opfylder kravene på skærmen, og indtast adgangskoden igen.
2. Klik Opret adgangskode.
Opsætning af Authenticator-appen
Du skal gennemføre dette trin for at fortsætte registreringsprocessen og for at kunne logge ind igen.
For at beskytte din identitet, din konto og dine oplysninger kræver vi, at du logger ind med multifaktor-/2-faktor-godkendelse.
Hvis du ikke allerede har en godkendelsesapp på din enhed, skal du downloade en, før du fortsætter.
Til Android og iOS anbefaler vi at bruge appen "Follow Authenticator":
Google Authenticator
Microsoft Authenticator
Når du har installeret din autentificeringsapp, skal du enten scan QR-koden or indtast nøglen manuelt ind i autentificeringsappen.
QR-kode
1. Scan QR-koden i din autentificeringsapp, og indtast om nødvendigt den 6-cifrede kode på siden for multifaktorgodkendelse.
2. Klik på Fortsæt.
Manuel
1. Klik Vis nøgle
2. Kopier nøglen som Hemmelighed i din autentificeringsapp.
3. Indtast den 6-cifrede kode.
4. Klik Fortsætte.
Ugyldig MFA-kode
Hvis du indtaster en ugyldig MFA-kode, får du en rød besked om at prøve igen.
Ups! Du har indtastet en ugyldig MFA-kode. Her er et par ting, du skal dobbelttjekke:
1. Opstod der timeout på koden, før du klikkede FortsætteDen resterende tid er angivet med nedtællingscirklen til højre for kontonavnet og MFA-koden.
2. Hvis du har konfigureret godkendelsesappen til flere miljøer eller applikationer, skal du dobbelttjekke, at du har indtastet den korrekte kode.
1. Hvis det ikke fremgår tydeligt af MFA-forbindelsesnavnene, hvilken der er den korrekte mulighed, skal du muligvis prøve forskellige koder, indtil du finder den, der virker.
2. Når du har fundet den korrekte forbindelse, kan du omdøbe MFA-forbindelsen i appen. Et blyantikon øverst på MFA-appskærmen bringer dig til redigeringstilstand. I nogle apps skal du først vælge (eller trykke og holde nede) den forbindelse, der skal redigeres, og derefter vises ikonet.
3. Når du er i redigeringstilstand, kan du omdøbe forbindelserne efter behov, så det bliver tydeligt, hvilken der gælder for hvilket miljø.
4. Gem eventuelle ændringer, så burde det være nemmere at forstå, hvilken kode der skal bruges næste gang.
Gendannelseskoder
Brug gendannelseskoder til at godkende, hvis du mister din enhed.
1. Download eller kopier dine gendannelseskoder, og opbevar dem et sikkert sted, du kan huske.
2. Bekræft, at du har gemt dine gendannelseskoder
3. Klik Opret konto.
Siden med gendannelseskoder får timeout efter 10 minutter.
Du kan kun downloade gendannelseskoderne én gang.
Din konto er nu aktiv, og du kan bruge den til at logge ind på alle dine CR-apps.
IP-tilladelsesliste
Kun en statisk IP-adresse kan bruges til at få adgang til COS Explorer. Kontakt din IP-support, hvis du har brug for hjælp til dette.
Identitetsserverens IP-adresser er:
172.67.26.222 104.22.40.134 104.22.41.134
Serveren er proxybaseret via Cloudflare.
Du kan tillade disse FQDN'er:
idptest.crbcos.com
Fejlfinding
Glemt adgangskode
1. Klik Glemt adgangskode? og indtast din e-mail.
2. Indtast den 6-cifrede godkendelseskode fra din godkendelsesapp. 3. Du får en Glemt adgangskode e-mail. Klik Nulstil adgangskode.
4. På siden Nulstilling af adgangskode skal du indtaste en ny adgangskode og klikke på Nulstil adgangskode, og Fortsæt til applikationen.
Nulstil multifaktorgodkendelse
Hvis du allerede har konfigureret MFA:
1. I Identitetsserveren skal du gå til Nulstil MFA og klik Nulstil din MFA-enhed. 2. Siden for multifaktorgodkendelse åbnes, og du kan nulstille din MFA.
Du kan også oprette nye gendannelseskoder til multifaktorgodkendelse.
1. Klik Opret nye gendannelseskoder for multifaktorgodkendelse.
2. Siden Gendannelseskoder åbnes, og du kan kopiere eller downloade dine 10 nye gendannelseskoder.
Hvis du endnu ikke har konfigureret din multifaktorgodkendelse, kan du aktivere MFA fra Kontoindstillinger.
1. Klik Nulstil MFA-metode.
2. Klik Konfigurer MFA.
3. Følg instruktionerne i Multifaktorgodkendelse/2-trinsgodkendelse.
Hvis din nuværende MFA er SMS, kan du aktivere MFA med din godkendelsesapp. Kontoindstillinger
1. Klik Nulstil MFA-metode.
2. Klik Konfigurer MFA.
3. Følg instruktionerne i Multifaktorgodkendelse/2-trinsgodkendelse.
Brug en gendannelseskode
Hvis du ikke har adgang til din multifaktor-autentificering (2-faktor), kan du logge ind med en af dine gendannelseskoder.
1. Log ind som sædvanligt
2. På siden Multifaktorgodkendelse har du mulighed for at bruge en gendannelseskode som din godkendelsesmulighed.
3. Indtast en af dine gendannelseskoder i tekstfeltet. Gendannelseskoden er til engangsbrug og kan ikke genbruges. For at undgå fremtidig forvirring anbefaler vi, at du markerer gendannelseskoden som brugt.
Kontolåsning
Hvis du indtaster den forkerte adgangskode til dit brugernavn 5 gange, låser systemet din konto i cirka 5 minutter. Hvis du stadig ikke kan få adgang til din konto efter 5 minutter, skal du kontakte Cross River Support.
Browserfejl - Firewall
Du logger ind på COS Explorer og får følgende fejlskærm:
Du er blokeret af en firewall.
1. Kontakt din interne IT-afdeling for at se, om din organisation håndhæver firewallregler for udgående trafik. Hvis der ikke er firewallregler for udgående trafik, skal du:
2. Kontakt din interne IT-afdeling for at sikre dig, at du opretter forbindelse til Cross River COS Explorer Portal fra en godkendt IP-adresse. Hvis du har brug for at registrere flere IP-adresser, skal du sende en e-mail til COS-support.
4.2.3.1. Brugerstyring
Brugeradministration
Du kan bruge Brugere skærmbillede af Admin Brug fanen til at gruppere et sæt ressourcer, f.eks. kunder, produkter og konti. Når en ressource (dvs. produkt eller kunde) er blevet tildelt dig, kan den ikke ændres.
Du kan bruge dette område til at understøtte og foretage ændringer for dine kunder. Vi kan oprette 2 administratorbrugere, så du kan oprette brugere efter behov for dine kunder. Dette giver dig uafhængighed til at administrere dine kunder og giver dig mulighed for at foretage ændringer uden for åbningstiderne på deres anmodning.
Du kan også oprette eller onboarde nye brugere.
Opret en ny bruger
1 I den Admin fanen, klik Brugere at åbne Brugere søgeskærm. 2 Klik + Ny bruger. De Opret bruger skærmen vises.
3 In Opret bruger indtast brugerens E-mail, vises følgende felter derefter Fornavn, Efternavn og Telefonnummer.
4 Klik Status og vælg Aktiv.
De Telefonnummer Feltet skal være et mobilnummer, da dette vil blive brugt af MFA til at godkende brugeren.
Feltbeskrivelse
|
Navn |
Brugernavn. Indtast det fulde brugernavn, der skal vises i browservinduet, når brugeren logger ind i Stifinder. |
|
|
Brugerens e-mailadresse. Denne adresse bruges til at logge ind i Explorer og fungerer også som en gendannelses-e-mailadresse til nulstilling af adgangskoder. |
|
Status |
Vælg en brugerstatus. Brugerstatus er Inaktiv som standard. Ændr den til Aktiv når man opretter en bruger. |
|
Brugertype |
Dette felt vises Partner når brugeren er oprettet. |
|
Roller |
Vælg de roller, der skal tilføjes til brugeren, eller klik på Inkluder alle roller for at tilføje alle tilgængelige roller til brugeren. Note: Kun de roller, der er tildelt dig, vil være synlige. Nogle roller indeholder tilladelser, der giver dig mulighed for at foretage betalinger i Explorer. Dine Explorer-administratorer er ansvarlige for at sikre, at dine brugere er korrekt konfigureret med kun de relevante brugerroller samt autoriserede grænser. |
For hvert felt skal du vælge en beløbsgrænse (hvis relevant)
5 Klik Status og vælg Aktiv.
6 Klik Roller og vælg den, du vil tildele den nye bruger. Klik på Spare roller Ændringer.
Alle brugere skal være konfigureret med Kun Partner Core Ready rolle.
Hvis brugeren er tildelt Partner Wire Origination rolle skal du konfigurere brugerens oprindelsesgrænse.
7 Hvis du tildeler brugeren Partner Wire Origination rolle, indtast en værdi i Bankoverførsler.Oprindelse felt for at angive den maksimale dollargrænse pr. ledning. Ellers kan du ignorere dette felt.
8 Når du er færdig med at konfigurere alle felter, skal du klikke på Gem ændringer.
9 Hvis du har oprettet en ny bruger, vises en bekræftelsesskærm.
10 For at fuldføre tilføjelsen og konfigurationen af en bruger skal en anden administrator Godkend ændringer.
11 De Godkend ventende ændringer skærmvisninger. Klik Bekræfte.
12 Viewbrugerinformation
Dokumenter/ressourcer
![]() |
Cross River API-platform [pdfBrugermanual API-platform, API-platform, platform |
