openapi: 3.2.0
info:
  title: Helix Program 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: Program
  description: Endpoints for the program object
paths:
  /program/get:
    get:
      tags:
      - Program
      summary: Get program details
      description: Retrieve your program settings and information.
      externalDocs:
        url: https://docs.helix.q2.com/reference/programget
      operationId: programGet
      responses:
        '200':
          description: An <a href="https://docs.helix.q2.com/reference/response-format" target="_blank">envelope</a> whose data node is a <a href="https://docs.helix.q2.com/docs/program" target="_blank">program</a> object
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProgramGet200Response'
        '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'
  /program/listAccountHolds:
    get:
      tags:
      - Program
      summary: List account holds
      description: Retrieve all account holds for the given program.
      externalDocs:
        url: https://docs.helix.q2.com/reference/programlistaccountholds
      operationId: programListAccountHolds
      parameters:
      - $ref: '#/components/parameters/PageNumber'
      - $ref: '#/components/parameters/PageSize'
      - name: customerId
        in: query
        required: false
        description: Required if `accountId` is present
        schema:
          type: integer
          format: int32
          minimum: 1
      - name: accountid
        in: query
        required: false
        schema:
          $ref: '#/components/schemas/HelixId'
      - name: statusType
        in: query
        required: false
        schema:
          type: string
          enum:
          - Active
          - Expired
          - Cancelled
          - ExpiredCancelled
      responses:
        '200':
          description: An array of accountHold objects
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AccountHoldArray200Response'
        '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'
  /program/listIndustryClassificationCodes:
    get:
      tags:
      - Program
      summary: List industry classification codes
      description: Retrieve all industry classification codes for your program. These codes are only used when creating or updating business customers.
      externalDocs:
        url: https://docs.helix.q2.com/reference/programlistindustryclassificationcodes
      operationId: programListIndustryClassificationCodes
      parameters:
      - $ref: '#/components/parameters/PageNumber'
      - $ref: '#/components/parameters/PageSize'
      responses:
        '200':
          description: An array of <a href="https://docs.helix.q2.com/docs/industry-classification-code" target="_blank">industryClassificationCode</a> objects
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProgramListIndustryClassiciationCodes200Response'
        '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'
  /program/questionsList:
    get:
      tags:
      - Program
      summary: Get customer due diligence questions
      description: Retrieve all due diligence questions for the given program.
      externalDocs:
        url: https://docs.helix.q2.com/reference/programquestionslist
      operationId: programQuestionsList
      parameters:
      - name: categoryName
        in: query
        required: false
        schema:
          type: string
          enum:
          - OpeningBusinessAccount
          - OpeningConsumerAccount
          - VeryPersonalQuestions
          - OpeningSoleProprietorAccount
          - All
      responses:
        '200':
          description: An array of <a href="https://docs.helix.q2.com/docs/due-diligence-category" target="_blank">dueDiligenceCategory</a> objects
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProgramQuestionsList200Response'
        '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'
components:
  schemas:
    CustomerAnswerList200Response:
      allOf:
      - $ref: '#/components/schemas/CardArray200Response/allOf/0'
      - type: object
        properties:
          data:
            type: array
            items:
              type: object
              properties:
                categoryId:
                  $ref: '#/components/schemas/AccountClose200Response/allOf/1/properties/data/properties/transactionId'
                categoryName:
                  type: string
                  maxLength: 100
                categoryDescription:
                  type: string
                  maxLength: 255
                followUpQuestions:
                  type: array
                  items:
                    $ref: '#/components/schemas/CustomerAnswerList200Response/allOf/1/properties/data/items/properties/questions/items'
                questions:
                  type: array
                  items:
                    type: object
                    properties:
                      questionId:
                        $ref: '#/components/schemas/AccountClose200Response/allOf/1/properties/data/properties/transactionId'
                      questionName:
                        type: string
                        maxLength: 100
                      questionDescription:
                        type: string
                        maxLength: 255
                      answerType:
                        type: string
                        maxLength: 50
                        enum:
                        - Single-Select
                        - Multi-Select
                        - Text
                      choices:
                        type: array
                        items:
                          type: object
                          properties:
                            answeredDate:
                              $ref: '#/components/schemas/CustomerSetLastContact200Response/allOf/1/properties/data/items/properties/lastContactDate'
                            choiceId:
                              $ref: '#/components/schemas/AccountClose200Response/allOf/1/properties/data/properties/transactionId'
                            choiceName:
                              type: string
                              maxLength: 100
                            choiceDescription:
                              type: string
                              maxLength: 255
                            followUpQuestionIds:
                              type: array
                              items:
                                $ref: '#/components/schemas/HelixId'
    AccountHoldArray200Response:
      allOf:
      - $ref: '#/components/schemas/CardArray200Response/allOf/0'
      - type: object
        properties:
          data:
            type: array
            description: An array of accountHold objects
            items:
              type: object
              properties:
                accountHoldId:
                  $ref: '#/components/schemas/HelixId'
                accountHoldStatusType:
                  $ref: '#/components/schemas/HoldStatusType'
                accountId:
                  $ref: '#/components/schemas/HelixId'
                appliedByUserEmail:
                  type: string
                appliedByUserId:
                  $ref: '#/components/schemas/HelixId'
                appliedDate:
                  $ref: '#/components/schemas/CustomerSetLastContact200Response/allOf/1/properties/data/items/properties/lastContactDate'
                comment:
                  type: string
                customerId:
                  $ref: '#/components/schemas/HelixId'
                expirationDate:
                  $ref: '#/components/schemas/CustomerSetLastContact200Response/allOf/1/properties/data/items/properties/lastContactDate'
                holdAmount:
                  type: number
                  format: decimal
                releasedByUserEmail:
                  type: string
                releasedByUserId:
                  $ref: '#/components/schemas/HelixId'
                releasedDate:
                  $ref: '#/components/schemas/CustomerSetLastContact200Response/allOf/1/properties/data/items/properties/lastContactDate'
                totalRecordCount:
                  $ref: '#/components/schemas/HelixId'
                transactionId:
                  $ref: '#/components/schemas/AccountClose200Response/allOf/1/properties/data/properties/transactionId'
    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'
    ProgramListIndustryClassiciationCodes200Response:
      allOf:
      - $ref: '#/components/schemas/CardArray200Response/allOf/0'
      - type: object
        properties:
          data:
            type: array
            items:
              type: object
              properties:
                description:
                  type: string
                industryClassificationCodeId:
                  $ref: '#/components/schemas/HelixId'
                industryCode:
                  type: string
                  example: '11'
                isActive:
                  type: boolean
                name:
                  type: string
                  example: Agriculture, Forestry, Fishing and Hunting
    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'
    HoldStatusType:
      type: string
      enum:
      - Active
      - Expired
      - Cancelled
      - ExpiredCancelled
    HelixId:
      type: integer
      format: int32
      minimum: 1
    AccountClose200Response:
      allOf:
      - $ref: '#/components/schemas/CardArray200Response/allOf/0'
      - type: object
        properties:
          data:
            type: object
            properties:
              customerId:
                $ref: '#/components/schemas/HelixId'
              accountId:
                $ref: '#/components/schemas/HelixId'
              closeToAccountId:
                $ref: '#/components/schemas/HelixId'
              transactionId:
                type: integer
                format: int64
                minimum: 1
              transactionTag:
                $ref: '#/components/schemas/TagProperty'
              closingBalanceAmount:
                type: number
                format: decimal
              interestPaidAmount:
                type: number
                format: decimal
              totalClosingAmount:
                type: number
                format: decimal
              isClosedToExternalAccount:
                type: boolean
    ProgramQuestionsList200Response:
      allOf:
      - $ref: '#/components/schemas/CardArray200Response/allOf/0'
      - type: object
        properties:
          data:
            type: array
            items:
              $ref: '#/components/schemas/CustomerAnswerList200Response/allOf/1/properties/data/items'
    ProgramGet200Response:
      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'
                    accountNumber:
                      type: string
                    accountNumberMasked:
                      type: string
                    description:
                      type: string
                    isActive:
                      type: boolean
                    programAccountId:
                      $ref: '#/components/schemas/HelixId'
                    type:
                      type: string
              bank:
                type: object
                properties:
                  maintenanceEndDate:
                    $ref: '#/components/schemas/CustomerSetLastContact200Response/allOf/1/properties/data/items/properties/lastContactDate'
                  maintenanceStartDate:
                    $ref: '#/components/schemas/CustomerSetLastContact200Response/allOf/1/properties/data/items/properties/lastContactDate'
                  name:
                    type: string
                  phone:
                    type: string
                  timeZone:
                    type: string
                  webUrl:
                    type: string
              bins:
                type: array
                items:
                  type: object
                  properties:
                    bankIdentificationNumber:
                      type: string
                    binId:
                      $ref: '#/components/schemas/HelixId'
                    description:
                      type: string
              checkingProducts:
                type: object
                deprecated: true
              decimalCount:
                $ref: '#/components/schemas/HelixId'
              externalAccounts:
                type: array
                items:
                  type: object
                  properties:
                    accountNumber:
                      type: string
                    accountNumberMasked:
                      type: string
                    description:
                      type: string
                    externalAccountId:
                      $ref: '#/components/schemas/HelixId'
                    isActive:
                      type: boolean
                    nachaName:
                      type: string
                    programExternalAccountId:
                      $ref: '#/components/schemas/HelixId'
                    routingNumber:
                      type: string
                    type:
                      type: string
              filledDate:
                $ref: '#/components/schemas/CustomerSetLastContact200Response/allOf/1/properties/data/items/properties/lastContactDate'
              isDebitRewardsEnabled:
                type: boolean
              isInterestEnabled:
                type: boolean
              isInternalToInternalTransferEnabled:
                type: boolean
              isRecurringContributionEnabled:
                type: boolean
              name:
                type: string
              perProgramDailyDepositLimit:
                $ref: '#/components/schemas/ProgramGet200Response/allOf/1/properties/data/properties/perUserDailyDepositLimit'
              perProgramDailyWithdrawLimit:
                $ref: '#/components/schemas/ProgramGet200Response/allOf/1/properties/data/properties/perUserDailyDepositLimit'
              perTransactionDepositLimit:
                $ref: '#/components/schemas/ProgramGet200Response/allOf/1/properties/data/properties/perUserDailyDepositLimit'
              perTransactionWithdrawLimit:
                $ref: '#/components/schemas/ProgramGet200Response/allOf/1/properties/data/properties/perUserDailyDepositLimit'
              perUserAccountCountMax:
                $ref: '#/components/schemas/HelixId'
              perUserDailyDepositLimit:
                type: object
                properties:
                  maximumAmount:
                    type: number
                    format: decimal
                  minimumAmount:
                    type: number
                    format: decimal
              perUserDailyWithdrawLimit:
                $ref: '#/components/schemas/ProgramGet200Response/allOf/1/properties/data/properties/perUserDailyDepositLimit'
              perUserExternalAccountCountMax:
                $ref: '#/components/schemas/HelixId'
              perUserMonthlyDepositLimit:
                $ref: '#/components/schemas/ProgramGet200Response/allOf/1/properties/data/properties/perUserDailyDepositLimit'
              perUserMonthlyWithdrawLimit:
                $ref: '#/components/schemas/ProgramGet200Response/allOf/1/properties/data/properties/perUserDailyDepositLimit'
              perUserTotalAccountBalanceMax:
                type: number
                format: decimal
              prepaidProducts:
                type: object
                deprecated: true
              products:
                type: array
                items:
                  type: object
                  properties:
                    balanceLimit:
                      $ref: '#/components/schemas/ProgramGet200Response/allOf/1/properties/data/properties/perUserDailyDepositLimit'
                    category:
                      type: string
                      enum:
                      - Prepaid
                      - Savings
                      - Checking
                      - Time Deposit
                      - Ecode
                    description:
                      type: string
                    interestRates:
                      type: array
                      items:
                        type: object
                        properties:
                          apr:
                            type: number
                            format: decimal
                          apy:
                            type: number
                            format: decimal
                          description:
                            type: string
                          effectiveDate:
                            $ref: '#/components/schemas/CustomerSetLastContact200Response/allOf/1/properties/data/items/properties/lastContactDate'
                          expireDate:
                            $ref: '#/components/schemas/CustomerSetLastContact200Response/allOf/1/properties/data/items/properties/lastContactDate'
                          maximumAmount:
                            type: number
                            format: decimal
                          minimumAmount:
                            type: number
                            format: decimal
                          productId:
                            $ref: '#/components/schemas/HelixId'
                          rateEffectiveDate:
                            $ref: '#/components/schemas/CustomerSetLastContact200Response/allOf/1/properties/data/items/properties/lastContactDate'
                          rateExpireDate:
                            $ref: '#/components/schemas/CustomerSetLastContact200Response/allOf/1/properties/data/items/properties/lastContactDate'
                          tier:
                            $ref: '#/components/schemas/HelixId'
                    isExternalWithdrawEnabled:
                      type: boolean
                    isInterestEnabled:
                      type: boolean
                    isRecurringContributionEnabled:
                      type: boolean
                    name:
                      type: string
                    perMonthRegDTransactionCountMaximum:
                      $ref: '#/components/schemas/HelixId'
                    perMonthRegDTransactionCountWithoutFee:
                      $ref: '#/components/schemas/HelixId'
                    perTransactionDepositLimit:
                      $ref: '#/components/schemas/ProgramGet200Response/allOf/1/properties/data/properties/perUserDailyDepositLimit'
                    perTransactionWithdrawLimit:
                      $ref: '#/components/schemas/ProgramGet200Response/allOf/1/properties/data/properties/perUserDailyDepositLimit'
                    productId:
                      $ref: '#/components/schemas/HelixId'
                    type:
                      $ref: '#/components/schemas/AccountObject200Response/allOf/1/properties/data/properties/type'
              publicKeyAlgorithms:
                type: string
              regDFeeAmount:
                type: number
                format: decimal
              regDMonthlyTransactionWithdrawCountMax:
                $ref: '#/components/schemas/HelixId'
              savingsProducts:
                type: object
                deprecated: true
              timeZone:
                type: string
              validAccountTypes:
                type: array
                items:
                  $ref: '#/components/schemas/AccountObject200Response/allOf/1/properties/data/properties/type'
              validProductTypes:
                type: array
                items:
                  $ref: '#/components/schemas/AccountObject200Response/allOf/1/properties/data/properties/type'
              verificationType:
                type: string
              website:
                type: string
    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
  parameters:
    PageSize:
      name: pageSize
      in: query
      required: false
      description: How many results to return on each page. Maximum is 200.
      schema:
        type: integer
        default: 200
        minimum: 0
        maximum: 200
    PageNumber:
      name: pageNumber
      in: query
      required: false
      description: Which page of the results to return. Use 0 to get the first page.
      schema:
        type: integer
        default: 0
        minimum: 0
        maximum: 200
  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