Create a new card

accountNumber

string

Cardholder deposit account number

Required  

customerId

string

Unique CR identifier for the account owner in GUID format.

Required  

configurationId

string

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

Required  

firstName

string

Cardholder first name

Required  

middleName

string

Cardholder middle name

Optional 

lastName

string

Cardholder last name

Required  

suffix

string

Cardholder name suffix

Optional 

phone

object

Details of the cardholder phone contact information:

phoneType string Phone number is for: Home Mobile Work Required

phoneNumber string Cardholder phone number. Must be ten digits with no spaces. Required

emailAddress

string

Cardholder email address

Optional 

shippingAddress

object

Address to which a physical card is shipped:

street1 string Primary location details of cardholder, for instance, street name, house/building number, PO box, etc. Maximum 255 characters. Required

street2 string Cardholder address 2 Required

city string Name of the cardholder's city Required

state string 2-letter code of the cardholder's state Required

postalCode string Cardholder's 5-digit US postal code. Required

countryCode string Cardholder country code - 2 digits Required

billingAddress

object

Address to send credit card bills:

street1 string Primary location details of cardholder, for instance, street name, house/building number, PO box, etc. Maximum 255 characters. Required

street2 string Cardholder address 2 Required

city string Name of the cardholder's city Required

state string 2-letter code of the cardholder's state Required

postalCode string Cardholder's 5-digit US postal code. Required

countryCode string Cardholder country code - 2 digits Required

nameOnCard

string

Cardholder name as it appears on the card

Required  

companyNameOnCard

string

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

Optional 

shippingType

string

How the card is shipped: Normal or Expedited

Required  

id

string

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

partnerId

string

Your ID in the CR system. This ID is in GUID format.

productId

string

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

processorCardId

string

Card processor's unique identifier

accountNumber

string

Deposit account number associated with the card

status

string

Card activation status:

• Unactivated

• Active

• Suspended

• Closed

statusReasonCode

string

Reason for the card status:

• NotSet

• Damaged

• Expired

• LostStolen

• FraudCompromised

• Return

• NewEnrollment

processorCardStatus

string

Status of the card in the processor's system

firstName

string

Cardholder first name

middleName

string

Cardholder middle name

lastName

string

Cardholder last name

suffix

string

Cardholder name suffix

birthDate

string

Cardholder birthdate

shippingAddress

object

Address where a physical card is sent

child attributes

street1 string Primary location details of cardholder, for instance, street name, house/building number, PO box, and so on. 60 characters maximum.

street2 string Additional field for address information

city string Name of the cardholder's city

state string Cardholder's 2-character state code

postalCode string Cardholder's US postal (ZIP) code

countryCode string Cardholder 2-character ISO country code

billingAddress

object

Address where the credit card bills are sent

child attributes

street1 string Primary location details of cardholder, for instance, street name, house/building number, PO box, and so on. 60 characters maximum.

street2 string Additional field for address information

city string Name of the cardholder's city

state string Cardholder's 2-character state code

postalCode string Cardholder's US postal (ZIP) code

countryCode string Cardholder 2-character ISO country code

phone

object

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

child attributes

phoneType string Phone number is for: Home Mobile Work

phoneNumber string Cardholder phone number. 10-15 digits, no spaces or other characters.

emailAddress

string

Cardholder email address

nameOnCard

string

Full cardholder name as written on card

companyNameOnCard

string

If defined, the name of the cardholder company

panLastFour

string

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

previousCardId

string

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

isPinSet

boolean

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

expirationDate

string

Card expiration date

adminBlocked

boolean

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

fraudSuspect

boolean

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

configurationId

string

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

category

string

Type of card:

• Debit

• Credit

• Prepaid

paymentInstrument

string

Card payment instrument type:

• PhysicalMSR

• PhysicalICC

• PhysicalContactless

• PhysicalCombo

• VirtualPan

processor

string

The name of the card processor

shippingType

string

How the card is shipped:

• Normal

• Expedited

orderStatus

string

Status of the card order:

• OrderPending (0)

• Completed (1)

• Failed (2)

• Authorizing (3)

• AuthorizationFailed (4)

• AuthorizationCompleted (5)

replacementStatus

string

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

• NotApplicable

• Pending

• Completed

• Failed

customerId

string

Unique CR identifier for the account owner in GUID format.

clientIdentifier

string

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

processorCustomerId

string

Processor's Unique ID for the cardholder

createdAt

string

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]

suspendedAt

string

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]

closedAt

string

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]

initialActivation

string

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

activatedAt

string

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]

openedAt

string

Null