Initiate a card

post

https://sandbox-api.helix.q2.com/card/initiate

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

🚧Warning
Sandbox environment only:
Cards will always be created with a cardNumberMasked value of 1111 and can be verified via /card/verify immediately.

Body Params

customerId

int32

required

≥ 1

cardHolderCustomerId

int32

required

≥ 1

vendorTypeCode

string

enum

required

VS: Visa
MC: Mastercard

Allowed:

typeCode

string

enum

DBT: Debit
GFT: Gift
GPR: General Purpose Prepaid

Allowed:

primaryAccountId

int32

required

≥ 1

firstName

string

required

length ≤ 64

middleName

string

length ≤ 64

lastName

string

required

length ≤ 128

nickName

string

required

length ≤ 50

tag

string

length ≤ 50

qualifierCode

string

length ≤ 3

binId

int32

≥ 1

newPin

string

For Shazam programs only. Visa DPS programs must call the /card/resetPin endpoint separately. For physical-only cards, /card/resetPin can be called once the card moves from status=Initiated to status=Verified. For dual-issuance cards (physical and digital), /card/resetPin can be called once the card moves from status=Initiated to status=DigitalActivePhysicalPending.

isCreateDualIssuanceSinglePAN

boolean

Defaults to false

true if this card will be an instant-issued debit card ready for eCommerce activity that can also be provisioned to a digital wallet. If true the card will be created with a status of DitalActivePhysicalInitiated which will shortly change to DigitalActivePhysicalPending. When card is in DigitalActivePhysicalInitiated or DigitalActivePhysicalPending it can be provisioned into a digital wallet via /card/provision/applePay or /card/provision/googlePay. When card is in DigitalActivePhysicalPending it will need to be verified via /card/verify before a customer can use the physical card.

isPhysicalCardOrdered

boolean

Defaults to true

true to order a physical card, false to waive.

requestingCustomerId

int32

≥ 1

The Helix-assigned unique ID for the customer requesting to create a new card for a business cardholder

cardCarrierMessage

string

length ≤ 6

Identifier used uniquely by various card production facilities for mapping card configurations

cardDesignIdentificationNumber

string

length ≤ 16

Identifier used uniquely by various card production facilities for mapping card configurations

cardVendorUniqueData

string

length ≤ 50

Identifier used uniquely by various card production facilities for mapping card configurations

photoImageId

string

length ≤ 18

Identifier used uniquely by various card production facilities for mapping card configurations

Responses

200An envelope whose data node is a card object

400Bad Request

401Unauthorized

404Not Found

405HTTP Method Not Allowed

429Rate Limit Exceeded