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

# Get Static PayID List

> Retrieve a comprehensive list of all Static Open PayIDs registered under your account. This endpoint allows for efficient management of Static PayIDs by providing options to filter the results based on customer-specific identifiers. You can filter by email, PayID, or customer ID to quickly locate and review relevant Static PayIDs.

Static Open PayIDs are reusable identifiers that link directly to customer details, streamlining future payment interactions and providing a persistent payment method. This list can be used to monitor, manage, and organise Static PayIDs within your account.




## OpenAPI

````yaml /api/openapi/v1-reference.yaml get /v1/customers/get_static_open_payids
openapi: 3.0.3
info:
  title: Payment APIs (AUD only)
  description: >-
    ## Introduction

    The Payment API Solution (AUD) offers developers a comprehensive suite of
    API services to build innovative AUD payment solutions efficiently. These
    APIs enable seamless transactions using various payment methods and
    functionalities, ensuring a robust, reliable, and scalable payment
    infrastructure tailored for the Australian market.

    ### Key Features

    - **Payment Methods**:
      - **Payment Link**: Supports payments via card and PayID.
      - **PayID**: Provides instant payments using a unique identifier.
      - **PayTo**: Enables scheduled or recurring payments.
      - **BSB/Account Number**: Allows direct bank transfers.
      - **Payout**: Manage payouts to designated accounts.

    - **Additional Functionalities**:
      - **Balance Management**: Real-time balance inquiries and updates.
      - **Reporting Services**: Generate detailed transaction and payment reports.

    This documentation provides detailed guidance for integrating these
    capabilities into your application.
  termsOfService: https://helloclever.co/terms
  contact:
    email: support@helloclever.co
  version: 1.0.11
servers:
  - url: https://api.cleverhub.co/api
    description: Sandbox Environment
  - url: https://api-merchant.helloclever.co/api
    description: Production Environment
security: []
paths:
  /v1/customers/get_static_open_payids:
    get:
      tags:
        - AUD PayID
      summary: Get Static PayID List
      description: >
        Retrieve a comprehensive list of all Static Open PayIDs registered under
        your account. This endpoint allows for efficient management of Static
        PayIDs by providing options to filter the results based on
        customer-specific identifiers. You can filter by email, PayID, or
        customer ID to quickly locate and review relevant Static PayIDs.


        Static Open PayIDs are reusable identifiers that link directly to
        customer details, streamlining future payment interactions and providing
        a persistent payment method. This list can be used to monitor, manage,
        and organise Static PayIDs within your account.
      operationId: getStaticOpenPayIDs
      parameters:
        - name: email
          in: query
          required: false
          schema:
            type: string
          description: >-
            Filter the list by the customer’s email address to retrieve
            associated Static PayIDs.
        - name: payid
          in: query
          required: false
          schema:
            type: string
          description: Filter the list by a specific PayID to retrieve matching records.
        - name: customer_id
          in: query
          required: false
          schema:
            type: string
          description: >-
            Filter the list by the customer’s unique ID to retrieve associated
            Static PayIDs.
      responses:
        '200':
          description: Static Open PayID list retrieved successfully.
          content:
            application/json:
              schema:
                type: object
                properties:
                  total:
                    type: integer
                    description: Total number of Static PayID records found.
                    example: 20
                  page:
                    type: integer
                    description: Current page of the results.
                    example: 1
                  total_page:
                    type: integer
                    description: Total number of pages available.
                    example: 1
                  records:
                    type: array
                    items:
                      type: object
                      properties:
                        id:
                          type: integer
                          description: Unique identifier for the Static PayID record.
                          example: 1
                        name:
                          type: string
                          description: Name associated with the Static PayID.
                          example: Sample Name
                        address:
                          type: string
                          description: Full address linked with the Static PayID.
                          example: 123 Sample Street
                        email:
                          type: string
                          description: Email address associated with the Static PayID.
                          example: user@example.com
                        city:
                          type: string
                          description: City of the customer.
                          example: Sample City
                        state_name:
                          type: string
                          description: State of the customer's location.
                          example: Sample State
                        zip_code:
                          type: string
                          description: Postal code of the customer’s location.
                          example: '12345'
                        static_payid:
                          type: string
                          description: The Static PayID associated with the customer.
                          example: samplepayid@example.com
                        external_id:
                          type: string
                          description: >-
                            Custom identifier set by the merchant to reference
                            the Static PayID.
                          example: ext-12345
                        status:
                          type: string
                          enum:
                            - active
                            - expired
                          description: Current status of the Static PayID.
                          example: active
        '400':
          description: Bad Request
        '401':
          description: Unauthorized
      security:
        - app-id: []
          secret-key: []
components:
  securitySchemes:
    app-id:
      type: apiKey
      in: header
      name: app-id
      description: |
        A unique identifier assigned to each application.
    secret-key:
      type: apiKey
      in: header
      name: secret-key
      description: |
        A secure token associated with the `app-id`.

````

## Related topics

- [Accept Instant Payments with AUD PayID](/developer-reference/api-use-cases/accept-instant-payments-with-aud-payid.md)
- [Create Static PayID](/api/aud-payid/create-static-payid.md)
- [Get PayID Status](/api/aud-payid/get-payid-status.md)
