OpenApi SpecContact Us
API Reference

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. [block:callout] { "type": "info", "body": "In the Sandbox environment cards will always be created with a cardNumberMasked value of 1111 and can be verified via /card/verify immediately." } [/block]

Body Params
int32
required
≥ 1
int32
required
≥ 1
string
enum
required
  • VS: Visa
  • MC: Mastercard
Allowed:
string
enum
  • DBT: Debit
  • GFT: Gift
  • GPR: General Purpose Prepaid
Allowed:
int32
required
≥ 1
string
required
length ≤ 64
string
length ≤ 64
string
required
length ≤ 128
string
required
length ≤ 50
string
length ≤ 50
string
length ≤ 3
int32
≥ 1
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.

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.

boolean
Defaults to true

true to order a physical card, false to waive.

int32
≥ 1

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

string
length ≤ 6

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

string
length ≤ 16

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

string
length ≤ 50

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

string
length ≤ 18

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

Responses

Updated 14 days ago

Language
Credentials
Basic
base64
:
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 14 days ago