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

# List Collection Accounts

> Returns a paginated list of collection accounts.



## OpenAPI

````yaml get /v3/collection_account
openapi: 3.1.0
info:
  title: sandbox
  version: '3'
servers:
  - url: https://service-sandbox.tazapay.com
security:
  - sec0: []
paths:
  /v3/collection_account:
    get:
      summary: List Collection Accounts
      description: Returns a paginated list of collection accounts.
      operationId: list-collection-accounts
      parameters:
        - name: ending_before
          in: query
          description: A cursor for pagination. Returns objects before this object ID.
          schema:
            type: string
        - name: limit
          in: query
          description: Number of objects to return. Default is 10, range 1-100.
          schema:
            type: integer
        - name: starting_after
          in: query
          description: A cursor for pagination. Returns objects after this object ID.
          schema:
            type: string
        - name: payment_method_type
          in: query
          description: Filter by payment method type.
          schema:
            type: string
        - name: country
          in: query
          description: Filter by country.
          schema:
            type: string
        - name: currencies
          in: query
          description: Filter by currencies (ISO format).
          schema:
            type: array
            items:
              type: string
        - name: on_behalf_of
          in: query
          description: Filter by the entity ID that the account is configured on behalf of.
          schema:
            type: string
        - name: status
          in: query
          description: Filter by collection account status.
          schema:
            type: string
            enum:
              - disabled
              - enabled
        - name: type
          in: query
          description: Filter by type (virtual_account or wallet).
          schema:
            type: string
            enum:
              - virtual_account
              - wallet
        - name: created
          in: query
          description: >-
            Filter by creation time. Pass an object with any of gt, gte, lt, lte
            (Unix timestamps).
          style: deepObject
          explode: true
          schema:
            type: object
            properties:
              gt:
                type: integer
                description: Greater than (Unix timestamp).
              gte:
                type: integer
                description: Greater than or equal to (Unix timestamp).
              lt:
                type: integer
                description: Less than (Unix timestamp).
              lte:
                type: integer
                description: Less than or equal to (Unix timestamp).
      responses:
        '200':
          description: List of collection accounts.
          content:
            application/json:
              schema:
                type: object
                properties:
                  object:
                    type: string
                    description: Always "list".
                  has_more:
                    type: boolean
                    description: Whether there are more results beyond this page.
                  data:
                    type: array
                    description: Array of collection account objects.
                    items:
                      $ref: '#/components/schemas/CollectionAccount'
              examples:
                Result:
                  value:
                    object: list
                    has_more: false
                    data:
                      - id: cva_crqinja9chqqs7moi8rg
                        object: collection_account
                        type: virtual_account
                        payment_method_type: local_bank_transfer_cad
                        country: CA
                        currencies:
                          - CAD
                        status: enabled
                        alias: CAD Collection Account
                        virtual_account:
                          account_holder_name: John Doe
                          account_number: 1234567890-56-7890
                          bank_name: RBC Royal Bank
                          bank_codes:
                            routing_code: '026009593'
                            swift_code: ROYCCAT2
                        created_at: '2024-09-26T09:39:25.03501Z'
                        updated_at: '2024-09-26T09:39:25.03501Z'
components:
  schemas:
    CollectionAccount:
      type: object
      description: Represents a collection account (virtual account or stablecoin wallet).
      properties:
        id:
          type: string
          description: >-
            Unique identifier. Starts with cva_ (virtual account), cwa_
            (wallet), or cta_.
        object:
          type: string
          description: Always "collection_account".
        type:
          type: string
          enum:
            - virtual_account
            - wallet
          description: Type of collection account.
        description:
          type: string
          description: Usecase description for this account.
        on_behalf_of:
          type: string
          description: ID of the entity this account is configured on behalf of.
        country:
          type: string
          description: Country in which the account is opened (ISO 3166 alpha-2).
        currencies:
          type: array
          items:
            type: string
          description: List of currencies enabled for this account.
        payment_method_type:
          type: string
          description: Type of payment method for this account.
        virtual_account:
          type: object
          description: Virtual account bank details. Present when type is virtual_account.
          properties:
            account_holder_name:
              type: string
              description: Name of the account holder.
            account_number:
              type: string
              description: Account number.
            iban:
              type: string
              description: IBAN (if applicable).
            bank_name:
              type: string
              description: Name of the bank.
            bank_branch:
              type: string
              description: Branch name.
            bank_address:
              type: object
              description: Address of the bank.
              properties:
                address_line_1:
                  type: string
                address_line_2:
                  type: string
                city:
                  type: string
                country:
                  type: string
            bank_codes:
              type: object
              description: >-
                Bank codes (e.g. swift_code, routing_code, sort_code,
                ach_routing_number, etc.).
              additionalProperties:
                type: string
            account_reenablement_supported:
              type: boolean
              description: Whether the account can be re-enabled after being disabled.
        wallet:
          type: object
          description: Wallet details. Present when type is wallet.
          properties:
            type:
              type: string
              description: Blockchain type (e.g. Ethereum, Tron, Solana).
            deposit_address:
              type: string
              description: Deposit address for the wallet.
        status:
          type: string
          enum:
            - disabled
            - enabled
          description: Current status of the collection account.
        requests:
          type: array
          description: >-
            Enablement, disablement, or reenablement requests attached to this
            account.
          items:
            $ref: '#/components/schemas/CollectionAccountRequest'
        status_description:
          type: string
          description: Description of the current status (e.g. disablement reason).
        alias:
          type: string
          description: Nickname for the account.
        balance_transaction:
          type: string
          description: ID of the balance transaction linked to this collection account.
        metadata:
          type: object
          description: Key-value pairs attached to the collection account.
        created_at:
          type: string
          format: date-time
          description: Timestamp when the account was created.
        updated_at:
          type: string
          format: date-time
          description: Timestamp when the account was last updated.
    CollectionAccountRequest:
      type: object
      description: >-
        An enablement, disablement, or reenablement request attached to a
        collection account.
      properties:
        id:
          type: string
          description: Unique ID of the request.
        object:
          type: string
          description: Always "collection_account_request".
        collection_account_id:
          type: string
          description: ID of the linked collection account.
        type:
          type: string
          enum:
            - enablement
            - disablement
            - reenablement
          description: Type of request.
        status:
          type: string
          enum:
            - processing
            - approval_hold
            - requires_action
            - succeeded
            - failed
            - cancelled
          description: Current status of the request.
        requested_currencies:
          type: array
          items:
            type: string
          description: >-
            Currencies requested for enablement (present on enablement
            requests).
        created_at:
          type: string
          format: date-time
          description: Timestamp when the request was created.
        updated_at:
          type: string
          format: date-time
          description: Timestamp when the request was last updated.
        status_description:
          type: string
          description: Description of the current status or failure reason.
  securitySchemes:
    sec0:
      type: http
      scheme: basic

````