Card management APIs

requestId

string

Required  

The GUID that enables the application to link request with response

firstName

string

Required  

Cardholder first name

lastName

string

Required  

Cardholder last name

sourceSenderId

string

Required  

The GUID that identifies the merchant partner

ownerExternalId

string

Optional 

A 4-digit code, assigned by the merchant, to identify the cardholder

address1

string

Optional 

Primary location details of cardholder. For instance, street name, house or building number, and PO box. Maximum 255 characters.

address2

string

Optional 

Secondary location details of cardholder. For instance, number of apartment or floor. Maximum 255 characters.

city

string

Optional 

Name of the cardholder's city

countryCode

string

Optional 

2-letter country code

state

string

Optional 

2-letter code of the cardholder's state

zipCode

string

Optional 

Cardholder's 5-digit US postal code.

phoneNumber

string

Optional 

Cardholder's phone number; 10 digits, for instance, 2015551234 (no dashes)

email

string

Optional 

A valid cardholder email address, for example, me@mailprovider.com

creditCardNumber

string

Required  

The 15- or 16-digit number found on the front or back of a credit card

expirationMonth

string

Required  

Card expiration month, 2-digits, numeric

expirationYear

string

Required  

Card expiration year, 2-digits, numeric

requestId

string

The GUID that enables the application to link request with response

cardToken

string

A randomly generated string of characters that relates to the consumer's payment card (15 to 38 alphanumeric characters). Matches the creditCardToken.

firstName

string

Cardholder first name

lastName

string

Cardholder last name

ownerExternalId

string

A 4-digit code, assigned by the merchant, to identify the cardholder

address1

string

Primary location details of cardholder. For instance, street name, house or building number, and PO box. Maximum 255 characters.

address2

string

Secondary location details of cardholder. For instance, number of apartment or floor. Maximum 255 characters.

city

string

Name of the cardholder's city

zipCode

string

Cardholder's 5-digit US postal code.

isAuthorizationSucceeded

boolean

True if the card was authorized successfully, otherwise false

state

string

2-letter code of the cardholder's state

countryCode

string

2-letter country code

phoneNumber

string

Cardholder's phone number; 10 digits, for instance, 2015551234 (no dashes)

email

string

A valid cardholder email address, for example, me@mailprovider.com

expirationYear

string

Card expiration year, 2-digits, numeric

expirationMonth

string

Card expiration month, 2-digits, numeric

last4Digits

string

Last 4 digits of the payment card number

cardCompany

string

Name of the payment card network:

1. Visa

2. Mastercard

isActive

boolean

True if the card is active, otherwise false

deactivatedAt

string

Date and time card was deactivated, if relevant, in date-time format

addedOn

string

The date and time the card was added to the merchant's account

authorizationJson

string

The JSON authorization response received for this card from the card payments API

child attributes

requestId string The GUID that enables the application to link request with response

authorized boolean Determines whether a card is authorized for any financial activity by the Cross River/card network and issuing bank

responseReceived boolean True if P2C received a response from the external processor, otherwise false

responseCode string A 2-digit code signifying the transaction result (approved or decline). For example, 00 means successful.

ResponseDescription string A string describing the transaction result. For example, Approved.

Timestamp string The actual time the request was sent to the card networks

Error string A code value returned if the network call fails

AddressVerified boolean The result of the check by the address verification service (AVS).

rail string The processor that communicates with the card network: McSend TabaPay VisaDirect Note CR will deprecate this attribute in Q1 2024.

CardType string The kind of payment card: Credit Debit Prepaid Combo ChargeCard DeferredDebit

isFastFundsSupported boolean Fast funds are immediate payments. True if fast funds is supported, otherwise false.

pushEnabled boolean True if push payment to card is enabled, otherwise false

pullEnabled boolean True if pull payment from card is enabled, otherwise false

issuerCountryCode string A 2-letter code indicating the country where the card was issued

nameVerificationUsed string Indicates if Cross River tried to contact the account name inquiry (ANI) service: Used Not used Not supported If the merchant isn't configured for the ANI service, this response lets you know. In that case, contact your Cross River relationship manager for information on connecting to ANI.

nameVerificationResult string This is the result of the account name inquiry (ANI) service check: Full match Partial match No match Unknown

binNumber

string

The first 6-to-8 digits on the card. This identification number indicates the card-issuing bank.