> ## Documentation Index
> Fetch the complete documentation index at: https://docs.worthai.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Banking Information

> Retrieve banking information for a particular business.



## OpenAPI

````yaml get /banking/business/{businessID}
openapi: 3.1.0
info:
  title: Banking Information Details
  description: >-
    Retrieves comprehensive banking information for a specified business,
    including connected bank accounts, current and available balances, routing
    details, and recent transaction history
  contact: {}
  version: '1.0'
servers:
  - url: https://api.joinworth.com/integration/api/v1
    variables: {}
security: []
paths:
  /banking/business/{businessID}:
    parameters: []
    get:
      tags:
        - Banking
      summary: Banking Information Details
      description: Retrieve banking information for a particular business.
      operationId: BusinessBankingInformation
      parameters:
        - name: businessID
          in: path
          description: >-
            The unique identifier of the business to retrieve banking
            information for.
          required: true
          style: simple
          schema:
            type: string
            examples:
              - 23e916f6-e681-43f7-8c79-23a0e6ceb391
      responses:
        '200':
          description: OK
          headers:
            Date:
              content:
                text/plain:
                  schema:
                    type: string
                    contentMediaType: text/plain
                  example: Fri, 28 Feb 2025 11:26:29 GMT
            Content-Length:
              content:
                text/plain:
                  schema:
                    type: string
                    contentMediaType: text/plain
                  example: '1422'
            Connection:
              content:
                text/plain:
                  schema:
                    type: string
                    contentMediaType: text/plain
                  example: keep-alive
            Content-Security-Policy:
              content:
                text/plain:
                  schema:
                    type: string
                    contentMediaType: text/plain
                  example: >-
                    default-src 'self';base-uri 'self';font-src 'self' https:
                    data:;form-action 'self';frame-ancestors 'self';img-src
                    'self' data:;object-src 'none';script-src
                    'self';script-src-attr 'none';style-src 'self' https:
                    'unsafe-inline';upgrade-insecure-requests
            Cross-Origin-Opener-Policy:
              content:
                text/plain:
                  schema:
                    type: string
                    contentMediaType: text/plain
                  example: same-origin
            Cross-Origin-Resource-Policy:
              content:
                text/plain:
                  schema:
                    type: string
                    contentMediaType: text/plain
                  example: same-origin
            Origin-Agent-Cluster:
              content:
                text/plain:
                  schema:
                    type: string
                    contentMediaType: text/plain
                  example: '?1'
            Referrer-Policy:
              content:
                text/plain:
                  schema:
                    type: string
                    contentMediaType: text/plain
                  example: no-referrer
            Strict-Transport-Security:
              content:
                text/plain:
                  schema:
                    type: string
                    contentMediaType: text/plain
                  example: max-age=15552000; includeSubDomains
            X-Content-Type-Options:
              content:
                text/plain:
                  schema:
                    type: string
                    contentMediaType: text/plain
                  example: nosniff
            X-DNS-Prefetch-Control:
              content:
                text/plain:
                  schema:
                    type: string
                    contentMediaType: text/plain
                  example: 'off'
            X-Download-Options:
              content:
                text/plain:
                  schema:
                    type: string
                    contentMediaType: text/plain
                  example: noopen
            X-Frame-Options:
              content:
                text/plain:
                  schema:
                    type: string
                    contentMediaType: text/plain
                  example: SAMEORIGIN
            X-Permitted-Cross-Domain-Policies:
              content:
                text/plain:
                  schema:
                    type: string
                    contentMediaType: text/plain
                  example: none
            X-XSS-Protection:
              content:
                text/plain:
                  schema:
                    type: string
                    contentMediaType: text/plain
                  example: '0'
            Vary:
              content:
                text/plain:
                  schema:
                    type: string
                    contentMediaType: text/plain
                  example: Origin
            Access-Control-Allow-Credentials:
              content:
                text/plain:
                  schema:
                    type: string
                    contentMediaType: text/plain
                  example: 'true'
            ETag:
              content:
                text/plain:
                  schema:
                    type: string
                    contentMediaType: text/plain
                  example: W/"58e-6iO8AFzxA2ctFVUAAop70CjggZc"
          content:
            application/json; charset=utf-8:
              schema:
                $ref: '#/components/schemas/Success5'
              examples:
                default:
                  summary: Banking information for a business
                  value:
                    status: success
                    message: Banking information fetched successfully.
                    data:
                      - id: 5db79f51-f712-4a1e-9414-4b10fa27cc95
                        business_integration_task_id: 9825dd49-72a1-4ad8-806a-e516f4f1131e
                        bank_account: '1111222233330000'
                        bank_name: Business Checking
                        official_name: Business Gold Interest Checking
                        institution_name: First National Bank
                        verification_status: VERIFIED
                        balance_current: '110.00'
                        balance_available: '100.00'
                        balance_limit: '0'
                        currency: USD
                        type: depository
                        subtype: checking
                        mask: '0000'
                        created_at: '2026-03-23T14:51:53.335Z'
                        routing_number: U2FsdGVkX1+3cLnEmf6eR58JsRMTlINKXMnbbJ+w1TI=
                        wire_routing_number: U2FsdGVkX1+WXlPZC+JZPtF+rAWb/Q6yrc5lZIQtFqc=
                        deposit_account: true
                        is_selected: false
                        is_additional_account: false
                        account_holder_name: null
                        account_holder_type: null
                        average_balance: -416.94
                        transactions:
                          - id: 2f013916-d1eb-40e9-8b8e-aeada4f4802d
                            bank_account_id: 5db79f51-f712-4a1e-9414-4b10fa27cc95
                            business_integration_task_id: 9825dd49-72a1-4ad8-806a-e516f4f1131e
                            transaction_id: JDGeRegXwph5KX6GJq6JIAvggxpBPjtByWM65
                            date: '2026-03-15T00:00:00.000Z'
                            amount: '5.4'
                            description: Uber 063015 SF**POOL**
                            payment_metadata:
                              by_order_of: null
                              payee: null
                              payer: null
                              payment_method: null
                              payment_processor: null
                              ppd_id: null
                              reason: null
                              reference_number: null
                            currency: USD
                            category: Travel,Taxi
                            payment_type: special
                            is_pending: false
                            created_at: '2026-03-23T14:51:58.224Z'
                            merchant_name: Uber
                        balances:
                          - year: 2026
                            month: 1
                            balance: -695.48
                            bank_account_id: 5db79f51-f712-4a1e-9414-4b10fa27cc95
                            currency: USD
                            created_at: '2026-03-23T14:51:56.739Z'
                            updated_at: null
                        match: false
                        depositAccountInfo:
                          accounts:
                            - account_id: d4959d3e-82c6-40ce-868a-1b07a1b6baeb
                              balances:
                                available: null
                                current: null
                                limit: null
                              mask: '9376'
                              name: Bank of America
                              official_name: Bank of America
                              subtype: Checking
                              type: additional_accounts
                              account_holder_name: null
                              account_holder_type: null
                              institution_name: ACH
                              verification_status: VERIFIED
                          numbers:
                            ach:
                              - account: '3250211139376'
                                account_number: U2FsdGVkX1/Y/ilypReDU1R8rAPy2rZg7u4L2uwEpms=
                                account_id: d4959d3e-82c6-40ce-868a-1b07a1b6baeb
                                routing: '121000358'
                                wire_routing: '121000358'
                            bacs: []
                            eft: []
                            international: []
                        verification_result:
                          id: 268c89b1-593d-42c4-98ae-c2d13da061d8
                          verification_status: SUCCESS
                          created_at: '2025-09-23T17:55:15.331Z'
                          updated_at: '2025-09-23T17:55:15.331Z'
                          account_verification_response:
                            name: Invalid Routing Number
                            code: GS01
                            description: >-
                              Invalid Routing Number - The routing number
                              supplied did not match the format of a valid
                              routing number.
                            verification_response: Declined
                          account_authentication_response:
                            name: null
                            code: null
                            description: null
                            verification_response: null
                        ach_account_id: ecb698c5-6cfd-4a39-935e-d228ab2cb30d
                        routing: '011401533'
                        wire_routing: '021000021'
                        bank_detail: null
      deprecated: false
      security:
        - bearer: []
      servers:
        - url: https://api.joinworth.com/integration/api/v1
          variables: {}
components:
  schemas:
    Success5:
      title: Success5
      type: object
      properties:
        status:
          type: string
          description: The status of the API response (e.g., success, error).
        message:
          type: string
          description: >-
            A human-readable message providing additional context about the API
            response.
        data:
          type: array
          items:
            $ref: '#/components/schemas/Data3'
          description: >-
            An array containing the banking data records retrieved for the
            business.
    Data3:
      title: Data3
      type: object
      properties:
        id:
          type: string
          description: Unique identifier for the bank account record.
        business_integration_task_id:
          type: string
          description: Unique identifier linking to the specific business integration task.
        bank_account:
          type: string
          description: The masked or full bank account number.
        bank_name:
          type: string
          description: The general or common name of the bank or integration provider.
        official_name:
          type: string
          description: The official or legal name of the bank account product.
        institution_name:
          type: string
          description: The name of the financial institution holding the account.
        account_holder_name:
          type:
            - string
            - 'null'
          description: The name of the individual or entity holding the account.
        account_holder_type:
          type:
            - string
            - 'null'
          description: The type of entity holding the account (e.g., individual, business).
        verification_status:
          type:
            - string
            - 'null'
          description: The current verification status of the bank account.
        balance_limit:
          type: string
          description: The maximum balance or credit limit associated with the account.
        balance_current:
          type: string
          description: >-
            The total current balance of the account, which may include pending
            transactions that have not yet fully settled.
        balance_available:
          type: string
          description: >-
            The total amount of funds in the account that are immediately
            available for withdrawal or transfer, excluding any pending
            transactions or holds.
        currency:
          type: string
          description: The three-letter ISO currency code for the account.
        type:
          type: string
          description: The broad category of the account (e.g., depository, credit).
        subtype:
          type: string
          description: The specific subtype of the account (e.g., checking, savings).
        mask:
          type: string
          description: The last few digits of the account number used for display purposes.
        created_at:
          type: string
          description: The timestamp indicating when the record was created.
        routing_number:
          type:
            - string
            - 'null'
          description: The primary routing number associated with the account.
        wire_routing_number:
          type:
            - string
            - 'null'
          description: The specific routing number used for wire transfers.
        deposit_account:
          type: boolean
          description: Indicates whether the account can accept deposits.
        is_selected:
          type: boolean
          description: >-
            Indicates whether this account is currently selected as primary or
            active.
        is_additional_account:
          type: boolean
          description: Indicates whether this is an auxiliary or additional account.
        average_balance:
          type:
            - string
            - 'null'
          description: The calculated average balance of the account over a defined period.
        transactions:
          type: array
          items:
            $ref: '#/components/schemas/Transaction'
          description: A list of transaction records associated with the bank account.
        balances:
          type: array
          items:
            $ref: '#/components/schemas/Balance'
          description: >-
            A historical record of account balances categorized by month and
            year.
        match:
          type: boolean
          description: >-
            Indicates if the account details match the expected business
            verification criteria.
        depositAccountInfo:
          type:
            - object
            - 'null'
          description: >-
            Detailed routing and account number information specifically for
            deposit purposes.
          properties:
            accounts:
              type: array
              description: List of related accounts under this deposit profile.
              items:
                type: object
                properties:
                  account_id:
                    type: string
                    description: Unique identifier for the deposit account.
                  mask:
                    type: string
                    description: Masked account number for display.
                  name:
                    type: string
                    description: Display name of the deposit account.
                  official_name:
                    type: string
                    description: Official product name of the deposit account.
                  type:
                    type: string
                    description: Category of the deposit account.
                  account_holder_name:
                    type:
                      - string
                      - 'null'
                    description: Name of the deposit account holder.
                  account_holder_type:
                    type:
                      - string
                      - 'null'
                    description: Entity type of the deposit account holder.
                  subtype:
                    type: string
                    description: Specific subtype of the deposit account.
                  institution_name:
                    type: string
                    description: Financial institution for the deposit account.
                  verification_status:
                    type: string
                    description: Verification status of the deposit account.
                  balances:
                    type: object
                    description: >-
                      Available, current, and limit balances for the deposit
                      account.
                    properties:
                      available:
                        type:
                          - string
                          - 'null'
                        description: The available funds for withdrawal.
                      current:
                        type:
                          - string
                          - 'null'
                        description: The total balance including pending transactions.
                      limit:
                        type:
                          - string
                          - 'null'
                        description: The credit limit, if applicable.
            numbers:
              type: object
              description: >-
                Routing and account number details categorized by transfer
                network.
              properties:
                ach:
                  type: array
                  description: Automated Clearing House (ACH) network routing details.
                  items:
                    type: object
                    properties:
                      account:
                        type:
                          - string
                          - 'null'
                        description: The ACH account number.
                      account_number:
                        type:
                          - string
                          - 'null'
                        description: The encrypted or raw account number for ACH.
                      account_id:
                        type:
                          - string
                          - 'null'
                        description: The internal identifier for this ACH setup.
                      routing:
                        type:
                          - string
                          - 'null'
                        description: The ACH routing transit number.
                      wire_routing:
                        type:
                          - string
                          - 'null'
                        description: The routing number for wire transfers.
                bacs:
                  type: array
                  description: BACS payment network details (UK).
                eft:
                  type: array
                  description: Electronic Funds Transfer (EFT) details (Canada).
                international:
                  type: array
                  description: International wire transfer details (e.g., SWIFT/IBAN).
        verification_result:
          type:
            - object
            - 'null'
          description: Detailed outcome of the bank account verification process.
          properties:
            id:
              type: string
              description: Unique identifier for the verification result.
            verification_status:
              type: string
              description: Overall status of the verification attempt.
            created_at:
              type: string
              description: Timestamp indicating when the verification result was generated.
            updated_at:
              type: string
              description: >-
                Timestamp indicating when the verification result was last
                updated.
            account_verification_response:
              type:
                - object
              description: Response details from the account verification service.
              properties:
                name:
                  type:
                    - string
                    - 'null'
                  description: Name or category of the verification response.
                code:
                  type:
                    - string
                    - 'null'
                  description: Status or error code returned by the verification service.
                description:
                  type:
                    - string
                    - 'null'
                  description: Detailed explanation of the verification response code.
                verification_response:
                  type:
                    - string
                    - 'null'
                  description: The final decision or state of the verification.
            account_authentication_response:
              type:
                - object
              description: Response details regarding account holder authentication.
              properties:
                name:
                  type:
                    - string
                    - 'null'
                  description: Name or category of the authentication response.
                code:
                  type:
                    - string
                    - 'null'
                  description: Status or error code for the authentication.
                description:
                  type:
                    - string
                    - 'null'
                  description: Detailed explanation of the authentication response.
                verification_response:
                  type:
                    - string
                    - 'null'
                  description: The final decision or state of the authentication.
        ach_account_id:
          type:
            - string
            - 'null'
          description: Unique identifier specific to the ACH account details.
        routing:
          type:
            - string
            - 'null'
          description: The primary routing number associated with the account.
        wire_routing:
          type:
            - string
            - 'null'
          description: The routing number specifically designated for wire transfers.
        bank_detail:
          type:
            - object
            - 'null'
          description: >-
            Bank-level details (bank name, branch, BIC, sort code, address, and
            phone numbers). Only populated for UK-based bank accounts.
          example: null
          properties:
            bank_name:
              type: string
              description: The name of the bank.
            branch_name:
              type: string
              description: The name of the bank branch.
            bic:
              type: string
              description: The Bank Identifier Code (BIC/SWIFT) for the bank.
            sort_code:
              type: string
              description: The bank's sort code.
            address:
              type: object
              description: >-
                The bank's own address. `type`, `is_primary`, `country`, and
                `script_variant` are omitted, since the naming standard's `type`
                enum has no value for a bank's own address and this enrichment
                doesn't return a country.
              properties:
                line1:
                  type: string
                line2:
                  type: string
                line3:
                  type: string
                  description: >-
                    A third address line for UK bank addresses; its relationship
                    to line2 (e.g., a sub-building name or district) isn't
                    well-defined, so it isn't merged into line2.
                city:
                  type: string
                region:
                  type: string
                postal_code:
                  type: string
            phone_number:
              type: string
              description: The bank's primary phone number.
            phone_numbers:
              type: array
              items:
                type: string
              description: Additional phone numbers associated with the bank.
      examples: []
    Transaction:
      title: Transaction
      type: object
      properties:
        id:
          type: string
          description: Unique internal identifier for the transaction record.
        bank_account_id:
          type: string
          description: Identifier of the bank account associated with this transaction.
        business_integration_task_id:
          type: string
          description: Identifier linking the transaction to a business integration task.
        transaction_id:
          type: string
          description: >-
            The unique transaction identifier provided by the banking
            institution.
        date:
          type: string
          description: The date when the transaction occurred.
        amount:
          type: string
          description: The monetary value of the transaction.
        description:
          type: string
          description: A brief narrative or memo describing the transaction.
        payment_metadata:
          $ref: '#/components/schemas/PaymentMetadata'
          description: >-
            Additional metadata relating to the payment method and parties
            involved.
        currency:
          type: string
          description: The three-letter ISO currency code for the transaction amount.
        category:
          type: string
          description: >-
            The classification or category of the transaction (e.g., Travel,
            Dining).
        payment_type:
          type: string
          description: The type of payment executed (e.g., special, recurring).
        is_pending:
          type: boolean
          description: Indicates whether the transaction is still pending settlement.
        created_at:
          type: string
          description: The timestamp indicating when the transaction record was stored.
        merchant_name:
          type: string
          description: The recognized name of the merchant involved in the transaction.
      examples:
        - id: 0b6cf553-b2a2-4854-ab7d-021a1b90b8b1
          bank_account_id: e362901d-0e10-40bf-9e54-41978dc585e0
          business_integration_task_id: 05c469a2-87bf-484e-9973-591eb5ee0b61
          transaction_id: mV96Evx6X1Hr97jewxp9hNwJQp7j6EfgZxP6a
          date: '2024-09-04T00:00:00.000Z'
          amount: '6.33'
          description: Uber 072515 SF**POOL**
          payment_metadata:
            by_order_of: null
            payee: null
            payer: null
            payment_method: null
            payment_processor: null
            ppd_id: null
            reason: null
            reference_number: null
          currency: USD
          category: Travel,Taxi
          payment_type: special
          is_pending: false
          created_at: '2024-09-11T13:43:54.617Z'
          merchant_name: Uber
    Balance:
      title: Balance
      type: object
      properties:
        year:
          type: integer
          contentEncoding: int32
          description: The calendar year for the recorded balance.
        month:
          type: integer
          contentEncoding: int32
          description: The month of the year (1-12) for the recorded balance.
        balance:
          type: number
          description: The calculated account balance at the specified period.
        bank_account_id:
          type: string
          description: The identifier of the bank account associated with this balance.
        currency:
          type: string
          description: The three-letter ISO currency code of the balance.
        created_at:
          type: string
          description: The timestamp indicating when the balance record was created.
        updated_at:
          type:
            - string
            - 'null'
          description: The timestamp indicating when the balance record was last modified.
      examples:
        - year: 2024
          month: 9
          balance: 121.73
          bank_account_id: e362901d-0e10-40bf-9e54-41978dc585e0
          currency: USD
          created_at: '2024-09-11T13:43:55.144Z'
          updated_at: null
    PaymentMetadata:
      title: PaymentMetadata
      type: object
      properties:
        by_order_of:
          type:
            - string
            - 'null'
          description: The entity that initiated the payment order.
        payee:
          type:
            - string
            - 'null'
          description: The recipient of the payment.
        payer:
          type:
            - string
            - 'null'
          description: The sender of the payment.
        payment_method:
          type:
            - string
            - 'null'
          description: The method used to execute the payment (e.g., ACH, card).
        payment_processor:
          type:
            - string
            - 'null'
          description: The external processor handling the payment.
        ppd_id:
          type:
            - string
            - 'null'
          description: Prearranged Payment and Deposit (PPD) identifier.
        reason:
          type:
            - string
            - 'null'
          description: The stated reason or purpose for the payment.
        reference_number:
          type:
            - string
            - 'null'
          description: A reference number provided for the payment transaction.
      examples:
        - by_order_of: null
          payee: null
          payer: null
          payment_method: null
          payment_processor: null
          ppd_id: null
          reason: null
          reference_number: null

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.