Cross River API პლატფორმის მომხმარებლის სახელმძღვანელო

Get access token: Once you’ve received your API credentials and before you can use our APIs, you must get an access token using the client_id და კლიენტის_საიდუმლო you received when you registered.

Use access token: Once you’ve successfully authenticated, an წვდომის_ნიშანი is returned to you. Include this token in the header of your API calls.

Webკაკვები: Webhooks are an important component of any integration with Cross River. While APIs let you request data on demand, webhooks push real-time updates directly to your system—eliminating the need for constant polling and reducing latency.

Sandbox environments: The sandbox is a completely isolated environment, so feel free to

2.1. Get API credentials

ნაბიჯი 1
Get API credentials

ნაბიჯი 2
Get Access Token

ნაბიჯი 3
Use Access Token

ნაბიჯი 4
Build a Sample აპლიკაცია

Your first step to working with Cross River APIs is to register for API credentials. With these credentials you can request and receive an access token to use for sending APIs in our sandbox environment.

მნიშვნელოვანია

Your IP address, which must be public and static, has to be on our allowlist. Your internal IT department should be able to provide you with this IP. Learn more about static IPs.

SandboxAccess

გაგზავნეთ მოთხოვნა for sandbox access, to receive API credentials.

Once your static IP is added to our allowlist, we will send you 2 encrypted emails with your credentials:

One email contains your client_id , partner_id and other information you’ll need depending on what you have requested.

The second email, which is encrypted, contains your კლიენტის_საიდუმლო და webhook_secret . You’ll need these for authentication and for working in the sandbox.

შენიშვნა

If you asked for access to Card Payments, you’ll receive an additional set of credentials including a second client_id და კლიენტის_საიდუმლო

2.2. Get access token

ნაბიჯი 1
Get API credentials

ნაბიჯი 2
Get Access Token

ნაბიჯი 3

Use Access Token

ნაბიჯი 4
Build a Sample აპლიკაცია

Cross River uses OAuth 2.0 for authentication and authorization. This controls entry to our system and ensures that only authorized entities can access our APIs and other protected resources. The information you enter into our authentication system is confidential and can never be accessed from any other Cross River applications.

Once you’ve received your , and before you can use our APIs, you must get API credentials an access token using the client_id და კლიენტის_საიდუმლო you received when you registered. This access token allows you to send information securely as a JSON object for use in our APIs. You must include this token in the header of each API request.

There are several ways to request and receive an access token:

Use Command Line Interface (CLI) with cURL or any other language

Use Postman or any other API testing tool

Once obtained, copy the access token to your clipboard. Make sure you save it.

CommandLineInterface

To request a token send a POST connect/token command containing the client_id და კლიენტის_საიდუმლო და გრანტის_ტიპი to the (auth server) of the authentication server appropriate sandbox, as shown in the sampქვემოთ.

Refer to the for an explanation of these tags. HTTP components table

შემდეგი ყოფილიample uses cURL to request a token from one of the auth servers.

Sample request in cURL for COS

curl –location –request ‘POST https://idptest.crbcos.com/connect/token’ \ –header ‘Content-Type: application/x-www-form-urlencoded’ \ –data-urlencode ‘client_id=[your id here]’ \

–data-urlencode ‘client_secret=[your secret here]’ \

–data-urlencode ‘grant_type=client_credentials’ \

–data-urlencode ‘audience=https://api.crbcos.com/’

Sample response from cURL მოთხოვნა

{ “access_token”: “contains many characters”, \

“expires_in”: 86400, \

“token_type”: “Bearer” }

ფოსტალიონი

To request a token using Postman, send a POST connect/token ბრძანება ავტორიზაცია სერვერი of the appropriate sandbox. Add the გრანტის_ტიპი , scope (optional) ,

client_id და კლიენტის_საიდუმლო to the call.

Refer to the for an explanation of these tags. HTTP components table

If the authentication is successful, the status code is 200 (OK).

COSExplorer

In , click the down arrow next your login and click Copy Access Token. COS Explorer

The access token is copied to your clipboard, ready for use in the . Sandbox

Token request response

ატრიბუტის აღწერა

access_to

კენ

A digitally signed JSON web token (JWT) sent from the oAuth server that allows access to specific Cross River resources

ფარგლები

A range of services that a user can access

expires_i

The amount of time until the token expires.

– Our Integration Team will inform you of the expiration time or you can decode your access token as well.

– We recommend that you retrieve a new access token a short time before the old token is set to expire.

– Reuse tokens for their entire lifespan rather than getting a new token for each call to the same protected resource (API).

მნიშვნელოვანია:

Never decode your token on a publicly hosted webსაიტი

token type

Bearer token

HTTP components

The following HTTP components are used both in the API and Postman requests.

HTTP

კომპონენტი

Tag აღწერა

ბოლო წერტილი	პოსტი /connect/toke n	Endpoint for retrieving an access token
სათაური	შინაარსი ტიპი	განაცხადი/x-www-ფორმა- urlკოდირებული
სხეული	client_id	The unique identifier for a client
სხეული	client_secre t	An encrypted string of characters used to sign and validate ID tokens. მნიშვნელოვანია: Secrets aren’t recoverable by CR. If you lose a secret, a new one must be generated. ნუ commit your secrets into source control.
სხეული	გრანტის_ტიპი	This field will always have a value of client_credentials
სხეული	აუდიტორია სურვილისამებრ	A way for the user to validate if a particular access token is meant for them.
სხეული	ფარგლები სურვილისამებრ	A specific range or a limited set of services that a user can access with an access token. If a scope isn’t specified, the token returned will contain all scopes associated with your credentials. შენიშვნა: Multiple scopes can be sent in the same request by adding a space between the name of each scope. For example: ‘scope=scope1 scope2 scope3’

AuthserverURLs

Module Auth server URL

ანგარიშები	https://idptest.crbcos.com/connect/token
ACH	https://idptest.crbcos.com/connect/token
მავთულები	https://idptest.crbcos.com/connect/token
ჩეკები	https://idptest.crbcos.com/connect/token
ბირთვი	https://idptest.crbcos.com/connect/token
Instant payments	https://idptest.crbcos.com/connect/token
ბარათის გაცემა	https://idptest.crbcos.com/connect/token
Card payments	https://crbcos-sandbox.auth0.com/oauth/token

დაკრედიტება https://oauthtest.crbnj.net/connect/token

პრობლემების მოგვარება

If the authentication token is valid, it will return a 200. If the authentication token isn’t valid, it will return a 401.

If you unable to get a bearer token and you haven’t received one in the past:

დაადასტურეთ URL.

შეამოწმეთ, რომ client_id და კლიენტის_საიდუმლო are typed correctly. They are case sensitive.

შეამოწმეთ თქვენი client_id და კლიენტის_საიდუმლო against the one you received. Make sure there are no network or allowlist issues.

Contact our if your account is locked as a result of 3 incorrect log in Integration Team მცდელობა.

2.3. Use access token

ნაბიჯი 1
Get API credentials

ნაბიჯი 2
Get Access Token

ნაბიჯი 3
Use Access Token

ნაბიჯი 4
Build a Sample აპლიკაცია

Once you’ve successfully, an access token is returned to you. Include authenticated this token in the header of your API calls.

The access token expires after a set period of time. The response containing the token also specifies the expiration time in seconds. Store and use your access token until it expires. We recommend you use the token until you receive a 401 unauthorized error, and then request a new token.

მნიშვნელოვანია

1. Do not request a new token for every API request.

2. Make sure to protect your token. Anyone who steals your token can impersonate your client for the lifetime of the token.

API requestheader

In the header of each API request, include the access token as follows:

Sample call for wire payment in cURL

curl –location –request ‘POST https://sandbox.crbcos.com/Wires/v1/payments’ –header ‘Authorization: Bearer [YOUR TOKEN HERE]’ \

–header ‘Content-Type: application/x-www-form-urlencoded’ \

–data-raw ‘{

“accountNumber”: “2255685659”,

“businessFunctionCode”: “CTR”,

“receiverRoutingNumber”: “021000021”,

“beneficiaryFi”: {

“idCode”: “F”,

“identifier”: “021000021”,

“name”: “JP Morgan Chase”

“beneficiary”: {

“idCode”: “D”,

“identifier”: “123456789”,

“name”: “Peter Griffin”

“beneficiaryReference”: “XYZ123”,

“amount”: 10000,

“purpose”: “payment”

ფოსტალიონი

To use a token in Postman, navigate to the ავტორიზაცია tab in your request, select Bearer Token as the authentication type, and paste your token into the provided field. Postman will automatically add the მატარებელი prefix and the token to the ჟეტონი ველი.

2.4. Webკაკვები

Webhooks are an important component of any integration with Cross River. While APIs let you request data on demand, webhooks push real-time updates directly to your system eliminating the need for constant polling and reducing latency. In many cases, webhooks are more efficient and reliable than APIs alone, ensuring your application stays in sync with critical events like account changes, transaction updates, and processing outcomes.

გამოყენება webhooks within the Cross River systems to notify you when different events occur. The event returns a resource object that contains relevant details about the subject of each event. The full event details are included and sent to your system.

ჩვენ ვიყენებთ webhooks to update you on status and to report transaction changes. Webhooks report to your system with real-time notifications when an event happens.

You must register via API to use webკაკვები:

2.5. Sandbox environments

Our sandbox is a completely isolated environment, so feel free to experiment. When you’re ready to move to production, let us know and we will get you production credentials to access the live environment.

მომხმარებელთა მენეჯმენტი

Module Base URL for API calls

Customer management https://sandbox.crbcos.com/core/ ანგარიშები

Module Base URL for API calls

Deposit accounts

https://sandbox.crbcos.com/core/

Deposit sweeps https://sandbox.crbcos.com/sweepsintrafi/ ბარათები

Module Base URL for API calls

Cards https://sandbox.crbcos.com/cardmanagement/გადახდები

Module Base URL for API calls

Instant Payments	https://sandbox.crbcos.com/rtp/
Card payments: Push to pay	https://pushtopaystaging.crbnj.net/
Card payments: Pull	https://pullfromcardapistg.crbnj.net/
International Payments	https://sandbox.crbcos.com/international/
ACH	https://sandbox.crbcos.com/ach/
მავთულები	https://sandbox.crbcos.com/wires/

Checks https://sandbox.crbcos.com/checks/ COSwebკაკვები

Module Base URL for API calls

COS webკაკვები

https://sandbox.crbcos.com/webhooks/

დაკრედიტება

Module Base URL for API calls

Loan origination

https://arixapisandbox.crbnj.net

Application Decisioning https://lendingsandbox.crbcos.com/preapproval/v1

2.6. Postman collection

To make development easier, we’ve put together a with pre-built

Postman collection requests for all the Cross River . Use this collection to explore, test, and build API endpoints your integration directly in Postman. with minimal extra coding and setup required.To immediately fork our collection, click

Just complete the setup details, and start making calls in Sandbox Postman collection through .

ფოსტალიონი

Access(bearer)token

We’ve created our Postman developer sandbox environment to provide a safe space to test the Cross River APIs. In the Cross River Postman collection, you perform authentication using a bearer token.

To get the IDs you need to set up the access (bearer) token required to run the collection:

1. : With these credentials you request and receive an access token

Get API credentials
to use for sending APIs in our sandbox environment

2. : Once you receive your API credentials and before you can use our

Get access token
APIs, you get an access token using the client_id და კლიენტის_საიდუმლო you received when you registered.

Fork Cross River collection

Head straight to our to fork our collection.

Postman workspace

Once forked, don’t forget to set your environment variables for sandbox.

ConfigureyourPostmanenvironment

To use the collection you just created, navigate to it, click Environments, და აირჩიეთ Sandbox. Copy your Cross River client ID and client secret, and paste them into the client_Id და კლიენტის_საიდუმლო fields. For Card Payments, paste them into the ptpe_client_id და ptpe_client_secret ველები.

Now you’re ready obtain a token and begin to send requests.

1. გაიქეცი Authorization/Obtain token to generate your token. For Card Payments, run Card Payments/Authorization/Get P2PE token .

2. ცვლადი {{token}} (ან ptpe_token for Card Payments) is added automatically to your environment by a post reponse script. When the token expires you need to follow step 1 again.

3. There are several variables that you might need to populate depending on which endpoint you’re exercising. For exampლე, partner_id , პროდუქტის_იდენტიფიკატორი , configuration_id და callback_url .

4. There are also some variables that are populated through scripts, such as ჟეტონი და ptpe_token that should not be populated manually.

Pingthesandbox

Run a simple test to verify that you can connect to the Cross River sandbox.

To send a Ping request, in Postman open Collections > Cross River API Collection > Authorization და გაუშვით პინგ საბოლოო წერტილი.

Modifyrequests

To update a request, make your changes on the სხეული tab. Values in double curly brackets pull from your environment variables. Check our to see which fields each API docs

endpoint accepts, and view requests in your preferred language.

3. Build a sampაპი

ნაბიჯი 1
Get API credentials დაყენება

ნაბიჯი 2
Get Access Token

ნაბიჯი 3
Use Access Token

ნაბიჯი 4
Build a Sample აპლიკაცია

: Before you start, refer to our quickstart guide to get connected to our APIs. To test the API calls, you can use cURL from the command line, or a service such as Postman or Swagger in our sandbox.

Customers and accounts
: Before you use Cross River services, you need to create a customer record for each of your customers

ბარათები
: Manage your customer’s cards by working with Cross River to decide what you want to offer, such as physical or virtual cards.

დაკრედიტება
: Lending includes a set of lending APIs calls to allow you to create, update, and manage your loans.

3.1. დაყენება

Before you start, refer to our guide to get connected to our APIs. To test the API quickstart

calls, you can use cURL from the command line, or a service such as Postman or Swagger in our sandbox.

To create a card or payment app, you must create customer and accounts.

Explore sandbox

We have full for you to explore. The sandbox is completely isolated sandbox environments from the production environment, so feel free to experiment. When you’re ready to move to production, talk to your relationship manager, who will get you production credentials to access the live environment.

Register relevant web hook events

Webhooks are an important component of any integration with Cross River. While APIs let you request data on demand, webhooks push real-time updates directly to your system— eliminating the need for constant polling and reducing latency. In many cases, webhooks are more efficient and reliable than APIs alone, ensuring your application stays in sync with critical events like account changes, transaction updates, and processing outcomes.

რეგისტრაცია მიიღოს webhook events. When webhook events are triggered, the event objects are sent to the registered URLs.

3.2. Customers and accounts

ნაბიჯი 1
Get API credentials

ნაბიჯი 2
Get Access Token

ნაბიჯი 3
Use Access Token

ნაბიჯი 4
Build a Sample აპლიკაცია

Create a customer record and a funded account:

Create a customer record

Create a deposit account

Fund an account

Createacustomer record

Before you use Cross River services, you need to for each of create a customer record

your customers. The customer onboarding process includes creating a customer record with relevant customer information.

All customers are automatically scanned for regulatory compliance purposes, so you need to register for relevant webhooks events to receive customer record status updates.

The customer record can be for either პირადი or ბიზნესი customers. Once registered, a customer can be associated with one or more accounts.

Webკაკვები

რეგისტრაცია ამისთვის webhooks. The following webhooks are used:

Webhook Description

Core.Customer.Onboarded	Notifies you that the customer record has been created
Core.Customer.Ofac.Changed	Notifies you that a customer’s OFAC status has been updated

Core.Customer.PepScan.Chan ged

Notifies you that a customer’s PEP status has been updated

Exampleof recordcreation

ამ ყოფილშიample, we’ll onboard John Smith. First, let’s create a customer record. We are registering John as a პირადი მომხმარებელს.

To onboard a business customer, first create a personal customer record for the primary owner of that business. After that, create a business customer and add the personal record as a beneficial owner.

1 დარეკეთ POST /core/v1/cm/customers .

შემდეგში ეგample you can see are required. which attributes

მნიშვნელოვანია

We highly recommend you include an in your request header idempotency key

to provide duplicate protection in the event of a failure.

Curl

curl -X POST /core/v1/cm/customers –header ‘Content-Type: application/j {

“partnerId”: “6e80b097-693c-4592-8440-02f345335bbf”,

"სახელი": {

“firstName”: “John”,

“lastName”: “Smith”

“classification”: “Personal”,

"პროfile„: {

“regO”: ცრუ,

“politicallyExposedPerson”: ცრუ,

“taxIdType”: “Ssn”,

“taxId”: "119988776",

“birthDate”: “1953-09-22”,

“riskRating”: "დაბალი"

“primaryAddress”: {

“addressType”: "სახლი",

“classification”: “Residential”,

“isPrimary”: true,

“street1”: “123 Any St”,

“city”: “Anywhere”,

“state”: “NY”,

“postalCode”: "12345",

“countryCode”: "აშშ"

“primaryPhone”: {

“isPrimary”: true,

“phoneType”: "სახლი",

“phoneNumber”: "2015551234"

“primaryEmail”: {

“isPrimary”: true,

“emailType”: “Personal”,

“emailAddress”: “John.Smith@xxxxx.com”

}

A successful API call returns a JSON response with the unique customer ID in the first line of the response body. Your customer has been created.

Onboarding a customer response body

{

“id”: “9052b6a5-3f09-41d1-b526-ade80104eb79”,

“cifNumber”: "32653745014",

“classification”: “Personal”,

"სტატუსები": "აქტიური",

“ofac”: “Pending”,

“pepScan”: “Pending”,

"სახელი": {

“firstName”: “John”,

“lastName”: “Smith”,

“fullName”: “John Smith”

"პროfile„: {

“regO”: ყალბი,

“politicallyExposedPerson”: ყალბი,

“enableBackupWithholding”: ყალბი,

“taxIdType”: “Ssn”,

“taxId”: "119988776",

“birthDate”: “1953-09-22”,

“riskRating”: "დაბალი"

“createdAt”: “2021-01-25T17:55:24.4422582-05:00”,

“lastModifiedAt”: “2021-01-25T17:55:24.4432543-05:00”,

“partnerId”: “6e80b097-693c-4592-8440-02f345335bbf”

}

2 The Core.Customer.Onboarded webhook event is triggered when the customer record is created.

Customer onboarded event

{

“id”: “3d9c5e1a-623b-4cf2-812e-ade80105048e”,

“eventName”: “Core.Customer.Onboarded”,

"სტატუსები": “Pending”,

“partnerId”: “30dee145-b6a2-4058-8dc3-ac4000dee91f”,

“createdAt”: “2021-11-22T10:50:20.553-05:00”,

“resources”: [

“core/v1/cm/customers/9052b6a5-3f09-41d1-b526-ade80104eb79” ],

“details”: []

}

Cross River scans the new customer record for OFAC and PEP compliance.

Sometimes the results of the scan require a review by the our Anti-Money Laundering (AML) team.

On scan completion, Core.Customer.Ofac.Changed და

Core.Customer.PepScan.Changed webhook events return with a status. Customers with no compliance issues show a წმინდა სტატუსი.

Customer OFAC scan changed

{

“id”: “45db5592-56ee-41f5-85e7-ade8010571ce”,

“eventName”: “Core.Customer.Ofac.Changed”,

"სტატუსები": “Pending”,

“partnerId”: “30dee145-b6a2-4058-8dc3-ac4000dee91f”,

“createdAt”: “2021-11-22T10:51:53.657-05:00”,

“resources”: [

“core/v1/cm/customers/9052b6a5-3f09-41d1-b526-ade80104eb79” ],

“details”: []

}

Customer PEP scan changed

{

“id”: “a5000831-3e01-4231-9ec2-ade8010571c5”,

“eventName”: “Core.Customer.PepScan.Changed”,

"სტატუსები": “Pending”,

“partnerId”: “30dee145-b6a2-4058-8dc3-ac4000dee91f”,

“createdAt”: “2021-11-22T10:51:53.597-05:00”,

“resources”: [

“core/v1/cm/customers/9052b6a5-3f09-41d1-b526-ade80104eb79” ],

“details”: []

}

You have now created a customer record.

Updatecustomer record

It is possible to update the customer details such as address, phone number and email. These details are considered პირველადი information. If you add a second address, this is მეორადი.

1 Use the customer ID returned when you create the customer record to call POST /core/v1/cm/customers/{id}/addresses to add the . The first customer address

address you add is the პირველადი address. In the following example you can see which attributes are required.

Update customer address

POST /core/v1/cm/customers/9052b6a5-3f09-41d1-b526-ade80104eb79/addresse {

“addressType”: "სახლი",

“classification”: “Residential”,

“isPrimary”: true,

“street1”: “123 Any St”,

“city”: “Anywhere”,

“state”: “NY”,

“postalCode”: "12345",

“countryCode”: "აშშ"

}

2 დარეკეთ POST /core/v1/cm/customers/{id}/phones რომ დაამატოთ

customer phone

. The first phone number you add is the პირველადი ტელეფონის ნომერი.

ნომერი

Update customer phone number

POST /core/v1/cm/customers/9052b6a5-3f09-41d1-b526-ade80104eb79/phones {

“isPrimary”: true,

“phoneType”: “Mobile”,

“phoneNumber”: "2015552345"

}

3 დარეკეთ POST /core/v1/cm/customers/{id}/email to update the . customer email

Update customer email

POST /core/v1/cm/customers/9052b6a5-3f09-41d1-b526-ade80104eb79/email {

“isPrimary”: true,

“emailType”: “Personal”,

“emailAddress”: “john.jones@xxx.com”

}

Createadepositaccount

CR provides a number of different types of accounts, including check and savings, Certificates of Deposit (CDs or time deposit accounts), and more.

To open any kind of deposit account you must have a valid product ID for the type of account you want to open, and a customer ID (onboarded customer record ID) for the account holder. Note that the account holder must have at least one address and phone number in their customer record, and their OFAC status must be წმინდა. In addition, the classification of the customer must match the configured classification for the product. For example, only business customers can be added to a business product.

Beforeyoubegin

დარწმუნდით, რომ გაქვთ:

API credentials

Partner ID (that you received when you registered)

მომხმარებლის ID

Product ID (defines the type of account being opened)

მნიშვნელოვანია

We strongly recommend that you include an in the request header idempotency key to prevent duplicate payments in case of a failure.

End points and webკაკვები

The following API endpoint is used:

API აღწერა

Open a deposit account Opens a deposit account for a customer

შემდეგი webhook is used:

Webhook Description

Core.Account.Opened A new account was opened

Openanaccount

In the following scenario, you’ll open an account for John Smith, a customer who you successfully onboarded.

Toopenanaccount

1 დარეკეთ POST core/v1/dda/accounts .For this call, some attributes are required. See the full .

list of attributes

Sampთხოვნა

POST /core/v1/dda/accounts

{

“customerId”: “59e3bc15-bbec-4990-88e9-a9a600d3296c”,

“productId”: “44015e68-1afb-40fc-9497-abc1014f52da”,

“title”: “John Smith”,

“statementAddress”: {

“street1”: “257 Dalton Groves”,

“city”: “Barton City”,

“state”: “MI”,

“postalCode”: "48705",

“countryCode”: "აშშ"

}

2 A successful API call returns a JSON response with the details of the new account.

Sampპასუხი

პოსტი /ბირთვი/v1/dda/ანგარიშები

{

“customerId”: “59e3bc15-bbec-4990-88e9-a9a600d3296c”,

“productId”: “44015e68-1afb-40fc-9497-abc1014f52da”,

“title”: “John Smith”,

“statementAddress”: {

“street1”: “257 Dalton Groves”,

“city”: “Barton City”,

“state”: “MI”,

“postalCode”: "48705",

“countryCode”: "აშშ"

}

3 The accountNumber field provides the account number for the new account.

4 In the response example, the account is classified as პირადი because the user configured the product classification as პირადი. The account classification always matches the configured product classification.

5 The account status is automatically updated to აქტიური , and is immediately available for use. This triggers the Core.Account.Opened ღონისძიება.

Core.Account.Opened Event Details

{

“id”: “259cdbca-6a89-4af8-a50e-ada3010fb13f”,

“eventName”: “Core.Account.Opened”,

"სტატუსები": “Pending”,

“partnerId”: “e6c3824a-377f-44d5-a2f6-a9a600c9b37e”,

“createdAt”: “2021-01-26T09:48:10.1011462-05:00”,

“resources”: [

“core/v1/dda/accounts/2235223803”

“details”: []

}

Fundanaccount

When you work in the sandbox to test payment rails and account behavior you need to have funds in an account.

You can use any rail that has an inbound simulation endpoint to fund a sandbox account, if the account is configured for it. In particular, you can:

Simulate inbound ACH payments

Simulate an inbound wire

For any simulation, you need the number of the Cross River sandbox account that you want to fund. The originator information is not important, and in some cases can even be completely fictitious.

NextSteps

Check out our payment .

გაკვეთილები

3.3. ბარათები

ნაბიჯი 1
Get API credentials

ნაბიჯი 2
Get Access Token

ნაბიჯი 3
Use Access Token

ნაბიჯი 4
Build a Sample აპლიკაცია

Get to know how to work with Cross River APIs. This page shows you how to:

Create a card

Activate a card

Createacard

Manage your customer’s cards by working with Cross River to decide what you want to offer, such as physical or virtual cards. This is the card configuration. Cross River creates a card configuration profile for you for each type you choose for your financial instrument კლიენტებს.

სანამ დაიწყებ

Make sure you do and have:

Create a customer record

Create a deposit account

Cardholder’s account number

Customer ID (you get this when you create a customer)

Configuration ID (Cross River provides ID to you when you configure your type/card)

We also recommend that you for the relevant webhook events. register

Endpointsandwebკაკვები

რეგისტრაცია ამისთვის webhooks. The following API endpoints are used:

API აღწერა

Create new card Requests creation of a new debit card

შემდეგი webhooks are used:

Webhook Description

Cards.Card.Created Debit card created

Orderacard

You will learn how to order/create a new debit card. by creating a card for John Smith.

1 დარეკეთ POST /cardmanagement/v1/cards .

შემდეგში ეგample you can see which attributes are required. See details of the complete API.

ბარათის დამატება

Sample create a card

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”, \

“lastName”: “Smith”, \

“phone”: { \

“phoneType”: “Home”, \

“phoneNumber”: “9133413131” \

}, \

“emailAddress”: “John.Smith@xxxxx.com”, \

“shippingAddress”: { \

“street1”: “Lane Ave”, \

“street2”: “string”, \

“city”: “Big Town”, \

“state”: “IL”, \

“postalCode”: “72410”, \

“countryCode”: “US” \

}, \

“billingAddress”: { \

“street1”: “Lane Ave”, \

“street2”: “string”, \

“city”: “Big Town”, \

“state”: “IL”, \

“postalCode”: “72410”, \

“countryCode”: “US” \

}, \

“nameOnCard”: “John Smith”, \

“shippingType”: “Normal”, \

“clientIdentifier”: “string” \

}’ ‘https://sandbox.crbcos.com/CardManagement/v1/cards’

2 A successful API call returns a JSON response with the details of the new card. The card status will be unactivated until you activate the card. The id is the card ID, in this example 8709163d-140c-4d95-a111-afa8009e9cd1, which you will need to გააქტიურება ბარათი.

Sample order a card response

{

“id”: “8709163d-140c-4d95-a111-afa8009e9cd1”, “partnerId”: “cd9c12f4-7691-424a-b38b-af5b0134c611”, “productId”: “83bed086-8182-4151-a1e3-af5b01362783”, “accountNumber”: "2608927303",

"სტატუსები": “Unactivated”,

“statusReasonCode”: “NotSet”,

“firstName”: “John”,

“lastName”: “Smith”,

“shippingAddress”: {

“street1”: “Lane Ave”,

“street2”: “string”,

“city”: “Big Town”,

“state”: “IL”,

“postalCode”: "72410",

“countryCode”: "აშშ"

“billingAddress”: {

“street1”: “Lane Ave”,

“street2”: “string”,

“city”: “Big Town”,

“state”: “IL”,

“postalCode”: "72410",

“countryCode”: "აშშ"

“phone”: {

“phoneType”: "სახლი",

“phoneNumber”: "9133413131"

“emailAddress”: “john@anygoogle.com”,

“nameOnCard”: “John Smith”,

“isPinSet”: ყალბი,

“adminBlocked”: ყალბი,

“fraudSuspect”: ყალბი,

“configurationId”: “a6b5a94c-f8f9-462b-8ce8-afa400f5b640”, “category”: “Credit”,

“paymentInstrument”: “VirtualPan”,

“processor”: “processor name”,

“shippingType”: "ნორმალური",

“orderStatus”: “OrderPending”,

“replacementStatus”: “NotApplicable”,

“customerId”: “2b15a695-13dc-4b10-b4e5-af5b0138873c”, “clientIdentifier”: “string”,

“createdAt”: “2023-02-13T04:37:29.4869172-05:00”,

“lastModifiedAt”: “2023-02-13T04:37:29.4869172-05:00”

}

3 The Cards.Card.created webhook event is triggered when the card is generated at the processor.

Sample Cards.Card.Created event

{

“id”: “cea6c5b5-13e7-4c2f-ba75-afce01110fe5”,

“eventName”: “Cards.Card.Created”,

"სტატუსები": “Pending”,

“partnerId”: “cd9c12f4-7691-424a-b38b-af5b0134c611”,

“createdAt”: “2023-02-13T04:42:29.4869172-05:00”,

“resources”: [

“cardmanagement/v1/cards/8709163d-140c-4d95-a111-afa8009e9cd1” ],

“details”: [

{

“cardId”: “8709163d-140c-4d95-a111-afa8009e9cd1”,

"სტატუსები": “Unactivated”,

“statusReasonCode”: “NotSet”

}

]

}

Activatethecard

Beforeyoubegin

დარწმუნდით, რომ გაქვთ:

API credentials

Card ID from when you ordered the card

Endpointsandwebკაკვები

API აღწერა

POST /cardmanagement/v1/cards/{id}/activate Activates the card using the card ID The tutorial uses these webკაკვები:

Webhook Description

Cards.Card.Activated Debit card activated

Activatethecard

Activate the card you created in the stage.

create a card

1 დარეკეთ POST /cardmanagement/v1/cards/{id}/activate . The id attribute must be set to the card ID. In the sample below the ID is 8709163d-140c-4d95-a111 afa8009e9cd1.

Sample activate card request

curl -X პოსტი

–header ‘Accept: application/json’

–header ‘Authorization: Bearer ‘<ჟეტონი>„

https://sandbox.crbcos.com/CardManagement/v1/cards/8709163d-140c-4d95-a1

2 A successful API call returns a JSON response with the details of the card. The card სტატუსი არის ახლა გააქტიურებული. The OrderStatus is დასრულებული.

Sample activate card response

{

“id”: “8709163d-140c-4d95-a111-afa8009e9cd1”, “partnerId”: “cd9c12f4-7691-424a-b38b-af5b0134c611”, “productId”: “83bed086-8182-4151-a1e3-af5b01362783”, “processorCardId”: "804951250206718",

“accountNumber”: "2608927303",

"სტატუსები": "აქტიური",

“statusReasonCode”: “NotSet”,

“firstName”: “John”,

“lastName”: “Smith”,

“shippingAddress”: {

“street1”: “Lane Ave”,

“street2”: “string”,

“city”: “Big Town”,

“state”: “IL”,

“postalCode”: "72410",

“countryCode”: "აშშ"

“billingAddress”: {

“street1”: “Lane Ave”,

“street2”: “string”,

“city”: “Big Town”,

“state”: “IL”,

“postalCode”: "72410",

“countryCode”: "აშშ"

“phone”: {

“phoneType”: "სახლი",

“phoneNumber”: "9133413131"

“emailAddress”: “john@anygoogle.com”,

“nameOnCard”: “John Smith”,

“panLastFour”: "3629",

“isPinSet”: ყალბი,

“expirationDate”: “2026-02-13”,

“adminBlocked”: ყალბი,

“fraudSuspect”: ყალბი,

“configurationId”: “a6b5a94c-f8f9-462b-8ce8-afa400f5b640”, “category”: “Credit”,

“paymentInstrument”: “VirtualPan”,

“processor”: “processor name”,

“shippingType”: "ნორმალური",

“orderStatus”: "დასრულებულია",

“replacementStatus”: “NotApplicable”,

“customerId”: “2b15a695-13dc-4b10-b4e5-af5b0138873c”,

“clientIdentifier”: “string”,

“processorCustomerId”: “T83E9D675A3N3N9O8RZ1”,

“createdAt”: “2023-02-13T04:37:29.487-05:00”,

“initialActivation”: “2023-02-13T00:00:00-05:00”,

“activatedAt”: “2023-02-13T04:43:19.282287-05:00”,

“lastModifiedAt”: “2023-02-13T04:43:19.2962845-05:00”

}

3 When the card status changes to აქტიური , Cards.Card.Activated webhook event fires.

Cards.Card.Activated webhook event

{

“id”: “95ac33ca-3d7f-49aa-bfc2-afce01113310”,

“eventName”: “Cards.Card.Activated”,

"სტატუსები": “Pending”,

“partnerId”: “cd9c12f4-7691-424a-b38b-af5b0134c611”,

“createdAt”: “2023-02-13T04:44:31.282287-05:00”,

“resources”: [

“cardmanagement/v1/cards/8709163d-140c-4d95-a111-afa8009e9cd1” ],

“details”: [

{

“cardId”: “8709163d-140c-4d95-a111-afa8009e9cd1”,

"სტატუსები": "აქტიური",

“statusReasonCode”: “NotSet”

3.4. დაკრედიტება

ნაბიჯი 1
Get API credentials

ნაბიჯი 2
Get Access Token

ნაბიჯი 3
Use Access Token

ნაბიჯი 4
Build a Sample აპლიკაცია

Lending includes a set of calls to allow you to create, update, and manage lending API your loans.

To start working with lending, make sure you:

Receive API credentials with the scopes needed for Lending

If you have created the API Credentials, using the self-service Management

, then you should also send a request to

arix.support@crossriver.com

ორგ, along with your clientid and MPLID, to complete the creation.

Use the correct scope, for the APIs you want to use.

API scope for sandbox is: CosLending:PreApproval:stg

Sandbox

Module Base URL for API calls Description

სესხი origination

Application decisioning

https://arixapisandbox.crbnj. net

ბაზა URL for loan origination API calls to the Arix sandbox environment

https://lendingsandbox.crbco s.com/preapproval/v1

ბაზა URL for sandbox of

application decisioning

სვაგერი

Module Swagger Link

API მითითება

დოკუმენტაცია

https://arixapisandbox.crbnj.net/swagger-ui

კაკვები

https://lendingsandbox.crbcos.com/hooks/swagger/inde x.html

Selling https://lendingsandbox.crbcos.com/selling/swagger/inde x.html

სტატუსის გვერდი

To see a list of upcoming releases, monitor current API status, view incident reports, or get notified of scheduled maintenance, visit our and subscribe to alerts. status page

4. პროგრამის დაყენება

Set up SFTP: Use SFTP either to send files or to download them from Cross River, according to your needs and ours.

Customer onboarding: Manage your customer information in the Cross River operating system (COS) using either APIs or COS explorer

COS product types and IDs: Explaining COS product types and IDs.

COS Explorer: How to work with our COS Explorer.

Org management portal: How to work with our Org management portal.

4.1. Set up SFTP

When you need to exchange sensitive information in a file format with Cross River, we require you to use Secure File Transfer Protocol (SFTP). Use SFTP either to send files or to download them from Cross River, according to your needs and ours. In some cases, you or we will encrypt these files, particularly if they contain any Personal Identifying Information (PII).

UsingSFTP

SFTP lets you securely send and receive sensitive files and reports using a folder assigned specifically to your business on a secure server. Upload and download files through that folder or subfolders of that folder, as per your specific needs.

Using encryption

Encrypting files adds an additional layer of protection. Only authorized personnel with the correct key will be able to decrypt the encrypted file. In Cross River we use PGP encryption.

დაიწყეთ

There are several steps to getting you up and running with our SFTP server.

1 You complete the IP Access Request for Cross River SFTP Services form (from your RM).

If you need to share files with Cross River, your Relationship Manager will send you an IP Access Request for CRB SFTP Services form. Among other information, you need to provide the static public IP addresses you’ll use to access the SFTP folder, and a PGP public key for encrypting and decrypting files. Send the completed form back to your Relationship Manager

მნიშვნელოვანია

Cross River will allowlist only 5 IP addresses for you, so take that into account. The IP addresses must be static. Therefore, you need to proxy anything that is not static on your end.

2 We set up your SFTP folder structure.

Once Cross River has your details, our IT engineering department creates a standard set of folders and sub-folders for you. This unique path is for your business only. No other partner can access it. IT engineering sends you an email with the information you need to access the folders. The email includes a link to your credentials. Cross River does not save your password!

მნიშვნელოვანია

The link is only good for a few days, after which you’ll need to request a password reset if you don’t use it.

The credentials also become invalid if more than two people access the link.

3 Test SFTP upload.

If you will be supplying files to Cross River, your IT department should set up a service account with an automated process for uploading those files to your SFTP folders. We strongly recommend that you test this out before you try to send real data. Contact your relationship manager with any questions or issues or open a ticket with your first line support.

4 Set up PGP to send or receive files from Cross River. (This step is only necessary if you are sending or receiving PII. Please check with your RM.)

If you need to send Cross River files, we will first send you our PGP public key for use in encrypting those files.

You should have already sent Cross River your PGP public key to receive files from us.

5 Share your data.

Once your SFTP folder is set up and your process is in place you can begin sharing files with us. Your relationship manager tells you if there is something more specific you need to do to receive reports, or how to prepare data to send to us.

SpecificReports

Learn more about preparing and sending reports and files ამისთვის:

Accounts and payments

Card payments

საკრედიტო რისკი

დაკრედიტება

XML batch payments (ISO 20022)

4.2. Customer onboarding

Manage your customer information in the Cross River operating system (COS) using either APIs or . This information includes basic details needed to open a bank COS Explorer

account or use a credit card, as well as more specific data about the customer, as needed. We call this a customer record.

Before you can open a deposit account or create a card you must create the customer record, sometimes called ჩამოსვლა. You can then assign one or more customers to an account through customer ურთიერთობები.

The customer onboarding process includes creating a with relevant customer record customer information. Follow this tutorial to for each of you create a customer record customer.

Optionalsteps

Add ID details

Add a beneficial owner

Errorcodes

See , along with lots of other reference information, on the COS COS system error codes

reference codes page.

4.2.1. Customer record

Customer record

The customer record is the primary resource containing customer information in the Cross River system. Therefore, before creating an account for a customer, you must onboard that customer. The customer record supports classifications of type Personal or Business. Once onboarded, you can associate a customer with one or more accounts.

ყოფილმაample below shows how to onboard a customer for a personal customer.

Onboard Person Request

POST /core/v1/cm/customers {

“partnerId”: “7cc038be-fde9-4455-b27b-1497cf667362”,

"სახელი": {

“prefix”: “Mr.”,

“firstName”: “John”,

“middleName”: “Robert”,

“lastName”: “Smith”,

“suffix”: “Jr.”,

“preferredName”: “Jim” },

“classification”: “Personal”,

"პროfile„: {

“regO”: ცრუ,

“citizenshipCountryCode”: "აშშ",

“politicallyExposedPerson”: ცრუ,

“enableBackupWithholding”: ცრუ,

“backupWithholdingPercent”: 0,

“taxIdType”: “Ssn”,

“taxId”: "123456789",

“birthDate”: “1965-09-15”,

“riskRating”: "დაბალი",

“privacyOptOut”: მართალია }

} Onboard a business customer such as corporation or LLC using the same endpoint with slightly different attributes.

Curl

POST /core/v1/cm/customers {

“partnerId”: “a24cba49-2bb6-431d-a867-1de81d6e4127”,

"სახელი": {

“entityName”: “ACME CO”, },

“classification”: “Business”,

"პროfile„: {

“citizenshipCountryCode”: "აშშ",

“enableBackupWithholding”: ცრუ,

“backupWithholdingPercent”: 0,

“taxIdType”: “Ein”,

“taxId”: "123456789",

“dateFormed”: “2019-09-10”,

“entityType”: “Corporation”,

“riskRating”: "დაბალი",

“ownershipType”: “LegalEntity”,

“primaryOwnerCustomerId”: “f9321f7f-3712-46e1-b965-2b79ead64dc9”, } }

Regardless of whether you are onboarding a personal or business customer, the primary Owner CustomerId attribute must contain a customer ID referencing a customer record of type Personal. So to onboard a business, you must first create a personal customer record for the primary owner of that business.

მნიშვნელოვანია

Some customer endpoints include a dueDiligence resource that may or may not be required when onboarding personal customers. Your assigned compliance liaison communicates requirements for any Due Diligence fields during your onboarding process.

Beneficial owners

A beneficial owner is a person who owns 25% or more of a business. For regulatory reasons, you need to resource in a ბიზნესი customer record create a beneficial owner

for each beneficial owner of that business. The ownerCustomerId attribute references the Personal customer record for each beneficial owner. You usually add beneficial owner resources to the business customer record immediately after onboarding a business.

Curl

POST /core/v1/cm/customers/{customerId}/beneficial-owners {

“ownerCustomerId”: “c1210a2d-932e-43ca-be29-f358a4382385”,

“ownerTitle”: “President” }

მისამართი

The physical addresses associated with customer can be .

განახლებულია

Curl

POST /core/v1/cm/customers/{customerId}/addresses

{

“isPrimary”: true,

"სტატუსები": "აქტიური",

“classification”: “Residential”,

“addressType”: "სახლი",

“street1”: “123 Maple Street”,

“street2”: “Apt. 12”,

“street3”: "",

“city”: "ნიუ იორკი",

“state”: “NY”,

“postalCode”: "10025",

“countryCode”: "აშშ",

}

Emailaddresses

ელ.ფოსტის განახლება

contact information for customer.

Curl

POST /core/v1/cm/customers/{customerId}/emails {

“isPrimary”: true,

“emailType”: “Personal”,

“emailAddress”: “john.smith@crossriver.com” }

ტელეფონები

Update phone Curl

contact information for customer.

POST /core/v1/cm/customers/{customerId}/phones

{

“phoneType”: "სახლი",

“isPrimary”: true,

“phoneNumber”: "2015551234"

}

იდენტიფიკაციები

Identifications are used to track metadata for customer-identifying documents such as driver’s licenses and passports. can be used to add new ID details. Add ID details

Curl

POST /core/v1/cm/customers/{customerId}/identifications {

“isPrimary”: true,

“idNumber”: “DL123456789”,

“idType”: “DriversLicense”,

“issuedDate”: “2018-08-30”,

“expDate”: “2018-08-30”,

“verifiedDate”: “2018-08-30”,

“issuingAuthority”: “NJ DMV”,

“issuingStateOrProvince”: “NJ”,

“issuingCountryCode”: "აშშ",

}

4.2.2. COS product types and IDs

In Cross River, a პროდუქტის ტიპი is a uniquely configured financial product you offer your customers. For example, a product type could be a debit card or a savings account, configured according to your needs and specifications. You open accounts for your customers under any product type you define and configure together with us. Speak to your relationship manager for more details, including how to set up product types for your customers.

მაგample, you might want to configure a product type to be a savings account product that uses Wires and ACH payments. You can then offer your customers savings accounts with these services and configurations.

Cross River provides you with a product ID for each product type that you want to offer your customers. To open any kind of deposit account you must have a valid product ID and a customer ID (onboarded customer record ID) for the account holder. Note that the account holder must have at least one address and phone number in their customer record, and their OFAC status must be წმინდა. In addition, the classification of the customer must match the configured classification for the product. For example, only business customers can be added to a business product.

4.2.3. COS Explorer

Once you are into the Cross River system and have received the email with onboarded

შენი კლიენტის ID და საიდუმლო you are ready to login to the COS Explorer. AccesstheCOSExplorerportal

წარმოება:

https://api.crbcos.com/explorer2/

Sandbox:

https://sandbox.crbcos.com/explorer2/

Welcomeemail

You will received a welcome email from CrossRiver_DO_NOT_REPLY@crossriver.com. If you don’t see it in your inbox, check your spam or blocked mail folders.

დააწკაპუნეთ Create your Cross River Account.

If you leave the wizard at any time, click the link in the original email to go back to where you left off.

ვადები და პირობები

Read through the terms and conditions, check მიღებადა დააწკაპუნეთ შემდეგი.

SMS(textmessage)verification

We send you an SMS (text message) to your device to verify your identity. Enter the 6-digit code you receive in the login screen and click Verify Code.

შექმენით თქვენი პაროლი

1. Enter a password that meets the on-screen requirements and re-enter the password.

2. დააწკაპუნეთ შექმენით პაროლი.

Authenticator app setup

You must complete this step to continue the registration process and to be able to login in the future

To protect your identity and your account and information, we require you to sign in with multi-factor/2-factor authentication.

If you don’t already have an authenticator app on your device, you need to download one before you continue.

For Android and iOS, we recommend using the follow authenticator app:

Google Authenticator

Microsoft Authenticator

Once you have your authenticator app installed, you need to either QR კოდის სკანირება or manually enter the key into the authenticator app.

QRcode

1. Scan the QR code in your authenticator app and, if necessary, enter the 6-digit code in the Multi-Factor authentication page.

2. დააჭირეთ გაგრძელება.

სახელმძღვანელო

1. დააწკაპუნეთ Show key

2. Copy the key as the საიდუმლო in your authenticator app.

3. შეიყვანეთ ოთხნიშნა კოდი.

4. დააწკაპუნეთ განაგრძეთ.

InvalidMFAcode

If you enter an invalid MFA code, a red message notifies you to try again.

Oops! You entered an invalid MFA code. Here are some things to double check:

1. Did the code timeout before you clicked განაგრძეთ? Remaining time is indicated by the countdown circle to the right of the account name and MFA code.

2. If you have the authenticator app set up for multiple environments or applications, double check that you entered the correct code.

1. If it is not clear from the MFA connection names which is correct option, you might need to try different codes until finding the one that works.

2. Once you find the correct connection, you can rename the MFA connection in the app. A pencil icon at the top of MFA app screen will bring you to edit mode. In some apps, you will need to first select (or press and hold) the connection that should be edited, and then the icon will appear.

3. Once in edit mode, you can rename the connections as needed so that it will be clear which one applies to which environment.

4. Save any changes, and next time it should be easier to understand which code to use.

Recoverycodes

Use recovery codes to authenticate in case you lose your device.

1. Download or copy your recovery codes and keep them in a secure place that you will remember.

2. Confirm that you have stored your recovery codes

3. დააწკაპუნეთ ანგარიშის შექმნა.

The recovery codes page times out after 10 minutes.

You can only download the recovery codes once.

Your account is now active and you can use it to login to any of your CR apps.

IP allow listing

Only a static IP can be used to access COS Explorer. Reach out to your IP Support if you need help with this.

The Identity Server IP addresses are:

172.67.26.222 104.22.40.134 104.22.41.134

The server is proxied via Cloudflare.

You can allow these FQDNs:

idptest.crbcos.com

პრობლემების მოგვარება

Forgotpassword

1. დააწკაპუნეთ დაგავიწყდათ პაროლი? and enter your email.

2. Enter the 6-digit authentication code from your authenticator app. 3. თქვენ მიიღებთ ა დაგავიწყდათ პაროლი email. Click პაროლის აღდგენა.

4. In the Password Reset page, enter a new password, click პაროლის აღდგენა, და Continue to the application.

Resetmulti-factorauthentication

If you already have MFA configured:

1. In Identity Server, go to Reset MFA და დააწკაპუნეთ Reset your MFA device. 2. The Multi-Factor Authentication page opens and you can reset your MFA.

You can also create new multi-factor authentication recovery codes.

1. დააწკაპუნეთ create new multi-factor authentication recovery codes.

2. The Recovery Codes page opens and you can copy or download your 10 new recovery codes.

If you have not yet configured your multi-factor authentication, you can enable MFA from ანგარიშის პარამეტრები.

1. დააწკაპუნეთ Reset MFA Method.

2. დააწკაპუნეთ Configure MFA.

3. Follow the instruction in Multi-Factor Authentication/2-Step Authentication.

If your current MFA is SMS, you can enable MFA with your authenticator app. In ანგარიშის პარამეტრები

1. დააწკაპუნეთ Reset MFA Method.

2. დააწკაპუნეთ Configure MFA.

3. Follow the instruction in Multi-Factor Authentication/2-Step Authentication.

Use a recovery code

If you do not have access to your multi-factor (2-factor) authenticator, you can log in using one of your recovery codes.

1. Log in as usual

2. On the Multi-Factor Authentication page, you have the option to use a recovery code as your authentication option.

3. Enter one of your recovery codes in the text box. The recovery code is single-use and cannot be reused. To avoid future confusion, we recommend that you mark the recovery code as used.

Accountlockout

If you enter the wrong password for your username 5 times, the system locks your account for approximately 5 minutes. If after 5 minutes, you are still unable to access your account, contact Cross River Support.

Browsererror -Firewall

You log in to COS Explorer and get following error screen:

You are blocked by a firewall.

1. Contact your internal IT department to see if your organization enforces firewall rules for outbound traffic. If there are no firewall rules for outbound traffic, then:

2. Contact your internal IT department to make sure you’re connecting to the Cross River COS Explorer Portal from an approved IP address. If you need to register more IP addresses, send an email to COS support.

4.2.3.1. მომხმარებლის მენეჯმენტი

Managingusers

შეგიძლიათ გამოიყენოთ მომხმარებლები ეკრანზე ადმინ tab to group a set of resources, such as customers, products, and accounts. Once a resource (i.e. product or customer) has been assigned to a you, it cannot be changed.

You can use this area to support and make changes for your customers. We can set you up with 2 admin users so that you can create users on demand for your customers. This gives you independence to manage your customers and allows you to make changes out of hours, at their request.

You can also create or onboard new users.

Createanewuser

1 ში ადმინ ჩანართი, დააწკაპუნეთ მომხმარებლები გასახსნელად მომხმარებლები საძიებო ეკრანი. 2 დააწკაპუნეთ + New User. The მომხმარებლის შექმნა ეკრანის ჩვენებები.

3 In მომხმარებლის შექმნა enter the user’s ელფოსტა, the following fields then display სახელი, გვარი და ტელეფონის ნომერი.

4 დააწკაპუნეთ სტატუსი და აირჩიეთ აქტიური.

The ტელეფონის ნომერი field must be a cellphone number as this will be used for MFA to authenticate the user.

ველის აღწერა

სახელი	User name. Enter the full user name to display in the browser window when the user logs into Explorer.
ელფოსტა	User email address. This address is used to log into Explorer and also serves as a recovery email for password resets.
სტატუსი	Select a user status. User status is არააქტიური by default. Change it to აქტიური when creating a user.
მომხმარებლის ტიპი	ეს ველი გამოჩნდება პარტნიორი when the user is created.
როლები	Select the roles to add to the user, or click Include All Roles to add all available roles to the user. შენიშვნა: Only the roles assigned to you will be visible. Some roles contain permissions which allow you to originate payments in Explorer. Your Explorer admins are responsible for making sure that your users are properly configured with only the appropriate user roles as well as authorized limits.

Authorized Limits

For each field , select a dollar limit (if applicable)

5 დააწკაპუნეთ სტატუსი და აირჩიეთ აქტიური.

6 დააწკაპუნეთ როლები and select the you want to assign the new user. Click შენახვა roles ცვლილებები.

ყველა users must be configured with the Partner Core Ready Only როლი.

If the user is assigned the Partner Wire Origination role you must configure that user’s origination limit.

7 If you’re assigning the user the Partner Wire Origination role, enter a value in the Wire.Payments.Originate field to indicate the maximum dollar limit per wire. Otherwise, you can ignore this field.

8 When you finish configuring all fields. Click ცვლილებების შენახვა.

9 If you have successfully created a new user, a confirmation screen displays.

10 To complete the addition and configuration of a user, a different admin must Approve Changes.

11 The Approve Pending Changes screen displays. Click დაადასტურეთ.

12 Viewმომხმარებლის ინფორმაცია

დოკუმენტები / რესურსები

Cross River API პლატფორმა [pdf] მომხმარებლის სახელმძღვანელო
API პლატფორმა, API პლატფორმა, პლატფორმა

ცნობები

მომხმარებლის სახელმძღვანელო

API პლატფორმა

დაიწყეთ

1. მოგესალმებით

Welcome to Cross River დოკუმენტაცია

2. სწრაფი დაწყება

2.1. Get API credentials

მნიშვნელოვანია

2.2. Get access token

CommandLineInterface

Sample request in cURL for COS

ფოსტალიონი

COSExplorer

Token request response

HTTP components

პრობლემების მოგვარება

2.3. Use access token

მნიშვნელოვანია

API requestheader

2.4. Webკაკვები

2.5. Sandbox environments

COS webკაკვები

დაკრედიტება

Loan origination

2.6. Postman collection

ფოსტალიონი

Postman workspace

3. Build a sampაპი

3.1. დაყენება

Explore sandbox

Register relevant web hook events

3.2. Customers and accounts

Webკაკვები

Webhook Description

Exampleof recordcreation

მნიშვნელოვანია

Update customer address

API credentials

მომხმარებლის ID

მნიშვნელოვანია

3.3. ბარათები

სანამ დაიწყებ

3.4. დაკრედიტება

Application decisioning

სვაგერი

სტატუსის გვერდი

4. პროგრამის დაყენება

4.1. Set up SFTP

UsingSFTP

Using encryption

დაიწყეთ

მნიშვნელოვანია

4.2. Customer onboarding

4.2.1. Customer record

მნიშვნელოვანია

Beneficial owners

Curl

4.2.2. COS product types and IDs

4.2.3. COS Explorer

Authenticator app setup

QRcode

სახელმძღვანელო

Recoverycodes

Use a recovery code

Accountlockout

Browsererror -Firewall

You are blocked by a firewall.

4.2.3.1. მომხმარებლის მენეჯმენტი

ველის აღწერა

Authorized Limits

დოკუმენტები / რესურსები

ცნობები

დატოვე კომენტარი

გააუქმეთ პასუხი