openapi: 3.2.0
info:
title: Helix Card API
version: 3.0.0
description: Helix Public API (no customer KYC/IDV). **This spec covers all of Helix 3.x and is subject to change at any time.**
servers:
- url: https://sandbox-api.helix.q2.com
description: Sandbox server
- url: https://api.helix.q2.com
description: Production server
security:
- basicAuth: []
tags:
- name: Card
description: Endpoints for the card object
paths:
/card/addAccount:
post:
tags:
- Card
summary: Add an account to a card
description: Add an account to a card. Can be reversed by calling /card/removeAccount. The `customerId` attempting to add the account must have an `accessTypeCode` of `FULL` to that account and the customer itself must have an `accessTypeCode` of `FULL` or `ACCT`.
externalDocs:
url: https://docs.helix.q2.com/reference/cardaddaccount
operationId: cardAddAccount
requestBody:
required: true
content:
application/json:
schema:
type: object
required:
- customerId
- cardId
- accountId
- cardPriority
properties:
customerId:
$ref: '#/components/schemas/HelixId'
cardId:
$ref: '#/components/schemas/HelixId'
accountId:
$ref: '#/components/schemas/HelixId'
cardPriority:
allOf:
- description: Priority the `accountId` will have. Must be between `1` and `4` inclusive. If this matches the priority of an existing account, that account's priority will be slid down one slot (as will all other lower priority accounts as needed)
- type: integer
format: int32
minimum: 1
maximum: 4
responses:
'200':
description: An envelope whose data node is a card object
content:
application/json:
schema:
$ref: '#/components/schemas/CardObject200Response'
'400':
$ref: '#/paths/~1card~1lock/post/responses/400'
'401':
$ref: '#/paths/~1card~1lock/post/responses/401'
'404':
$ref: '#/paths/~1card~1lock/post/responses/404'
'405':
$ref: '#/paths/~1card~1lock/post/responses/405'
'429':
$ref: '#/paths/~1card~1lock/post/responses/429'
/card/archive:
post:
tags:
- Card
summary: Archive a card
description: Archive a card by the Helix-assigned `cardId`.
operationId: cardArchive
requestBody:
required: true
content:
application/json:
schema:
type: object
required:
- customerId
- cardId
properties:
customerId:
$ref: '#/paths/~1card~1verify/post/requestBody/content/application~1json/schema/properties/cardId'
cardId:
$ref: '#/paths/~1card~1verify/post/requestBody/content/application~1json/schema/properties/cardId'
responses:
'200':
description: An envelope whose data node is a card object
content:
application/json:
schema:
$ref: '#/components/schemas/CardArchive200Response'
'400':
$ref: '#/paths/~1card~1verify/post/responses/400'
'401':
$ref: '#/paths/~1card~1verify/post/responses/401'
'404':
$ref: '#/paths/~1card~1verify/post/responses/404'
'405':
$ref: '#/paths/~1card~1verify/post/responses/405'
'429':
$ref: '#/paths/~1card~1verify/post/responses/429'
/card/createDigital:
post:
tags:
- Card
summary: Create a digital card
description: Create a new card in `Verified` status that is instantly available for use in mobile wallets. Cards created through this endpoint will have `isDigitalOnly` property set to `true` whenever retrieved via the `/card/get` or `/card/list` endpoints. This type of card will not have a physical card shipped to the customer. See card object definition for parameter details.
externalDocs:
url: https://docs.helix.q2.com/reference/cardcreatedigital
operationId: cardCreateDigital
requestBody:
required: true
content:
application/json:
schema:
type: object
required:
- customerId
- cardHolderCustomerId
- vendorTypeCode
- primaryAccountId
- firstName
- lastName
- nickName
properties:
customerId:
$ref: '#/components/schemas/HelixId'
cardHolderCustomerId:
$ref: '#/components/schemas/HelixId'
vendorTypeCode:
$ref: '#/components/schemas/CardVendorTypeCode'
typeCode:
$ref: '#/components/schemas/CardTypeCode'
primaryAccountId:
$ref: '#/components/schemas/HelixId'
firstName:
type: string
maxLength: 64
middleName:
type: string
maxLength: 64
lastName:
type: string
maxLength: 128
nickName:
type: string
maxLength: 50
tag:
$ref: '#/components/schemas/TagProperty'
qualifierCode:
$ref: '#/components/schemas/CardQualifierCode'
binId:
$ref: '#/components/schemas/HelixId'
requestingCustomerId:
allOf:
- description: The helix-assigned unique ID for the customer requesting to create a new virtual card for a business cardholder
- $ref: '#/components/schemas/HelixId'
responses:
'200':
description: An envelope whose data node is a card object
content:
application/json:
schema:
$ref: '#/components/schemas/CardCreateDigital200Response'
'400':
$ref: '#/paths/~1card~1lock/post/responses/400'
'401':
$ref: '#/paths/~1card~1lock/post/responses/401'
'404':
$ref: '#/paths/~1card~1lock/post/responses/404'
'405':
$ref: '#/paths/~1card~1lock/post/responses/405'
'429':
$ref: '#/paths/~1card~1lock/post/responses/429'
/card/get/{customerId}/{cardId}:
get:
tags:
- Card
summary: Get a card
description: Retrieve card information by the given `customerId` and `cardId`.
externalDocs:
url: https://docs.helix.q2.com/reference/cardget
operationId: cardGet
parameters:
- $ref: '#/components/parameters/CustomerIdPath'
- name: cardId
in: path
required: true
schema:
$ref: '#/components/schemas/HelixId'
responses:
'200':
description: A card object
content:
application/json:
schema:
$ref: '#/components/schemas/CardObject200Response'
'400':
$ref: '#/paths/~1card~1lock/post/responses/400'
'401':
$ref: '#/paths/~1card~1lock/post/responses/401'
'404':
$ref: '#/paths/~1card~1lock/post/responses/404'
'405':
$ref: '#/paths/~1card~1lock/post/responses/405'
'429':
$ref: '#/paths/~1card~1lock/post/responses/429'
/card/getByTag/{customerId}/{tag}:
get:
tags:
- Card
summary: Get a card via tag
description: Retrieve card information by the given `customerId` and `tag`.
externalDocs:
url: https://docs.helix.q2.com/reference/cardgetbytag
operationId: cardGetByTag
parameters:
- $ref: '#/paths/~1card~1list~1{customerId}/get/parameters/0'
- name: tag
in: path
required: true
schema:
$ref: '#/paths/~1card~1initiate/post/requestBody/content/application~1json/schema/properties/tag'
responses:
'200':
description: An envelope whose data node is a card object
content:
application/json:
schema:
$ref: '#/components/schemas/CardObject200Response'
'400':
$ref: '#/paths/~1card~1verify/post/responses/400'
'401':
$ref: '#/paths/~1card~1verify/post/responses/401'
'404':
$ref: '#/paths/~1card~1verify/post/responses/404'
'405':
$ref: '#/paths/~1card~1verify/post/responses/405'
'429':
$ref: '#/paths/~1card~1verify/post/responses/429'
/card/hotlist:
post:
tags:
- Card
summary: Hotlist (permanently lock) a card
description: Permanently locks a card and sets `lockTypeCode=CST`.
externalDocs:
url: https://docs.helix.q2.com/reference/cardhotlist
operationId: cardHotlist
requestBody:
required: true
content:
application/json:
schema:
type: object
required:
- customerId
- cardId
- lockReasonTypeCode
properties:
customerId:
$ref: '#/paths/~1card~1verify/post/requestBody/content/application~1json/schema/properties/cardId'
cardId:
$ref: '#/paths/~1card~1verify/post/requestBody/content/application~1json/schema/properties/cardId'
lockReasonTypeCode:
type: string
enum:
- ATL
- DEC
- DES
- ESC
- FRD
- LST
- STA
- STL
- UPG
- VOD
description: '- `ACL`: AccountClosure
- `DEC`: Deceased
- `DES`: Destroyed
- `ESC`: Escheatment
- `FRD`: Fraud
- `LST`: Lost
- `STA`: Stale
- `STL`: Stolen
- `UPG`: DueToUpgrade
- `VOD`: Voided
'
responses:
'200':
description: An envelope whose data node is a card object
content:
application/json:
schema:
$ref: '#/components/schemas/CardObject200Response'
'400':
$ref: '#/paths/~1card~1verify/post/responses/400'
'401':
$ref: '#/paths/~1card~1verify/post/responses/401'
'404':
$ref: '#/paths/~1card~1verify/post/responses/404'
'405':
$ref: '#/paths/~1card~1verify/post/responses/405'
'429':
$ref: '#/paths/~1card~1verify/post/responses/429'
/card/initiate:
post:
tags:
- Card
summary: Initiate a card
description: Initiate a request to create a new card and mail it to a customer. See card object definition for parameter details.
externalDocs:
url: https://docs.helix.q2.com/reference/cardinitiate
operationId: cardInitiate
requestBody:
required: true
content:
application/json:
schema:
type: object
required:
- customerId
- cardHolderCustomerId
- vendorTypeCode
- primaryAccountId
- firstName
- lastName
- nickName
properties:
customerId:
$ref: '#/paths/~1card~1verify/post/requestBody/content/application~1json/schema/properties/cardId'
cardHolderCustomerId:
$ref: '#/paths/~1card~1verify/post/requestBody/content/application~1json/schema/properties/cardId'
vendorTypeCode:
type: string
enum:
- VS
- MC
description: '- `VS`: Visa
- `MC`: Mastercard
'
typeCode:
type: string
enum:
- DBT
- GFT
- GPR
description: '- `DBT`: Debit
- `GFT`: Gift
- `GPR`: General Purpose Prepaid
'
primaryAccountId:
$ref: '#/paths/~1card~1verify/post/requestBody/content/application~1json/schema/properties/cardId'
firstName:
type: string
maxLength: 64
middleName:
type: string
maxLength: 64
lastName:
type: string
maxLength: 128
nickName:
type: string
maxLength: 50
tag:
type: string
maxLength: 50
qualifierCode:
$ref: '#/paths/~1card~1reissue/post/requestBody/content/application~1json/schema/properties/qualifierCode'
binId:
$ref: '#/paths/~1card~1verify/post/requestBody/content/application~1json/schema/properties/cardId'
newPin:
type: string
format: byte
description: For Shazam programs only. Visa DPS programs must call the [/card/resetPin](https://docs.helix.q2.com/reference/cardresetpin) 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:
type: boolean
default: false
description: '`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](https://docs.helix.q2.com/reference/cardprovisionapplepay) or [/card/provision/googlePay](https://docs.helix.q2.com/reference/cardprovisiongooglepay). When card is in `DigitalActivePhysicalPending` it will need to be verified via [/card/verify](https://docs.helix.q2.com/reference/cardverify) before a customer can use the physical card.
'
isPhysicalCardOrdered:
type: boolean
default: true
description: "`true` to order a physical card, `false` to waive. \n"
requestingCustomerId:
allOf:
- description: The Helix-assigned unique ID for the customer requesting to create a new card for a business cardholder
- $ref: '#/paths/~1card~1verify/post/requestBody/content/application~1json/schema/properties/cardId'
cardCarrierMessage:
type: string
maxLength: 6
description: Identifier used uniquely by various card production facilities for mapping card configurations
cardDesignIdentificationNumber:
type: string
maxLength: 16
description: Identifier used uniquely by various card production facilities for mapping card configurations
cardVendorUniqueData:
type: string
maxLength: 50
description: Identifier used uniquely by various card production facilities for mapping card configurations
photoImageId:
type: string
maxLength: 18
description: Identifier used uniquely by various card production facilities for mapping card configurations
expediteCard:
type: boolean
description: Card order indicator to have physical card expedited by the card print vendor.
bypassExpediteCardFee:
type: boolean
description: Identifier to allow program to waive any program fee for expedited card request.
waiveFee:
type: boolean
description: When true, the applicable card creation fee is waived rather than charged to the customer. When omitted or false, existing fee behavior is unchanged.
responses:
'200':
description: An envelope whose data node is a card object
content:
application/json:
schema:
$ref: '#/components/schemas/CardObject200Response'
'400':
$ref: '#/paths/~1card~1verify/post/responses/400'
'401':
$ref: '#/paths/~1card~1verify/post/responses/401'
'404':
$ref: '#/paths/~1card~1verify/post/responses/404'
'405':
$ref: '#/paths/~1card~1verify/post/responses/405'
'429':
$ref: '#/paths/~1card~1verify/post/responses/429'
/card/list/{customerId}:
get:
tags:
- Card
summary: List cards
description: Retrieve all card information for the given `customerId`.
externalDocs:
url: https://docs.helix.q2.com/reference/cardlist
operationId: cardList
parameters:
- name: customerId
in: path
required: true
schema:
$ref: '#/paths/~1card~1verify/post/requestBody/content/application~1json/schema/properties/cardId'
- name: status
in: query
required: false
schema:
type: string
enum:
- Default
- All
- Archived
- Denied
- Expired
- Hotlisted
- Initiated
- Pending
- PendingVerification
- Reissued
- ReissuedPendingVerification
- AutoReissuedPendingVerification
- Verified
default: Default
description: Specify a single card status to be returned. Only one value can be passed. `Default` includes `Archived`, `Denied`, `Expired`, `Hotlisted`, `Initiated`, `Pending`, `PendingVerification`, `Reissued`, `ReissuedPendingVerification`, `AutoReissuedPendingVerification` and `Verified`
responses:
'200':
description: An array of card objects
content:
application/json:
schema:
$ref: '#/components/schemas/CardArray200Response'
'400':
$ref: '#/paths/~1card~1verify/post/responses/400'
'401':
$ref: '#/paths/~1card~1verify/post/responses/401'
'404':
$ref: '#/paths/~1card~1verify/post/responses/404'
'405':
$ref: '#/paths/~1card~1verify/post/responses/405'
'429':
$ref: '#/paths/~1card~1verify/post/responses/429'
/card/lock:
post:
tags:
- Card
summary: Lock a card
description: Lock a card. Most locks can be reversed by calling /card/unlock. Please check the /card/unlock documentation to see which lock scenarios can be subsequently unlocked. Will apply a `lockTypeCode` of `CST` on success and all card-based transactions will fail.
externalDocs:
url: https://docs.helix.q2.com/reference/cardlock
operationId: cardLock
requestBody:
required: true
content:
application/json:
schema:
type: object
required:
- customerId
- cardId
- lockReasonTypeCode
properties:
customerId:
$ref: '#/components/schemas/HelixId'
cardId:
$ref: '#/components/schemas/HelixId'
lockReasonTypeCode:
type: string
enum:
- UNK
- FRD
- DMG
- TMP
description: '- `UNK`: Unknown
- `FRD`: Fraud
- `DMG`: Physical Damage
- `TMP`: Temporary
'
responses:
'200':
description: An envelope whose data node is a card object
content:
application/json:
schema:
$ref: '#/components/schemas/CardObject200Response'
'400':
description: Bad Request
content:
application/json:
schema:
type: object
properties:
errors:
type: array
items:
type: object
properties:
code:
$ref: '#/components/schemas/HelixId'
message:
type: string
requestId:
type: string
example: b75a96f8-2fbc-4b14-9ba4-7b06aa431c9d
status:
type: integer
enum:
- 400
'401':
description: Unauthorized
content:
application/json:
schema:
type: object
properties:
errors:
type: array
items:
type: object
properties:
code:
type: integer
enum:
- 50401
message:
type: string
example: User is not authorized
requestId:
type: string
enum:
- 00000000-0000-0000-0000-000000000000
status:
type: integer
enum:
- 401
'404':
description: Not Found
content:
application/json:
schema:
type: object
properties:
errors:
type: array
items:
type: object
properties:
code:
type: integer
enum:
- 50404
message:
type: string
example: The requested resource 'https://sandbox-api.helix.q2.com/customer/updat/805592' was not found
requestId:
type: string
example: b75a96f8-2fbc-4b14-9ba4-7b06aa431c9d
status:
type: integer
enum:
- 404
'405':
description: HTTP Method Not Allowed
content:
application/json:
schema:
type: object
properties:
errors:
type: array
items:
type: object
properties:
code:
type: integer
enum:
- 50405
message:
type: string
example: The HTTP method 'POST' for requested resource 'https://sandbox-api.helix.q2.com/customer/get/805594' is not allowed.
requestId:
type: string
enum:
- 00000000-0000-0000-0000-000000000000
status:
type: integer
enum:
- 405
'429':
description: Rate Limit Exceeded
content:
application/json:
schema:
type: object
properties:
errors:
type: array
items:
type: object
properties:
code:
type: integer
enum:
- 50429
message:
type: string
example: Rate limit exceeded
requestId:
type: string
enum:
- 00000000-0000-0000-0000-000000000000
status:
type: integer
enum:
- 429
/card/orderPhysical:
post:
tags:
- Card
summary: Order a physical card
description: Order a physical card for an existing digital card with single PAN dual issuance.
externalDocs:
url: https://docs.helix.q2.com/reference/cardorderphysical
operationId: cardOrderPhysical
requestBody:
required: true
content:
application/json:
schema:
type: object
required:
- customerId
- cardId
properties:
customerId:
$ref: '#/components/schemas/HelixId'
cardId:
$ref: '#/components/schemas/HelixId'
requestingCustomerId:
allOf:
- description: The helix-assigned unique ID for the customer requesting to create a physical card for a virtual card held by a business cardholder
- $ref: '#/components/schemas/HelixId'
waiveFee:
type: boolean
description: When true, the applicable card creation fee is waived rather than charged to the customer. When omitted or false, existing fee behavior is unchanged.
responses:
'200':
description: An envelope whose data node is a card object
content:
application/json:
schema:
$ref: '#/components/schemas/CardObject200Response'
'400':
$ref: '#/paths/~1card~1lock/post/responses/400'
'401':
$ref: '#/paths/~1card~1lock/post/responses/401'
'404':
$ref: '#/paths/~1card~1lock/post/responses/404'
'405':
$ref: '#/paths/~1card~1lock/post/responses/405'
'429':
$ref: '#/paths/~1card~1lock/post/responses/429'
/card/reissue:
post:
tags:
- Card
summary: Reissue a card
description: Reissue a card due to damage, loss, theft, fraud, compromise, name change, or renewal.
externalDocs:
url: https://docs.helix.q2.com/reference/cardreissue
operationId: cardReissue
requestBody:
required: true
content:
application/json:
schema:
type: object
required:
- customerId
- cardId
- reissueReasonTypeCode
properties:
customerId:
$ref: '#/paths/~1card~1verify/post/requestBody/content/application~1json/schema/properties/cardId'
cardId:
$ref: '#/paths/~1card~1verify/post/requestBody/content/application~1json/schema/properties/cardId'
reissueReasonTypeCode:
type: string
enum:
- CMP
- DMG
- FRD
- LST
- NAM
- NCN
- REN
- RPL
- STL
description: '- `CMP`: Compromised
- `DMG`: Physical Damage
- `FRD`: Fraud
- `LST`: Lost
- `NAM`: Name Change
- `NCN`: Name Change with New PAN
- `REN`: Renewal
- `RPL`: Replacement
- `STL`: Stolen
''
'
newPin:
type: string
format: byte
description: See the `newPin` attribute on the card object definition for details.
qualifierCode:
type: string
maxLength: 3
tag:
allOf:
- description: Tag to associate with the new cardId
- $ref: '#/paths/~1card~1initiate/post/requestBody/content/application~1json/schema/properties/tag'
requestingCustomerId:
allOf:
- description: The helix-assigned unique ID for the customer requesting to reissue an existing card for a business cardholder
- $ref: '#/paths/~1card~1verify/post/requestBody/content/application~1json/schema/properties/cardId'
expediteCard:
type: boolean
description: Set to `true` to request expedited physical-card delivery, when the program supports expedited card orders.
byPassExpediteCardFee:
type: boolean
description: Set to `true` when the program, rather than the customer, should pay the expedited card fee.
photoImageId:
type: string
maxLength: 18
description: Optional card-production identifier.
cardDesignIdentificationNumber:
type: string
maxLength: 16
description: Optional card-production identifier.
cardCarrierMessage:
type: string
maxLength: 6
description: Optional card-production identifier.
cardVendorUniqueData:
type: string
maxLength: 50
description: Optional card-production identifier.
responses:
'200':
description: An envelope whose data node is a card object. If card-maintenance fees were applied, data.fees contains one item for each applied fee. If no fees apply, no fee items are returned.
content:
application/json:
schema:
$ref: '#/components/schemas/CardObject200Response'
examples:
reissuedCardWithFee:
summary: Reissue succeeded with an applied fee
value:
errors: []
requestId: 1249a3bf-aca1-40dd-9fba-2a3193550c39
status: 200
data:
cardId: 123456
customerId: 789012
cardNumberMasked: '************1234'
status: PendingVerification
expireMonth: 4
expireYear: 2029
reissueReasonTypeCode: LST
reissuedDate: '2026-06-03T14:25:30.000-05:00'
fees:
- feeTypeId: 2200
feeDescription: Card Reissue Fee
productType: Checking
productTypeId: 1001
feeAmount: 5
feeToApplyId: 987654321
accounts:
- accountId: 456789
availableBalance: 95
balanceAfterFees: 90
throttle: null
'400':
description: Bad Request. Validation failed or the card cannot be reissued for the requested reason, card status, card type, fee state, or program configuration. See the endpoint Error Codes table.
content:
application/json:
schema:
type: object
properties:
errors:
type: array
items:
type: object
properties:
code:
type: integer
format: int64
message:
type: string
requestId:
type: string
status:
type: integer
data: {}
throttle: {}
examples:
invalidReissueReason:
summary: Invalid reissue reason
value:
errors:
- code: 153001
message: Invalid reissueReasonTypeCode 'ABC'. Please refer to API documentation for valid types.
requestId: 1249a3bf-aca1-40dd-9fba-2a3193550c39
status: 400
data: null
throttle: null
'401':
$ref: '#/paths/~1card~1verify/post/responses/401'
'404':
$ref: '#/paths/~1card~1verify/post/responses/404'
'405':
$ref: '#/paths/~1card~1verify/post/responses/405'
'429':
$ref: '#/paths/~1card~1verify/post/responses/429'
/card/removeAccount:
post:
tags:
- Card
summary: Remove an account from a card
description: 'Removes an account from a card. Can be reversed by calling /card/addAccount.
The `customerId` attempting to remove the account must have an `accessTypeCode` of `FULL` to that account and the customer itself must have a `accessTypeCode` of `FULL` or `ACCT`.'
externalDocs:
url: https://docs.helix.q2.com/reference/cardremoveaccount
operationId: cardRemoveAccount
requestBody:
required: true
content:
application/json:
schema:
type: object
required:
- customerId
- cardId
- accountId
properties:
customerId:
$ref: '#/components/schemas/HelixId'
cardId:
$ref: '#/components/schemas/HelixId'
accountId:
$ref: '#/components/schemas/HelixId'
responses:
'200':
description: An envelope whose data node is a card object
content:
application/json:
schema:
$ref: '#/components/schemas/CardObject200Response'
'400':
$ref: '#/paths/~1card~1lock/post/responses/400'
'401':
$ref: '#/paths/~1card~1lock/post/responses/401'
'404':
$ref: '#/paths/~1card~1lock/post/responses/404'
'405':
$ref: '#/paths/~1card~1lock/post/responses/405'
'429':
$ref: '#/paths/~1card~1lock/post/responses/429'
/card/renewalOverride:
post:
tags:
- Card
summary: Renewal override
description: 'Override the base Helix card renewal eligibility criteria during a card''s renewal period. A card''s renewal period begins on the first day of the prior month of the card''s expiration and ends the day before the client''s scheduled monthly renewal job. Card must be in an eligible `status` listed below to perform a card renewal override: `Verified`, `Reissued`, `PendingVerification`, `ReissuedPendingVerification`, `DigitalActivePhysicalInitiated`, `DigitalActivePhysicalPending`.'
externalDocs:
url: https://docs.helix.q2.com/reference/cardrenewaloverride
operationId: cardRenewalOverride
requestBody:
required: true
content:
application/json:
schema:
type: object
required:
- customerId
- cardId
- renewalOverride
properties:
customerId:
$ref: '#/paths/~1card~1verify/post/requestBody/content/application~1json/schema/properties/cardId'
cardId:
$ref: '#/paths/~1card~1verify/post/requestBody/content/application~1json/schema/properties/cardId'
renewalOverride:
type: string
enum:
- Renew
- DoNotRenew
renewalOverrideReason:
type: string
maxLength: 20
responses:
'200':
description: An envelope whose data node is a card object
content:
application/json:
schema:
$ref: '#/components/schemas/CardObject200Response'
'400':
$ref: '#/paths/~1card~1verify/post/responses/400'
'401':
$ref: '#/paths/~1card~1verify/post/responses/401'
'404':
$ref: '#/paths/~1card~1verify/post/responses/404'
'405':
$ref: '#/paths/~1card~1verify/post/responses/405'
'429':
$ref: '#/paths/~1card~1verify/post/responses/429'
/card/reprioritizeAccount:
post:
tags:
- Card
summary: Reprioritize an account on a card
description: Update the order in which accounts are displayed when a card is used at an ATM. For more details see Account Reprioritization Scenarios. The `customerId` attempting to reprioritize the account must have an `accessTypeCode` of `FULL` or `ACCT`.
externalDocs:
url: https://docs.helix.q2.com/reference/cardreprioritizeaccount
operationId: cardReprioritizeAccount
requestBody:
required: true
content:
application/json:
schema:
type: object
required:
- customerId
- cardId
- accountId
- cardPriority
properties:
customerId:
$ref: '#/components/schemas/HelixId'
cardId:
$ref: '#/components/schemas/HelixId'
accountId:
$ref: '#/components/schemas/HelixId'
cardPriority:
allOf:
- description: "The new priority to give the `accountId`. Must be between `1` and `4` inclusive. Other accounts tied to the card in the same `productCategoryType` as the `accountId` will be reprioritized accordingly. \n\n**Note**: If the account in the priority 1 slot is changing AND that account is the `primaryAccountId` for that card, the account that is moved into the priority 1 slot will be assigned as the new `primaryAccountId`.\n"
- $ref: '#/components/schemas/CardPriority'
responses:
'200':
description: An envelope whose data node is a card object
content:
application/json:
schema:
$ref: '#/components/schemas/CardObject200Response'
'400':
$ref: '#/paths/~1card~1lock/post/responses/400'
'401':
$ref: '#/paths/~1card~1lock/post/responses/401'
'404':
$ref: '#/paths/~1card~1lock/post/responses/404'
'405':
$ref: '#/paths/~1card~1lock/post/responses/405'
'429':
$ref: '#/paths/~1card~1lock/post/responses/429'
/card/resetPin:
post:
tags:
- Card
summary: Reset a card pin
description: Create a request to reset the PIN for a card.
externalDocs:
url: https://docs.helix.q2.com/reference/cardresetpin
operationId: cardResetPin
requestBody:
required: true
content:
application/json:
schema:
type: object
required:
- customerId
- cardId
- newPin
properties:
customerId:
$ref: '#/paths/~1card~1verify/post/requestBody/content/application~1json/schema/properties/cardId'
cardId:
$ref: '#/paths/~1card~1verify/post/requestBody/content/application~1json/schema/properties/cardId'
newPin:
type: string
format: byte
description: See the `newPin` attribute on the card object definition for details.
responses:
'200':
description: An envelope whose data node is a card object
content:
application/json:
schema:
$ref: '#/components/schemas/CardObject200Response'
'400':
$ref: '#/paths/~1card~1verify/post/responses/400'
'401':
$ref: '#/paths/~1card~1verify/post/responses/401'
'404':
$ref: '#/paths/~1card~1verify/post/responses/404'
'405':
$ref: '#/paths/~1card~1verify/post/responses/405'
'429':
$ref: '#/paths/~1card~1verify/post/responses/429'
/card/unlock:
post:
tags:
- Card
summary: Unlock a card
description: Unlock a card by the Helix-assigned `cardId`.
externalDocs:
url: https://docs.helix.q2.com/reference/cardunlock
operationId: cardUnlock
requestBody:
required: true
content:
application/json:
schema:
type: object
required:
- customerId
- cardId
properties:
customerId:
$ref: '#/paths/~1card~1verify/post/requestBody/content/application~1json/schema/properties/cardId'
cardId:
$ref: '#/paths/~1card~1verify/post/requestBody/content/application~1json/schema/properties/cardId'
responses:
'200':
description: An envelope whose data node is a card object
content:
application/json:
schema:
$ref: '#/components/schemas/CardObject200Response'
'400':
$ref: '#/paths/~1card~1verify/post/responses/400'
'401':
$ref: '#/paths/~1card~1verify/post/responses/401'
'404':
$ref: '#/paths/~1card~1verify/post/responses/404'
'405':
$ref: '#/paths/~1card~1verify/post/responses/405'
'429':
$ref: '#/paths/~1card~1verify/post/responses/429'
/card/update:
post:
tags:
- Card
summary: Update a card
description: See card object definition for parameter details.
externalDocs:
url: https://docs.helix.q2.com/reference/cardupdate
operationId: cardUpdate
requestBody:
required: true
content:
application/json:
schema:
type: object
required:
- customerId
- cardId
properties:
customerId:
$ref: '#/components/schemas/HelixId'
cardId:
$ref: '#/components/schemas/HelixId'
nickname:
type: string
maxLength: 50
tag:
type: string
maxLength: 50
primaryAccountId:
$ref: '#/components/schemas/HelixId'
expireMonth:
allOf:
- $ref: '#/components/schemas/MonthProperty'
description: Applies only to the Helix sandbox environment.
expireYear:
allOf:
- $ref: '#/components/schemas/YearProperty'
description: Applies only to the Helix sandbox environment.
responses:
'200':
description: An envelope whose data node is a card object
content:
application/json:
schema:
$ref: '#/components/schemas/CardObject200Response'
'400':
$ref: '#/paths/~1card~1lock/post/responses/400'
'401':
$ref: '#/paths/~1card~1lock/post/responses/401'
'404':
$ref: '#/paths/~1card~1lock/post/responses/404'
'405':
$ref: '#/paths/~1card~1lock/post/responses/405'
'429':
$ref: '#/paths/~1card~1lock/post/responses/429'
/card/verify:
post:
tags:
- Card
summary: Verify a card
description: Verify a customer has received a physical card and activate it for use.
externalDocs:
url: https://docs.helix.q2.com/reference/cardverify
operationId: cardVerify
requestBody:
required: true
content:
application/json:
schema:
type: object
required:
- customerId
- cardId
- birthDate
- cardNumberMasked
properties:
customerId:
$ref: '#/paths/~1card~1verify/post/requestBody/content/application~1json/schema/properties/cardId'
cardId:
type: integer
format: int32
minimum: 1
birthDate:
type: string
format: date
description: The birthday of the `customerId` who created the card. Format is YYYY-MM-DD.
cardNumberMasked:
type: string
description: The last four digits of the card number. In sandbox this value is always `1111`
responses:
'200':
description: An envelope whose data node is a card object with `status=Verified`
content:
application/json:
schema:
$ref: '#/components/schemas/CardObject200Response'
'400':
description: Bad Request
content:
application/json:
schema:
type: object
properties:
errors:
type: array
items:
type: object
properties:
code:
$ref: '#/paths/~1card~1verify/post/requestBody/content/application~1json/schema/properties/cardId'
message:
type: string
requestId:
type: string
example: b75a96f8-2fbc-4b14-9ba4-7b06aa431c9d
status:
type: integer
enum:
- 400
'401':
description: Unauthorized
content:
application/json:
schema:
type: object
properties:
errors:
type: array
items:
type: object
properties:
code:
type: integer
enum:
- 50401
message:
type: string
example: User is not authorized
requestId:
type: string
enum:
- 00000000-0000-0000-0000-000000000000
status:
type: integer
enum:
- 401
'404':
description: Not Found
content:
application/json:
schema:
type: object
properties:
errors:
type: array
items:
type: object
properties:
code:
type: integer
enum:
- 50404
message:
type: string
example: The requested resource 'https://sandbox-api.helix.q2.com/customer/updat/805592' was not found
requestId:
type: string
example: b75a96f8-2fbc-4b14-9ba4-7b06aa431c9d
status:
type: integer
enum:
- 404
'405':
description: HTTP Method Not Allowed
content:
application/json:
schema:
type: object
properties:
errors:
type: array
items:
type: object
properties:
code:
type: integer
enum:
- 50405
message:
type: string
example: The HTTP method 'POST' for requested resource 'https://sandbox-api.helix.q2.com/customer/get/805594' is not allowed.
requestId:
type: string
enum:
- 00000000-0000-0000-0000-000000000000
status:
type: integer
enum:
- 405
'429':
description: Rate Limit Exceeded
content:
application/json:
schema:
type: object
properties:
errors:
type: array
items:
type: object
properties:
code:
type: integer
enum:
- 50429
message:
type: string
example: Rate limit exceeded
requestId:
type: string
enum:
- 00000000-0000-0000-0000-000000000000
status:
type: integer
enum:
- 429
/card/verifyByCvv:
post:
tags:
- Card
summary: Verify a card by CVV
description: Verify a card using the card verification value (CVV), expiration date, and optionally a requesting customer ID.
operationId: cardVerifyByCvv
requestBody:
required: true
content:
application/json:
schema:
type: object
required:
- customerId
- cardId
- cardVerificationValue
- expireMonth
- expireYear
properties:
cardId:
$ref: '#/paths/~1card~1verify/post/requestBody/content/application~1json/schema/properties/cardId'
customerId:
$ref: '#/paths/~1card~1verify/post/requestBody/content/application~1json/schema/properties/cardId'
cardHolderCustomerId:
$ref: '#/paths/~1card~1verify/post/requestBody/content/application~1json/schema/properties/cardId'
cardVerificationValue:
type: string
description: The card verification value (CVV) to verify.
expireMonth:
type: integer
description: The expiration month of the card.
expireYear:
type: integer
description: The expiration year of the card.
requestingCustomerId:
$ref: '#/paths/~1card~1verify/post/requestBody/content/application~1json/schema/properties/cardId'
responses:
'200':
description: An envelope whose data node is a card object.
content:
application/json:
schema:
$ref: '#/components/schemas/CardObject200Response'
'400':
$ref: '#/paths/~1card~1verify/post/responses/400'
'401':
$ref: '#/paths/~1card~1verify/post/responses/401'
'404':
$ref: '#/paths/~1card~1verify/post/responses/404'
'405':
$ref: '#/paths/~1card~1verify/post/responses/405'
'429':
$ref: '#/paths/~1card~1verify/post/responses/429'
components:
schemas:
CardObject200Response:
allOf:
- $ref: '#/components/schemas/CardArray200Response/allOf/0'
- type: object
properties:
data:
type: object
properties:
accounts:
type: array
items:
type: object
properties:
accountBalance:
type: number
format: decimal
accountId:
$ref: '#/components/schemas/HelixId'
accountNumberMasked:
type: string
availableBalance:
type: number
format: decimal
balanceLastModifiedDate:
$ref: '#/components/schemas/CustomerSetLastContact200Response/allOf/1/properties/data/items/properties/lastContactDate'
cardPriority:
$ref: '#/components/schemas/CardPriority'
customerId:
$ref: '#/components/schemas/HelixId'
lastModifiedDate:
$ref: '#/components/schemas/CustomerSetLastContact200Response/allOf/1/properties/data/items/properties/lastContactDate'
name:
type: string
pendingBalance:
type: number
format: decimal
status:
$ref: '#/components/schemas/AccountObject200Response/allOf/1/properties/data/properties/status'
tag:
$ref: '#/components/schemas/TagProperty'
type:
$ref: '#/components/schemas/AccountObject200Response/allOf/1/properties/data/properties/type'
archivedDate:
$ref: '#/components/schemas/CustomerSetLastContact200Response/allOf/1/properties/data/items/properties/lastContactDate'
binId:
$ref: '#/components/schemas/HelixId'
cardCarrierMessage:
type: string
description: 'Identifier used uniquely by various card production facilities for mapping card configurations.
'
cardDesignIdentificationNumber:
type: string
description: 'Identifier used uniquely by various card production facilities for mapping card configurations.
'
cardHolderCustomerId:
$ref: '#/components/schemas/HelixId'
cardId:
$ref: '#/components/schemas/HelixId'
cardNumberMasked:
type: string
cardVendorUniqueData:
type: string
description: 'Identifier used uniquely by various card production facilities for mapping card configurations.
'
createdDate:
$ref: '#/components/schemas/CustomerSetLastContact200Response/allOf/1/properties/data/items/properties/lastContactDate'
customerId:
$ref: '#/components/schemas/HelixId'
deniedDate:
$ref: '#/components/schemas/CustomerSetLastContact200Response/allOf/1/properties/data/items/properties/lastContactDate'
digitalWalletTokens:
type: array
items:
type: object
properties:
device:
type: object
properties:
deviceId:
type: string
deviceIpAddress:
type: string
deviceLanguageCode:
type: string
deviceLocation:
type: string
deviceName:
type: string
deviceNumber:
type: string
deviceType:
type: string
enum:
- Card
- MobilePhone
- Tablet
- Watch
- MobileDevice
- FashionAccessory
- HomeAppliance
- KeyFob
- MediaOrGamingDevice
- MobileDeviceAccessory
- PCOrLaptop
- Vehicle
- UnknownOther
isDeviceProvisioned:
type: boolean
panReferenceId:
type: string
token:
type: string
tokenReferenceId:
type: string
tokenRequestorId:
type: string
enum:
- '40010030273'
- '40010075001'
- '40010043095'
- '40010075338'
tokenRequestorName:
type: string
enum:
- ApplePay
- GooglePay
- SamsungPay
- VisaCheckout
tokenStatus:
type: string
enum:
- ActiveForPayment
- Initiated
- SuspendedTemporarily
- DeactivatedPermanently
tokenType:
type: string
enum:
- Card on file
- Secure element
- Cloud based payment/HCE
- E-Commerce Enabler
walletInformation:
type: object
properties:
panSource:
type: string
enum:
- KeyEntered
- OnFile
- MobileBankingApp
walletAccountId:
type: string
walletEmailAddressHashed:
type: string
walletProviderDeviceScore:
type: string
walletProviderReasonCodes:
type: string
walletProviderRiskAssessmentType:
type: string
enum:
- Approved
- ApprovedConditionally
- NotApproved
walletProviderRiskAssessmentVersion:
type: string
expireMonth:
$ref: '#/components/schemas/MonthProperty'
expireYear:
$ref: '#/components/schemas/YearProperty'
expiredDate:
$ref: '#/components/schemas/CustomerSetLastContact200Response/allOf/1/properties/data/items/properties/lastContactDate'
firstName:
type: string
isDigitalOnly:
type: boolean
isDualIssuanceSinglePAN:
type: boolean
isPINSet:
type: boolean
lastModifiedDate:
$ref: '#/components/schemas/CustomerSetLastContact200Response/allOf/1/properties/data/items/properties/lastContactDate'
lastName:
type: string
lockReasonTypeCode:
type: string
enum:
- UNK
- STL
- LST
- FRD
- DMG
- ADM
- TMP
- PIN
lockTypeCode:
type: string
enum:
- UNL
- CST
- SYS
middleName:
type: string
nameOnCard:
type: string
nickName:
type: string
photoImageId:
type: string
description: 'Identifier used uniquely by various card production facilities for mapping card configurations.
'
preferredName:
type: string
primaryAccountId:
$ref: '#/components/schemas/HelixId'
qualifierCode:
$ref: '#/components/schemas/CardQualifierCode'
reissuedDate:
$ref: '#/components/schemas/CustomerSetLastContact200Response/allOf/1/properties/data/items/properties/lastContactDate'
renewalOverride:
$ref: '#/components/schemas/RenewalOverride'
renewalOverrideReason:
type: string
requestedDate:
$ref: '#/components/schemas/CustomerSetLastContact200Response/allOf/1/properties/data/items/properties/lastContactDate'
status:
type: string
enum:
- Initiated
- Pending
- PendingVerification
- Verified
- Denied
- Expired
- Archived
- Reissued
- Hotlisted
- ReissuedPendingVerification
- AutoReissuedPendingVerification
tag:
$ref: '#/components/schemas/TagProperty'
typeCode:
type: string
enum:
- DBT
vendorTypeCode:
$ref: '#/components/schemas/CardVendorTypeCode'
verifiedDate:
$ref: '#/components/schemas/CustomerSetLastContact200Response/allOf/1/properties/data/items/properties/lastContactDate'
CardArray200Response:
allOf:
- type: object
properties:
errors:
type: array
items: {}
example: []
requestId:
type: string
example: 1249a3bf-aca1-40dd-9fba-2a3193550c39
status:
type: integer
enum:
- 200
throttle:
type: object
properties:
periodEndsAt:
$ref: '#/components/schemas/CustomerSetLastContact200Response/allOf/1/properties/data/items/properties/lastContactDate'
periodLengthInSeconds:
$ref: '#/components/schemas/HelixId'
periodRequestLimit:
$ref: '#/components/schemas/HelixId'
requestsRemainingInPeriod:
$ref: '#/components/schemas/HelixId'
warningThreshold:
type: number
format: decimal
example: 0.2
- type: object
properties:
data:
type: array
items:
$ref: '#/components/schemas/CardObject200Response/allOf/1/properties/data'
CardTypeCode:
type: string
CardVendorTypeCode:
type: string
CustomerSetLastContact200Response:
allOf:
- $ref: '#/components/schemas/CardArray200Response/allOf/0'
- type: object
properties:
data:
type: array
items:
type: object
properties:
customerId:
$ref: '#/components/schemas/HelixId'
dormancyStatus:
type: string
enum:
- Active
- Inactive
- Dormant
lastContactDate:
type: string
format: date-time
example: '2021-01-07T19:00:59.761-06:00'
lastContactType:
$ref: '#/components/schemas/LastContactType'
MonthProperty:
type: integer
minimum: 1
maximum: 12
TagProperty:
type: string
maxLength: 50
HelixId:
type: integer
format: int32
minimum: 1
CardCreateDigital200Response:
allOf:
- $ref: '#/components/schemas/CardArray200Response/allOf/0'
- type: object
properties:
data:
$ref: '#/components/schemas/CardObject200Response/allOf/1/properties/data'
AccountObject200Response:
allOf:
- $ref: '#/components/schemas/CardArray200Response/allOf/0'
- type: object
properties:
data:
type: object
properties:
accessTypeCode:
type: string
enum:
- FULL
- AUTHSIGNER
- RDONLY
- NONE
accountBalance:
type: number
format: decimal
accountId:
$ref: '#/components/schemas/HelixId'
accountMinimumBalance:
type: number
format: decimal
accountNumber:
type: string
accountNumberMasked:
type: string
availableBalance:
type: number
format: decimal
balanceLastModifiedDate:
$ref: '#/components/schemas/CustomerSetLastContact200Response/allOf/1/properties/data/items/properties/lastContactDate'
category:
type: string
maxLength: 50
closedAmount:
type: number
format: decimal
closedDate:
$ref: '#/components/schemas/CustomerSetLastContact200Response/allOf/1/properties/data/items/properties/lastContactDate'
closedReason:
$ref: '#/components/schemas/CloseReason'
closedReasonNotes:
$ref: '#/components/schemas/CloseReasonNotes'
createdDate:
$ref: '#/components/schemas/CustomerSetLastContact200Response/allOf/1/properties/data/items/properties/lastContactDate'
customField1:
type: string
maxLength: 50
customField2:
type: string
maxLength: 50
customField3:
type: string
maxLength: 50
customField4:
type: string
maxLength: 50
customField5:
type: string
maxLength: 50
customerId:
$ref: '#/components/schemas/HelixId'
customerPriority:
$ref: '#/components/schemas/HelixId'
externalProgramTag:
type: string
firstDepositDate:
$ref: '#/components/schemas/CustomerSetLastContact200Response/allOf/1/properties/data/items/properties/lastContactDate'
globalAccountAccessEnabled:
type: boolean
interestTransferFkId:
$ref: '#/components/schemas/HelixId'
isCloseable:
type: boolean
isJointAccount:
type: boolean
isLocked:
type: boolean
isPrimary:
type: boolean
isPrimaryCustomer:
type: boolean
lastModifiedDate:
$ref: '#/components/schemas/CustomerSetLastContact200Response/allOf/1/properties/data/items/properties/lastContactDate'
legalName1:
$ref: '#/components/schemas/LegalName'
legalName2:
$ref: '#/components/schemas/LegalName'
lockReasonTypeCode:
$ref: '#/components/schemas/AccountLockReasonTypeCode'
lockTypeCode:
$ref: '#/components/schemas/CardObject200Response/allOf/1/properties/data/properties/lockTypeCode'
accountLockClassificationCode:
type:
- string
- 'null'
maxLength: 10
description: Program-configured classification code associated with the account lock.
accountLockClassificationCodeDescription:
type:
- string
- 'null'
description: Human-readable description of the accountLockClassificationCode.
maturityTypeCode:
type: string
name:
type: string
pendingBalance:
type: number
format: decimal
primaryCustomerId:
$ref: '#/components/schemas/HelixId'
productId:
$ref: '#/components/schemas/HelixId'
recurringContributionAmount:
type: number
format: decimal
recurringContributionEndDate:
$ref: '#/components/schemas/CustomerSetLastContact200Response/allOf/1/properties/data/items/properties/lastContactDate'
recurringContributionFromExternalAccountId:
$ref: '#/components/schemas/HelixId'
recurringContributionNextDate:
$ref: '#/components/schemas/CustomerSetLastContact200Response/allOf/1/properties/data/items/properties/lastContactDate'
recurringContributionStartDate:
$ref: '#/components/schemas/DateTimeProperty'
recurringContributionType:
$ref: '#/components/schemas/RecurringContributionType'
regDWithdrawalCount:
type: integer
format: int32
minimum: 0
routingNumber:
type: string
routingNumberMasked:
type: string
sourceLinks:
type: array
items:
type: object
deprecated: true
properties:
creditSetting:
type: number
format: decimal
customerId:
$ref: '#/components/schemas/HelixId'
debitSetting:
type: number
format: decimal
isCreditAutoTransferEnabled:
type: boolean
isDebitAutoTransferEnabled:
type: boolean
linkOptionTypeCode:
type: string
enum:
- OVRPRTAMT
- OVRPRTMLT
- OVRSECPCT
- OVRSECFIX
description: '- `OVRPRTAMT`: Auto-transfer exact amount of withdrawal
- `OVRPRTMLT`: Auto-transfer to the nearest multiple of `debitSetting` to cover withdrawal amount
- `OVRSECPCT`: Allow lending up to `debitSetting` percentage of security account funds
- `OVRSECFIX`: Allow lending up to fixed amount of `debitSetting`
'
linkTypeCode:
type: string
enum:
- OVRPRT
- OVRSEC
description: '- `OVRPRT`: Overdraft protention
- `OVRSEC`: Overdraft security
'
sourceAccountId:
$ref: '#/components/schemas/HelixId'
targetAccountId:
$ref: '#/components/schemas/HelixId'
deprecated: true
status:
type: string
enum:
- Open
- Closed
- PendingOpen
- PendingClosed
subCategory:
type: string
tag:
$ref: '#/components/schemas/TagProperty'
targetAmount:
type: number
format: decimal
targetDate:
$ref: '#/components/schemas/DateTimeProperty'
targetLinks:
type: array
items:
$ref: '#/components/schemas/AccountObject200Response/allOf/1/properties/data/properties/sourceLinks/items'
deprecated: true
targetMetDate:
$ref: '#/components/schemas/CustomerSetLastContact200Response/allOf/1/properties/data/items/properties/lastContactDate'
targetMetPercent:
type: number
format: decimal
totalCustomers:
$ref: '#/components/schemas/HelixId'
type:
type: string
enum:
- Checking
- Savings
- ForBenefitOf
- Prepaid
- Time Deposit
- Business Checking
- Business Savings
RenewalOverride:
type: string
CardPriority:
type: integer
format: int32
minimum: 1
maximum: 4
CardQualifierCode:
type: string
YearProperty:
type: integer
minimum: 1900
maximum: 9999
CardArchive200Response:
allOf:
- $ref: '#/components/schemas/CardArray200Response/allOf/0'
- type: object
properties:
data:
$ref: '#/components/schemas/CardObject200Response/allOf/1/properties/data'
parameters:
CustomerIdPath:
name: customerId
in: path
required: true
schema:
$ref: '#/components/schemas/HelixId'
securitySchemes:
basicAuth:
type: http
scheme: basic
x-samples-languages:
- curl
- node
- python
- csharp
- ruby
- go
- java
- kotlin
- php
x-provenance:
method: searched
source: https://docs.helix.q2.com/reference
harvested: '2026-10-14'
tool: harvest-readme-openapi.py
note: Assembled verbatim from the OpenAPI definition ReadMe embeds in each operation page of the provider's developer portal; paths and components merged by API title, nothing authored.
assembled_from:
- https://docs.helix.q2.com/reference/accountaddentitlement.md
- https://docs.helix.q2.com/reference/accountbeneficiaryadd.md
- https://docs.helix.q2.com/reference/accountbeneficiaryedit.md
- https://docs.helix.q2.com/reference/accountbeneficiaryget.md
- https://docs.helix.q2.com/reference/accountbeneficiarylist.md
- https://docs.helix.q2.com/reference/accountbeneficiaryremove.md
- https://docs.helix.q2.com/reference/accountbeneficiaryreplace.md
- https://docs.helix.q2.com/reference/accountclose.md
- https://docs.helix.q2.com/reference/accountcreate.md
- https://docs.helix.q2.com/reference/accounteditentitlement.md
- https://docs.helix.q2.com/reference/accountget.md
- https://docs.helix.q2.com/reference/accountgetbytag.md
- https://docs.helix.q2.com/reference/accountlimitdelete.md
- https://docs.helix.q2.com/reference/accountlimitlist.md
- https://docs.helix.q2.com/reference/accountlimitset.md
- https://docs.helix.q2.com/reference/accountlist.md
- https://docs.helix.q2.com/reference/accountlistentitlements.md
- https://docs.helix.q2.com/reference/accountlock.md
- https://docs.helix.q2.com/reference/accountplacehold.md
- https://docs.helix.q2.com/reference/accountreleasehold.md
- https://docs.helix.q2.com/reference/accountremoveentitlement.md
- https://docs.helix.q2.com/reference/accountstoppaycreatecheckstoppay.md
- https://docs.helix.q2.com/reference/accountstoppayexpire.md
- https://docs.helix.q2.com/reference/accountstoppaylist.md
- https://docs.helix.q2.com/reference/accountunlock.md
- https://docs.helix.q2.com/reference/accountupdate.md
- https://docs.helix.q2.com/reference/bankdocumentdownload.md
- https://docs.helix.q2.com/reference/bankdocumentlist.md
- https://docs.helix.q2.com/reference/cardaddaccount.md
- https://docs.helix.q2.com/reference/cardarchive.md
- https://docs.helix.q2.com/reference/cardcontrolarchive.md
- https://docs.helix.q2.com/reference/cardcontrolarchivebytag.md
- https://docs.helix.q2.com/reference/cardcontrolcreate.md
- https://docs.helix.q2.com/reference/cardcontrolget.md
- https://docs.helix.q2.com/reference/cardcontrolgetbytag.md
- https://docs.helix.q2.com/reference/cardcreatedigital.md
- https://docs.helix.q2.com/reference/cardfraudtextalertget.md
- https://docs.helix.q2.com/reference/cardfraudtextalertoptout.md
- https://docs.helix.q2.com/reference/cardget.md
- https://docs.helix.q2.com/reference/cardgetbytag.md
- https://docs.helix.q2.com/reference/cardhotlist.md
- https://docs.helix.q2.com/reference/cardinitiate.md
- https://docs.helix.q2.com/reference/cardlimitget.md
- https://docs.helix.q2.com/reference/cardlimitoverride.md
- https://docs.helix.q2.com/reference/cardlimitreset.md
- https://docs.helix.q2.com/reference/cardlimittemporaryoverride.md
- https://docs.helix.q2.com/reference/cardlist.md
- https://docs.helix.q2.com/reference/cardlock.md
- https://docs.helix.q2.com/reference/cardmockadminfalconfraud.md
- https://docs.helix.q2.com/reference/cardmockdeclinepurchaseauthorize.md
- https://docs.helix.q2.com/reference/cardmockdepositpurchasereturn.md
- https://docs.helix.q2.com/reference/cardmockdepositpurchasereturnreversal.md
- https://docs.helix.q2.com/reference/cardmockwithdrawalcardcash.md
- https://docs.helix.q2.com/reference/cardmockwithdrawalpurchaseauthorize.md
- https://docs.helix.q2.com/reference/cardmockwithdrawalpurchasecomplete.md
- https://docs.helix.q2.com/reference/cardorderphysical.md
- https://docs.helix.q2.com/reference/cardprovisionapplepay.md
- https://docs.helix.q2.com/reference/cardprovisioncarddetail.md
- https://docs.helix.q2.com/reference/cardprovisiongooglepay.md
- https://docs.helix.q2.com/reference/cardreissue.md
- https://docs.helix.q2.com/reference/cardremoveaccount.md
- https://docs.helix.q2.com/reference/cardrenewaloverride.md
- https://docs.helix.q2.com/reference/cardreprioritizeaccount.md
- https://docs.helix.q2.com/reference/cardresetpin.md
- https://docs.helix.q2.com/reference/cardriskfactorget.md
- https://docs.helix.q2.com/reference/cardriskfactorset.md
- https://docs.helix.q2.com/reference/cardunlock.md
- https://docs.helix.q2.com/reference/cardupdate.md
- https://docs.helix.q2.com/reference/cardverify.md
- https://docs.helix.q2.com/reference/cardverifybycvv.md
- https://docs.helix.q2.com/reference/customeranswerlist.md
- https://docs.helix.q2.com/reference/customeranswerpost.md
- https://docs.helix.q2.com/reference/customerarchive.md
- https://docs.helix.q2.com/reference/customerbeneficiaryaccountassignmentlist.md
- https://docs.helix.q2.com/reference/customerbeneficiarycreate.md
- https://docs.helix.q2.com/reference/customerbeneficiarydeactivate.md
- https://docs.helix.q2.com/reference/customerbeneficiaryget.md
- https://docs.helix.q2.com/reference/customerbeneficiarylist.md
- https://docs.helix.q2.com/reference/customerbeneficiaryupdate.md
- https://docs.helix.q2.com/reference/customercreate.md
- https://docs.helix.q2.com/reference/customercreatebusiness.md
- https://docs.helix.q2.com/reference/customercreatebusinessapplication.md
- https://docs.helix.q2.com/reference/customerdocumentget.md
- https://docs.helix.q2.com/reference/customerdocumentlist.md
- https://docs.helix.q2.com/reference/customerdocumentupdatestatus.md
- https://docs.helix.q2.com/reference/customerdocumentupload.md
- https://docs.helix.q2.com/reference/customergeneratetoken.md
- https://docs.helix.q2.com/reference/customerget.md
- https://docs.helix.q2.com/reference/customergetbyemail.md
- https://docs.helix.q2.com/reference/customergetbytag.md
- https://docs.helix.q2.com/reference/customerlist.md
- https://docs.helix.q2.com/reference/customernote.md
- https://docs.helix.q2.com/reference/customernoteslist.md
- https://docs.helix.q2.com/reference/customerrelationshiparchive.md
- https://docs.helix.q2.com/reference/customerrelationshipcreate.md
- https://docs.helix.q2.com/reference/customerrelationshiplist.md
- https://docs.helix.q2.com/reference/customerrelationshipupdate.md
- https://docs.helix.q2.com/reference/customerrelationshipupdateprimarycontact.md
- https://docs.helix.q2.com/reference/customersearch.md
- https://docs.helix.q2.com/reference/customersecurityanswerslist.md
- https://docs.helix.q2.com/reference/customersetlastcontact.md
- https://docs.helix.q2.com/reference/customerupdate.md
- https://docs.helix.q2.com/reference/customerupdateaddress-2.md
- https://docs.helix.q2.com/reference/externalaccountarchive.md
- https://docs.helix.q2.com/reference/externalaccountcreate.md
- https://docs.helix.q2.com/reference/externalaccountdocumentupload.md
- https://docs.helix.q2.com/reference/externalaccountget.md
- https://docs.helix.q2.com/reference/externalaccountgetbytag.md
- https://docs.helix.q2.com/reference/externalaccountinitiate.md
- https://docs.helix.q2.com/reference/externalaccountlist.md
- https://docs.helix.q2.com/reference/externalaccountlock.md
- https://docs.helix.q2.com/reference/externalaccountresendverification.md
- https://docs.helix.q2.com/reference/externalaccountunlock.md
- https://docs.helix.q2.com/reference/externalaccountupdate.md
- https://docs.helix.q2.com/reference/externalaccountverify.md
- https://docs.helix.q2.com/reference/feeconfiglist.md
- https://docs.helix.q2.com/reference/feeget.md
- https://docs.helix.q2.com/reference/feegetbycustomertag.md
- https://docs.helix.q2.com/reference/programget.md
- https://docs.helix.q2.com/reference/programlistaccountholds.md
- https://docs.helix.q2.com/reference/programlistindustryclassificationcodes.md
- https://docs.helix.q2.com/reference/programquestionslist.md
- https://docs.helix.q2.com/reference/statementdownload.md
- https://docs.helix.q2.com/reference/statementget.md
- https://docs.helix.q2.com/reference/statementlist.md
- https://docs.helix.q2.com/reference/statementsearch.md
- https://docs.helix.q2.com/reference/transactioncreatefee.md
- https://docs.helix.q2.com/reference/transactionget.md
- https://docs.helix.q2.com/reference/transactiongetbytag.md
- https://docs.helix.q2.com/reference/transactionlist.md
- https://docs.helix.q2.com/reference/transactionsetavailabledate.md
- https://docs.helix.q2.com/reference/transactionsetstatus.md
- https://docs.helix.q2.com/reference/transactionwireget.md
- https://docs.helix.q2.com/reference/transferachoriginationcreate.md
- https://docs.helix.q2.com/reference/transfercreate.md
- https://docs.helix.q2.com/reference/transfervoid.md
- https://docs.helix.q2.com/reference/transferwirecreate-2.md
merge:
pages: 137
deduped: 1427
conflicts_kept_first: 0