Verify a card

post https://sandbox-api.helix.q2.com/card/verify

Verify a customer has received a physical card and activate it for use.

Error Codes

Click to expand

Code	Message (en-US)	Notes
1-60000	Any "Common Error Code" may occur.	See Common Error Codes
150301	Invalid CardId {0} or CustomerId {1} is not associated with the card.
150302	CardId {0} must be in a PendingVerification status to be verified. Current status is {1}.
150303	Provided values do not match those on file.
150502	CardId {0} has been locked by an Administrator or an automated process.

Responses

`status=Verified`

Response body

object

errors

array

errors

requestId

string

status

integer

200

throttle

object

periodEndsAt

date-time

periodLengthInSeconds

int32

≥ 1

periodRequestLimit

int32

≥ 1

requestsRemainingInPeriod

int32

≥ 1

warningThreshold

number

data

object

accounts

array of objects

accounts

object

accountBalance

number

accountId

int32

≥ 1

accountNumberMasked

string

availableBalance

number

balanceLastModifiedDate

date-time

cardPriority

int32

1 to 4

customerId

int32

≥ 1

lastModifiedDate

date-time

name

string

pendingBalance

number

status

string

Open Closed PendingOpen PendingClosed

tag

string

length ≤ 50

type

string

Checking Savings ForBenefitOf Prepaid Time Deposit Business Checking Business Savings

archivedDate

date-time

binId

int32

≥ 1

cardHolderCustomerId

int32

≥ 1

cardId

int32

≥ 1

cardNumberMasked

string

createdDate

date-time

customerId

int32

≥ 1

deniedDate

date-time

digitalWalletTokens

array of objects

digitalWalletTokens

object

device

object

isDeviceProvisioned

boolean

panReferenceId

string

token

string

tokenReferenceId

string

tokenRequestorId

string

40010030273 40010075001 40010043095 40010075338

tokenRequestorName

string

ApplePay GooglePay SamsungPay VisaCheckout

tokenStatus

string

ActiveForPayment Initiated SuspendedTemporarily DeactivatedPermanently

tokenType

string

Card on file Secure element Cloud based payment/HCE E-Commerce Enabler

walletInformation

object

expireMonth

integer

1 to 12

expireYear

integer

1900 to 9999

expiredDate

date-time

firstName

string

isDigitalOnly

boolean

isDualIssuanceSinglePAN

boolean

lastModifiedDate

date-time

lastName

string

lockReasonTypeCode

string

UNK STL LST FRD DMG ADM TMP PIN

lockTypeCode

string

UNL CST SYS

middleName

string

nameOnCard

string

nickName

string

preferredName

string

primaryAccountId

int32

≥ 1

qualifierCode

string

length ≤ 3

reissuedDate

date-time

renewalOverride

string

Renew DoNotRenew

renewalOverrideReason

string

requestedDate

date-time

status

string

Initiated Pending PendingVerification Verified Denied Expired Archived Reissued Hotlisted ReissuedPendingVerification AutoReissuedPendingVerification

tag

string

length ≤ 50

typeCode

string

DBT

vendorTypeCode

string

VS: Visa
MC: Mastercard

VS MC

verifiedDate

date-time

Language

Credentials

Basic

base64

URL


xxxxxxxxxx
1
curl --request POST \
2
     --url https://sandbox-api.helix.q2.com/card/verify \
3
     --header 'accept: application/json' \
4
     --header 'content-type: application/json'

Click Try It! to start a request and see the response here! Or choose an example:

application/json

Error Codes

200A card object with status=Verified

400Bad Request

401Unauthorized

404Not Found

405HTTP Method Not Allowed

429Rate Limit Exceeded

`status=Verified`