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

# List Connected Accounts

> 返回与你的主账户关联的子账户分页列表。如果尚未创建任何子账户，则列表为空。关于主账户/子账户模型以及 `x-on-behalf-of` 用法，参见[关联账户](/zh/account-center/v1.6/guide/connected-accounts)。




## OpenAPI

````yaml /zh/account-center/v1.6/connect.yaml get /v1/accounts
openapi: 3.0.2
info:
  version: 0.0.1
  x-source-en-commit: d7dd912
  x-source-en-path: account-center/v1.6/connect.yaml
  title: Connect
  description: 这些 API 用于管理关联账户。
servers:
  - url: https://api-sandbox.uqpaytech.com/api
    description: Sandbox 基础 URL。
  - url: https://api.uqpay.com/api
    description: 生产环境基础 URL。
security: []
tags:
  - name: Account Center
    description: 在你的 UQPAY 账户下创建和管理子账户。
  - name: Accounts
    description: 借助 Connect，你可以为你的用户创建 UQPAY 账户。为此，你需要先注册你的平台。
  - name: Request for Information (RFI)
    description: 获取并回复在入驻或持续审查期间针对你的账户发起的信息索取请求（RFI）。
paths:
  /v1/accounts:
    get:
      tags:
        - Accounts
      summary: List Connected Accounts
      description: >
        返回与你的主账户关联的子账户分页列表。如果尚未创建任何子账户，则列表为空。关于主账户/子账户模型以及 `x-on-behalf-of`
        用法，参见[关联账户](/zh/account-center/v1.6/guide/connected-accounts)。
      operationId: list-connected-accounts
      parameters:
        - $ref: '#/components/parameters/PageSize'
        - $ref: '#/components/parameters/PageNumber'
      responses:
        '200':
          description: OK——成功获取账户列表。
          headers:
            x-response-id:
              $ref: '#/components/headers/XResponseId'
          content:
            application/json:
              schema:
                title: ListCardholdersResponse
                properties:
                  total_pages:
                    $ref: '#/components/schemas/TotalPages'
                  total_items:
                    $ref: '#/components/schemas/TotalItems'
                  data:
                    type: array
                    items:
                      oneOf:
                        - $ref: '#/components/schemas/AccountListResponse'
                          title: Company Account
                        - $ref: '#/components/schemas/IndividualAccountListResponse'
                          title: Individual Account
      security:
        - XAuthToken: []
components:
  parameters:
    PageSize:
      name: page_size
      description: 每页返回的最大条目数。该数值可介于 10 - 100 之间，默认为 10。
      in: query
      required: true
      schema:
        type: integer
        minimum: 1
        example: 10
    PageNumber:
      name: page_number
      description: 用于获取下一批条目的页码。该数值必须大于 1，默认为 1。
      in: query
      required: true
      schema:
        type: integer
        minimum: 1
        example: 1
  headers:
    XResponseId:
      description: 响应的全局唯一标识符（UUID v4）。在与 UQPAY 支持团队沟通时，有助于定位某个请求。
      schema:
        type: string
        format: uuid
        example: 2adba88e-9d63-44bc-b975-9b6ae3440dde
  schemas:
    TotalPages:
      type: integer
      example: 1
      description: 可用条目的总页数。
    TotalItems:
      type: integer
      example: 10
      description: 可用条目的总数。
    AccountListResponse:
      title: Company Account
      type: object
      description: 有关该企业账户的信息。
      properties:
        account_id:
          $ref: '#/components/schemas/AccountId'
        short_reference_id:
          type: string
          example: P220406-LLCVLRM
          description: 账户的短引用 ID。
        business_code:
          $ref: '#/components/schemas/ACCOUNTCENTER_BusinessType'
        email:
          type: string
          example: example@company.com
          description: 账户的电子邮箱地址。
          maxLength: 100
          format: email
        account_name:
          $ref: '#/components/schemas/AccountName'
        status:
          $ref: '#/components/schemas/AccountStatus'
        verification_status:
          $ref: '#/components/schemas/VerificationStatus'
        country:
          $ref: '#/components/schemas/Country'
        entity_type:
          allOf:
            - $ref: '#/components/schemas/EntityType'
            - type: string
              enum:
                - COMPANY
        contact_details:
          $ref: '#/components/schemas/ContactDetails'
        business_details:
          $ref: '#/components/schemas/ListBusinessDetails'
    IndividualAccountListResponse:
      title: Individual Account
      type: object
      description: 有关该个人账户的信息。
      properties:
        account_id:
          $ref: '#/components/schemas/AccountId'
        short_reference_id:
          $ref: '#/components/schemas/ShortReferenceId'
        business_code:
          $ref: '#/components/schemas/ACCOUNTCENTER_BusinessType'
        account_name:
          $ref: '#/components/schemas/AccountName'
        entity_type:
          allOf:
            - $ref: '#/components/schemas/EntityType'
            - type: string
              enum:
                - INDIVIDUAL
        status:
          $ref: '#/components/schemas/AccountStatus'
        verification_status:
          $ref: '#/components/schemas/VerificationStatus'
        review_reason:
          $ref: '#/components/schemas/ReviewReason'
        contact_details:
          $ref: '#/components/schemas/ContactDetails'
        person_details:
          type: object
          description: 个人账户持有人的个人信息。
          properties:
            first_name_english:
              $ref: '#/components/schemas/FirstNameEnglish'
            last_name_english:
              $ref: '#/components/schemas/LastNameEnglish'
            first_name:
              $ref: '#/components/schemas/FirstName'
            last_name:
              $ref: '#/components/schemas/LastName'
            nationality:
              $ref: '#/components/schemas/Nationality'
            date_of_birth:
              $ref: '#/components/schemas/DateOfBirth'
            tax_number:
              $ref: '#/components/schemas/TaxNumber'
            monthly_estimated_revenue:
              $ref: '#/components/schemas/MonthlyEstimatedRevenue'
            other_purpose:
              $ref: '#/components/schemas/OtherPurpose'
            account_purpose:
              $ref: '#/components/schemas/IndividualAccountPurpose'
            identification:
              type: object
              description: 该个人的身份证件信息。
              required:
                - type
                - id_number
                - documents
              properties:
                type:
                  $ref: '#/components/schemas/IdentificationType'
                id_number:
                  $ref: '#/components/schemas/IdentificationIdNumber'
                remark:
                  $ref: '#/components/schemas/IdentificationRemark'
                documents:
                  $ref: '#/components/schemas/NoTypeDocuments'
    AccountId:
      type: string
      example: f5bb6498-552e-40a5-b14b-616aa04ac1c1
      description: 账户的唯一标识符。
    ACCOUNTCENTER_BusinessType:
      type: array
      example:
        - BANKING
      description: |
        该账户的业务类型。
      items:
        type: string
        enum:
          - BANKING
          - ACQUIRING
          - ISSUING
          - RAMP
    AccountName:
      type: string
      example: UQPAY PTE LTD.
      description: 该账户的客户名称。
    AccountStatus:
      type: string
      example: PROCESSING
      description: |
        账户的状态。为以下之一：

          * ACTIVE - 账户已激活。
          * PROCESSING - 账户当前正在审核和处理中。
          * INACTIVE - 账户暂时未激活
          * CLOSED - 账户已关闭。
    VerificationStatus:
      type: string
      example: APPROVED
      enum:
        - APPROVED
        - PENDING
        - REJECT
        - EXPIRED
        - RETURN
      description: |
        KYC/KYB 的状态。为以下之一：

          * REJECT - 账户在身份验证过程中被拒绝。
          * APPROVED - 账户已通过验证且处于激活状态。
          * PENDING - 账户当前正在进行身份验证。
          * EXPIRED - 验证已过期。
          * RETURN - 账户已被退回以进行身份验证，需要重新上传。

          **Webhook 说明：** 在 `accountStatus` webhook 通知中，这两个状态
          分别以 `REJECTED` 和 `RETURNED` 下发（而非 `REJECT` / `RETURN`）。
          其他所有值均相同。参见
          [账户状态 webhook](/zh/account-center/v1.6/webhooks/account-status)。
    Country:
      type: string
      description: >-
        两位字母国家/地区代码 [ISO 3166-1
        alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)。
      maxLength: 2
      example: US
    EntityType:
      type: string
      description: |
        账户类型。
        此字段为必填，且必须是以下之一：
          * `COMPANY` - 为从事商业活动而设立的实体。
          * `INDIVIDUAL` - 来自业务场景的单一个人。**目前仅适用于 Banking。**
      enum:
        - COMPANY
        - INDIVIDUAL
    ContactDetails:
      type: object
      required:
        - email
        - phone
      properties:
        email:
          type: string
          maxLength: 100
          example: example@company.com
          description: 账户的电子邮箱地址。此项仅用于方便你识别该账户。
          format: email
        phone:
          $ref: '#/components/schemas/Phone'
    ListBusinessDetails:
      type: object
      description: 公司账户列表中的业务摘要。字段有值时返回；完整业务信息请查询账户详情。
      properties:
        legal_entity_name: 9c5304fb-c643-4815-b70e-67421ce74951
        incorporation_date: 14e3a72a-e155-4a0b-b896-70173dd56d66
        registration_number: 3644b7b3-af21-41bf-8793-08b53f942605
        merchant_category_code: 833dff16-15e9-4d7a-add6-9eae18f6fbd0
    ShortReferenceId:
      type: string
      example: P220406-LLCVLRM
      description: 账户的短引用 ID。
    ReviewReason:
      type: string
      example: The account is not compliant with the company's policies.
    FirstNameEnglish:
      type: string
      example: John
      description: 该个人的英文名字。应与护照等官方英文证件上显示的姓名一致。
    LastNameEnglish:
      type: string
      example: Doe
      description: 该个人的英文姓氏。应与护照等官方英文证件上显示的姓名一致。
    FirstName:
      type: string
      example: 三
      description: 该个人母语形式的名字。
    LastName:
      type: string
      example: 张
      description: 该个人母语形式的姓氏。
    Nationality:
      type: string
      maxLength: 2
      description: 两位字母 ISO 3166-2 国家/地区代码
      example: US
    DateOfBirth:
      type: string
      format: date
      example: '1990-01-01'
      description: 该个人的出生日期，格式为 YYYY-MM-DD。
    TaxNumber:
      type: string
      example: 123-45-6789
    MonthlyEstimatedRevenue:
      type: object
      required:
        - amount
        - currency
      properties:
        amount:
          type: string
          example: TM001
          description: |
            当月的业务总收入，必须是以下之一：
              * `TM001` - 低于 50,000。
              * `TM002` - 50,000 至 100,000。
              * `TM003` - 100,000 至 250,000。
              * `TM004` - 250,000 至 500,000。
              * `TM005` - 超过 500,000。
          enum:
            - TM001
            - TM002
            - TM003
            - TM004
            - TM005
        currency:
          type: string
          description: >-
            币种代码
            [ISO_4217](https://en.wikipedia.org/wiki/ISO_4217#List_of_ISO_4217_currency_codes)。
          maxLength: 3
          example: SGD
    OtherPurpose:
      type: string
      description: 当 `account_purpose = OTHERS` 时必填。用于提供有关账户用途的更多信息的补充文本。
    IndividualAccountPurpose:
      type: array
      description: |
        账户的使用用途。选择一个或多个适用的持有和使用账户的理由。如果选择了 `OTHERS`，请提供额外说明。

        - `PURCHASE`：带发票的个人需求付款。
        - `BILL_PAYMENT`：缴纳公用事业费。
        - `EDUCATIONAL_EXPENSES`：用于支付海外学费、住宿费或其他教育费用。
        - `PERSONAL_REMITTANCE`：汇给海外亲友用于个人开支的资金。
        - `LOAN_REPAYMENT`：为偿还另一国家/地区的贷款或债务而进行的转账。
        - `INVESTMENT`：与投资活动相关的转账，例如为境外投资或投资国际金融产品提供资金。
        - `CHARITABLE_DONATION`：为境外慈善事业或非营利组织汇出的款项。
        - `OTHERS`：请详细说明用途。
      items:
        type: string
        enum:
          - PURCHASE
          - BILL_PAYMENT
          - EDUCATIONAL_EXPENSES
          - PERSONAL_REMITTANCE
          - LOAN_REPAYMENT
          - INVESTMENT
          - CHARITABLE_DONATION
          - OTHERS
    IdentificationType:
      type: string
      enum:
        - PASSPORT
        - NATIONAL_ID
        - DRIVERS_LICENSE
      example: PASSPORT
      description: 身份证件的类型。
    IdentificationIdNumber:
      type: string
      example: A12345678
      description: 该个人的证件号码。
    IdentificationRemark:
      type: string
      example: Valid until 2030
    NoTypeDocuments:
      type: object
      description: |
        用于验证身份的法律文件。
        对于每一面（正面/背面），`*_file_id`、`*` 中只需提供其一。
      properties:
        front:
          type: string
          format: base64-encoded
          example: >-
            data:image/png;base64,TG9yZW0gaXBzdW0gZG9sb3Igc2l0IGFtZXQsIGNvbnNlY3RldHVyIGFkaXBpc2NpbmcgZWxpdC4=
          description: 证件正面，必须以类似 "data:image/jpeg;base64," 的前缀开头，后接实际的 base64 编码内容。
        front_file_id:
          type: string
          format: uuid
          example: 5135e6cc-28b6-4889-81dc-3b86a09e1395
          description: 正面文件的文件 ID，文件 ID 由文件上传 API 生成。
        back:
          type: string
          format: base64-encoded
          example: >-
            data:image/png;base64,TG9yZW0gaXBzdW0gZG9sb3Igc2l0IGFtZXQsIGNvbnNlY3RldHVyIGFkaXBpc2NpbmcgZWxpdC4=
          description: >-
            除护照外，所有证件类型都需要提供证件背面，且必须以类似 "data:image/jpeg;base64," 的前缀开头，后接实际的
            base64 编码内容。
        back_file_id:
          type: string
          format: uuid
          example: 5135e6cc-28b6-4889-81dc-3b86a09e1395
          description: 背面文件的文件 ID，文件 ID 由文件上传 API 生成。
    Phone:
      type: string
      example: '+6588880000'
      description: 账户的电话号码。
  securitySchemes:
    XAuthToken:
      type: apiKey
      in: header
      name: x-auth-token
      description: 由 UQPAY 提供的登录 API Token。

````

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