Add a card

POST /api/Card

Use this call to sign up a new card.

When you call POST /api/Card to sign up a card, P2C stores the debit card number and returns a token to you.
After signing the card up in P2C, the card token provided in the response is how you should identify the debit card in your API calls. The card token is the identifier you use between your system and Cross River.

Request attributes

AttributeDescription
RequestId
GUID
Unique customer generated request ID. This parameter corresponds to the RequestId in the response.
Required
firstName
string
Cardholder first name.
Required
lastName
string
Cardholder last name.
Required
sourceSenderId
string
Merchant ID.
Optional
ownerExternalId
string
4-digit code merchant assigns.
Optional
address1
string
Address line 1.
Optional
address2
string
Address line 2.
Optional
city
string
City.
Optional
state
string
2-digit State.
Optional
zipCode
string
Zip code.
Optional
phoneNumber
string
Phone number. No dashes required.
Optional
email
string
Email address.
Optional
creditCardNumber
string
Credit card number.
After you add a credit card to this API call, a token, representing the card number will be returned.
Required
expirationMonth
string
2-digit month.
Required
expirationYear
string
2-digit year. Must be a future year.
Required
cvv
string
3 or 4 digit code on the back or front of the card.
Optional

Sample request POST /api/Card

{
   "requestId":"49af65c0-f815-4f49-ba8d-b67bf1b125f4",
   "firstName":"Damian",
   "lastName":"Colvin",
   "sourceSenderId": "49af65c0-f815-4f49-ba8d-b67bf1j7v5f4",
   "ownerExternalId":"4444",
   "address1":"430 Mary Rue",
   "address2": "Apt 864",
   "city":"Sunrise Beach",
   "state":"MO",
   "zipCode":"65079",
   "phoneNumber":"2124441212",
   "email":"[email protected]",
   "creditCardNumber":"REPLACE WITH CARD NUMBER",
   "expirationMonth":"08",
   "expirationYear":"25",
   "cvv":"420"
}

Response attributes

AttributeDescription
RequestId
GUID
This parameter corresponds to the RequestId in the request.
cardToken
string
Token for the signed-up debit card.
firstName
string
Cardholder first name.
lastName
string
Cardholder last name.
ownerExternalId
string
4-digit code merchant assigns.
address1
string
Address line 1.
address2
string
Address line 2.
city
string
City.
zipCode
string
Zip code.
isAuthorizationSucceeded
boolean
True if card was authorized successfully, otherwise false.
state
string
2-digit State.
countryCode
string
2 letter country code.
phoneNumber
string
Phone number.
email
string
Email address.
expirationYear
string
2-digit year. Must be a future year.
expirationMonth
string
2-digit month.
last4Digits
string
Last 4-digits of the credit card number.
cardCompany
string
Card network.
- Visa
- Mastercard
- ET
- PULSE
- STAR
- NYCE
- Accel
- RPPS
- MoneySend
isActive
boolean
True if the card is active, otherwise false.
deactivatedAt
string
Date and time the card was deactivated, if relevant.
addedOn
string
Date and time the card was added.
authorizationJson
string
The JSON authorization response received for this card.
isFastFundsSupported
boolean
Fast funds are immediate payments.
True if fast funds is supported, otherwise false.
rail
string
The processor used to perform the transaction
- RS2
- McSend
- TabaPay
pushEnabled
boolean
True if push transactions are enabled for this card, otherwise false.
pullEnabled
boolean
True if pull transactions are enabled for this card, otherwise false.
issuerCountryCode
string
2 or 3 digit Country-code for the card issuer. Can include all characters.
binNumber
string
The first set of numbers on a credit card that identifies the card issuer.

Sample response POST /api/Card

After you added the card number with the call above, a card token is returned in its place.

{
  "requestId": "49af65c0-f815-4f49-ba8d-b67bf1b125f4",
  "cardToken": "xh7alh99sxn7b5v",
  "firstName": "Damian",
  "lastName": "Colvin",
  "ownerExternalId": "4444",
  "address1": "430 Mary Rue",
  "address2": "Apt 864",
  "city": "Sunrise Beach",
  "zipCode": "65079",
  "isAuthorizationSucceeded": true,
  "state": "MO",
  "countryCode": "US",
  "phoneNumber": "212-444-1212",
  "email": "[email protected]",
  "expirationYear": "25",
  "expirationMonth": "08",
  "last4Digits": "5490",
  "cardCompany": "visa",
  "isActive": true,
  "deactivatedAt": "2022-07-05T13:52:51.109Z",
  "addedOn": "2022-07-05T13:52:51.109Z",
  "authorizationJson": "string",
  "isFastFundsSupported": true,
  "rail": "RS2",
  "pushEnabled": true,
  "pullEnabled": true,
  "issuerCountryCode": "US",
  "binNumber": "string"
}