To create a card, you must supply a valid deposit account number along with other card-specific information. The initial card status of a newly submitted card is unactivated. When the card is successfully created the order status is OrderPending.

Endpoint: /cardmanagement/v1/cards

accountNumber

The unique Cross River ID assigned to a customer when the customer record is created. You need this ID to take action for a specific customer. For example, when opening an account or adding an address to a customer record.

The ID is in GUID format.

customerId

Unique ID for the card configuration profile the card is based on. You get this ID from Cross River. This ID is in GUID format.

configurationId

Cardholder first name
60 characters maximum

firstName

Cardholder middle name
60 characters maximum

middleName

Cardholder last name
60 characters maximum

lastName

Cardholder name suffix
60 characters maximum

suffix

Details of the cardholder phone contact information

phone

Cardholder email address
60 characters maximum

emailAddress

Address to which a physical card is shipped

shippingAddress

billingAddress

Cardholder name as it appears on the card

23 characters maximum

nameOnCard

If the card is connected to a business account, the company name
23 characters maximum

companyNameOnCard

How the card is shipped:
- Normal
- Expedited

shippingType

Use this attribute to add your own unique identifying string to a payment call or COS record. This attribute is useful for idempotency purposes.

50 characters maximum.

clientIdentifier

Identifier associated to the card design to use when overriding a program's default card design.

cardDesignId

GUID format card ID in the Cross River system, which is the id attribute value of the response to Create a card. This is not the number that appears on the card.

Product ID of the cardholder deposit account. This ID is in the GUID format. See also here.

productId

Your ID in the Cross River system. This ID is in GUID format.

partnerId

processorCardId

Deposit account number associated with the card

Card activation status:

- Unactivated
- Active
- Suspended
- Closed

status

Reason for the card status:

- NotSet
- Damaged
- Expired
- Lost
- FraudCompromised
- Return
- NewEnrollment
- Stolen
- AdminBlocked

statusReasonCode

Status of the card in the processor's system

processorCardStatus

birthDate

Address where the credit card bills are sent

Information about the cardholder's phone (type and number)

If defined, the name of the cardholder company

Last 4 digits of the PAN, the primary account number, which appears on the physical card

panLastFour

ID of the previous card if the current card is a replacement

previousCardId

True if the PIN number is set for the card, otherwise false.

isPinSet

expirationDate

True if the card has been blocked by the administrator, otherwise false. This block cannot be removed.

adminBlocked

True, if the card was blocked by the processor due to potential fraud, otherwise false.

fraudSuspect

Unique ID for the card configuration profile the card is based on. You get this ID from CR. This ID is in GUID format.

Type of card:

- Debit
- Credit
- Prepaid

paymentInstrument

The name of the card processor:

- i2c
- P1

processor

How the card is shipped:

- Normal
- Expedited

Status of the card order:

- OrderPending (0)
- Completed (1)
- Failed (2)
- Authorizing (3)
- AuthorizationFailed (4)
- AuthorizationCompleted (5)

orderStatus

Indicates whether the card is a replacement card and the status of the replacement:

- NotApplicable
- Pending
- Completed
- Failed

replacementStatus

The unique Cross RiverID assigned to a customer when the customer record is created. You need this ID to take action for a specific customer. For example, when opening an account or adding an address to a customer record.

The ID is in GUID format.

processorCustomerId

Date and time when the card was created. In this case, the date and time are in this format: yyyy-mm-ddThh:mm:ss[.mmm]

createdAt

Date and time when the card was suspended. If not suspended, null. In this case, the date and time are in this format: yyyy-mm-ddThh:mm:ss[.mmm]

suspendedAt

Date and time the card was closed. If not closed, null. In this case, the date and time are in this format: yyyy-mm-ddThh:mm:ss[.mmm]

closedAt

Date the card was activated. The time is set to midnight at the start of that day.

initialActivation

Exact date and time the card was activated. In this case, the date and time are in this format: yyyy-mm-ddThh:mm:ss[.mmm]

activatedAt

openedAt

Date and time the card record was last modified. Examples include change of name on the card and change in card status. In this case, the date and time are in this format: yyyy-mm-ddThh:mm:ss[.mmm]

lastModifiedAt

Create new card

Activate card by ID

Set initial PIN

Replace card by ID

Card details

Card details by ID

Transaction details

Get profile

Suspend card

Unsuspend card

Admin block

Close card

Simulate card auth

Simulate card clearing

Simulate card reversal

Simulate incremental

Simulate clearing

Simulate reversal

APIs

Webhook events

Request and response codes

Error codes

Cards

The automated lending platform from Cross River that includes services such as Preapproval, Oversight, Arix Origination and Funding, Selling, and Hooks.

Lending

Information that can be used to distinguish or trace an individual’s identity, either alone or when combined with other information that is linked or linkable to a specific individual. Also known as PII.

Personally_Identifiable_Information

These are contracts for monetary assets that can be purchased, traded, created, modified, or settled for. In terms of contracts, there is a contractual obligation between involved parties during a financial instrument transaction.

financial_instrument

Interest Rate Cards are pre-configured interest rate profiles that can be assigned to specific accounts on demand.

rate_card

A financial institution holding a principal license with a Card Network has the right to issue cards itself and sponsor other institutions (fintechs) to issue on its behalf (BIN sponsorship). Affiliate/Associate members cannot offer BIN sponsorship.

Principal_member

A 6 or 8 digit number assigned by the card networks for card issuing and functions as the first 6 or 8 digits on the card itself. The BIN identifies the bank that is responsible for issuing the program and handling daily settlement with the Network.

Card_BIN

A solution that allows partners to offer card solutions without requiring a direct relationship with the card networks. The bank acts as an intermediary while allowing partners to use its bank identification numbers (BIN). 

BIN_sponsorship

Politically Exposed Person is an individual who holds a prominent public position, or has done so in the recent past and is subject to a higher level of scrutiny due to an increased risk of involvement in bribery, corruption, and money laundering.

Office of Foreign Assets Control. Part of the US Department of the Treasury that administers and enforces economic and trade sanctions based on US foreign policy and national security goals.

OFAC

Move funds internally between accounts. The transfer requires both a debit and credit account and can be either a master account or sub-ledger, or any combination of the two.  Can be made via API calls or for non-API Partners on the COS Explorer.

book_transfer

This is where the financial institution verifies the member has the funds needed before they are transferred to the receiver.

Good_Funds_Model

An instant payment service developed and operated by the Federal Reserve for financial institutions in the United States, which allows individuals and businesses to send and receive money.

FedNow

A payment processing network used to send money electronically between banks in the US. Available year round, it transfers funds between 2 banks account instantaneously. Processes on bank holidays and weekend and after business hours.

A merchant category code (MCC) is a four-digit number used for retail financial services to classify a business by the types of goods or services it provides. Codes are specified by the ISO 18245 standard.

Card Acceptor ID. An internal identifier assigned to your business by your Acquirer when creating the merchant account used for financial processing.

CAID

Business Application Identifier, used by merchants in card payments

The automated loan validation and funding software from Cross River

Arix

Mobile Deposit Capture is the process of submitting a check electronically using a smartphone

Input Message Accountability Data. A unique number given to each FedWire payment when using the Federal Reserver Bank Service and can be used to investigate and track wire transfers.

IMAD

Notification of Change.  The purpose of an NOC is to identify and communicate incorrect information within an ACH entry, such as account numbers or transit and routing number. Sent by a RDFI to the ODFI and the Originator via their ACH Operator.

A global financial messaging standard for electronic payments. It enhances interoperability across financial systems, improves payment processing efficiency and supports compliance by providing detailed transaction information.

ISO20022

A SWIFT Code is a standard format of Bank Identifier Code (BIC) used to specify a particular bank or branch. These codes are used when transferring money between banks, particularly for international wire transfers.

SWIFT

Receiving Depository Financial Institution. All ODFIs must also agree to act as an RDFI to receive ACH payments. An RDFI receives entries directly or indirectly from its ACH Operator for debit or credit to the accounts of its customers.

RDFI

Originating Depository Financial Institution. It has the authority to initiate ACH transactions on behalf of its customers. ODFIs ensure compliance with regulatory standards and securely transmit payment instructions to the ACH network

ODFI

 National Automated Clearing House Association. Nacha governs the ACH Network, the payment system that drives Direct Deposits and Direct Payments with the capability to reach all U.S. bank and credit union accounts

Nacha

International ACH Transaction. A Nacha SEC code.

A uniquely configured financial product you offer your customers. For example, a debit card or a savings account, configured according to your needs and specifications, are product types.

product_type

Bank Identification Number. A unique identifier used in payment card transactions.

COS_Explorer

relationshipmanager

Cross River guides provide details about our products

guide

var_miha

new_var_2

new_mih_var

mih_var

This is a plain text that will be inserted in an expandable heading for using this raw as an exampl

testheight

available

testulet

testvar

altscenario

This is a plain text that will be inserted in an expandable heading for using this raw as an example