For AI agents: visit https://docs.helix.q2.com/llms.txt for an index of all pages formatted in Markdown and endpoints in OpenAPI.
Jump to Content
Contact Us
Guides
API Reference
Contact Us
API Reference
Guides
API Reference
Private Endpoints
JUMP TO
Getting Started
Authentication
Environments
Environment Differences
Test Connectivity
Request and Response
Versioning
Data Format Guidelines
Property Naming Guidelines
Rate Limiting
Status Codes
Response Format
Errors
Error Code Ranges
Common Error Codes
Quickstart
Helix API
Account
Create an account
post
Get an account
get
Get an account via tag
get
List accounts
get
Update an account
post
Lock an account
post
Unlock an account
post
Close an account
post
Account - Entitlement
Add an entitlement
post
List Entitlements
get
Edit an entitlement
post
Remove an entitlement
post
Account - Hold
Place a hold
post
Release a hold
post
Account - Limit
Set account limit(s)
post
List account limits
get
Delete account limit(s)
post
Account - Stop Pay
Create check stop pay
post
List stop pays
get
Expire a stop pay
post
Account Beneficiary
Add account beneficiary
post
Edit account beneficiary
post
Get an account beneficiary
get
List account beneficiaries
get
Remove account beneficiary
post
Replace account beneficiary collection
post
Bank Document
List bank documents
get
Download a bank document
get
Card
Get a card
get
Update a card
post
Add an account to a card
post
Reprioritize an account on a card
post
Remove an account from a card
post
Create a digital card
post
Order a physical card
post
Lock a card
post
Initiate a card
post
Verify a card
post
Get a card via tag
get
List cards
get
Unlock a card
post
Hotlist (permanently lock) a card
post
Reset a card pin
post
Renewal override
post
Reissue a card
post
Archive a card
post
Verify a card by CVV
post
Card - Fraud Text Alert
Get fraud text enrollment status
get
Opt out of fraud texts
post
Card - Limit
Get card limits
get
Create a temporary card limit
post
Override default card limits
post
Reset card limits
post
Card - Mock
Simulate Falcon Fraud Message in sandbox environment
post
Simulate ATM withdrawal in sandbox environment
post
Simulate withdrawal authorization in sandbox environment
post
Simulate withdrawal settlement in sandbox environment
post
Simulate declined purchase authorization in sandbox environment
post
Simulate purchase return in sandbox environment
post
Simulate purchase return reversal in sandbox environment
post
Card - Provision
Get VDE provisioning details
get
Provision to Apple Pay
post
Provision to Google Pay
post
Card - Risk Factor
Get card risk factors
get
Set card risk factors
post
Card Control
Create a card control
post
Get a card control
get
Get a card control by tag
get
Archive a card control
post
Archive a card control by tag
post
Customer
Create a customer
post
Create a business customer
post
Create business application
post
Get a customer
get
Get a customer via emailAddress
get
Get a customer via tag
get
List customers
get
Search for customers
post
Update a customer
post
Update a customer address
Set last contact
post
Generate a customer token
get
Make a customer note
post
List customer notes
get
Archive a customer
post
Update a customer address
post
Customer - Due Diligence
List a customer's due diligence responses
get
Submit a customer's due diligence answers
post
Retrieves the list of security answers for a customer in a specified language
post
Customer Beneficiary
Create a customer beneficiary
post
Get a customer beneficiary
get
List customer beneficiaries
get
Update a customer beneficiary
post
Deactivate a customer beneficiary
post
List account assignments for a customer beneficiary
get
Customer Document
Get a customer document
get
List customer documents
get
Update customer document status
post
Upload a customer document
post
Customer Relationship
Create customer relationship
post
List customer relationships
get
Update customer relationship
post
Update primary contact
post
Archive customer relationship
post
External Account
Create an external account
post
Get an external account
get
Get an external account via tag
get
List external accounts
get
Initiate an external account
post
Resend verification deposits
post
Verify an external account
post
Update an external account
post
Lock an external account
post
Unlock an external account
post
Archive an external account
post
External Account Document
Upload an external account document
post
Fee
Get fees
get
Get a fee record by FeeToApplyId
get
Get a fee record by customer fee tag
get
Program
Get program details
get
List account holds
get
List industry classification codes
get
Get customer due diligence questions
get
Statement
Get a statement
get
List statements
get
Search for statements
get
Download a statement
get
Transaction
Get transactions
get
Get a transaction(s) via tag
get
List transactions
get
Set transaction available date
post
Set transaction status
post
Create a fee for a specified customer account
post
Transaction - Wire
Get wire transaction details
get
Transfer
Create a transfer
post
Create an ACH-originated debit or credit transaction
post
Void a transfer
post
Transfer - Wire
Create a wire
post
Helix Private
Private Endpoints
Private Endpoints
Copy Page
Private functionality endpoints
Updated 1 day ago
Create a wire
Updated 1 day ago
Create a wire
