Initiate a card

Initiate a request to create a new card and mail it to a customer. See card object definition for parameter details.

📘

In the Sandbox environment cards will always be created with a cardNumberMasked value of 1111 and can be verified via /card/verify immediately.

Error Codes

Click to expand
CodeMessage (en-US)Notes
1-60000Any "Common Error Code" may occur.See Common Error Codes
63502Requesting customer does not have 'FULL' access to account id ’42031914'.
150201TypeCode {request.typeCode} is not valid. Must be "DBT" or "CDT".
150202VendorTypeCode {request.vendorTypeCode} is not valid. Must be "VS" or "MC".
150203NameOnCard is a required field.
150204Tag {request.tag} is already associated with another card.
150205Invalid Card Holder CustomerId {request.cardHolderCustomerid}.
150206Assigned Customer {request.cardHolderCustomerid} status is '{customer.status}.' Must be 'Initiated,' 'Manual Review,' or 'Verified'.
150208Invalid Primary AccountId {request.primaryAccountId}.
150209Primary AccountId {request.primaryAccountId} is in invalid status of {1}. Must be Open or PendingOpen.
150210Primary AccountId {request.primaryAccountId} must be a Checking or Savings account.
150211Insufficient access type {account.accessTypeCode} for CustomerId {request.cutomerid} to Primary AccountId {request.primaryAccountId} to add a card. FULL is required.
150212A Primary Account must be specified.
150213Both FirstName and LastName are required.
150230Another card for CustomerId {request.customerId} is using NickName of {request.nickName}. NickName must be unique.
150231The primary customer {request.customerId} must have its Mobile or Home phone specified prior to creating a card.
150232The primary customer {request.customerId} must have its Mailing or Residence address specified prior to creating a card.
150240FirstName ({request.firstName}) contains invalid characters. Refer to API documentation for valid characters.For programs using Shazam
150241MiddleName ({request.middleName}) contains invalid characters. Refer to API documentation for valid characters.For programs using Shazam
150242LastName ({request.lastName}) contains invalid characters. Refer to API documentation for valid characters.For programs using Shazam
150243Card Bin {request.binId} is not valid.
150244Program id {0} requires BankBinId to be specified.
150245Program id {0} does not have a valid bin set up.
150246FirstName ({request.firstName}) contains invalid characters. Refer to API documentation for valid characters.For programs using Visa DPS
150247MiddleName ({request.middleName}) contains invalid characters. Refer to API documentation for valid characters.For programs using Visa DPS
150248LastName ({request.lastName}) contains invalid characters. Refer to API documentation for valid characters.For programs using Visa DPS
150249Invalid value set for the IsPhysicalCardOrdered, value must be true to order physical card
201001Customer mailing address {0} cannot contain a PO Box.
201000Customer mailing address not available
Language
Credentials
Basic
base64
:
URL
Click Try It! to start a request and see the response here!