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

# List Balances Transactions

> 返回影响你账户余额的交易列表，包括扣款、手续费及其他调整。你可以通过指定时间范围来筛选结果。如果未提供时间范围，或仅指定结束日期，返回结果将包含截至今天或指定结束日期前 30 天内的交易。



## OpenAPI

````yaml /zh/global-account/v1.6/banking.yaml get /v1/balances/transactions
openapi: 3.0.2
info:
  title: Banking API
  version: 0.0.1
  x-source-en-commit: 5e7e320
  x-source-en-path: global-account/v1.6/banking.yaml
  description: |
    UQPAY Banking API 为全球资金流转提供完整的银行与支付解决方案。

    ## 核心功能
    - 国际支付与转账
    - 多币种账户管理
    - 实时换汇
    - 虚拟账户服务
    - 资金充值与提现

    ## 认证
    调用 UQPAY API 时，使用 API 密钥对客户端请求进行认证。
    API 密钥是用于认证用户身份、授予特权操作访问权限的唯一数据字符串。
    请始终对 API 密钥保密并妥善保管。

    ## 服务组件
    - **Payout**：创建并管理向受益人发起的国际资金转账
    - **Payer**：管理发起付款并授权资金转账的实体
    - **Beneficiary**：管理收款方信息与银行信息
    - **Balance**：查看并管理多币种账户余额
    - **Deposit**：处理入账资金转账
    - **Virtual Accounts**：使用外币本地银行账户
    - **Conversion**：以有竞争力的汇率执行换汇

    ## 快速开始
    1. 获取 API 凭证
    2. 使用 sandbox URL 搭建测试环境
    3. 接入认证
    4. 从基础操作开始

    ## 支持
    如需技术支持与集成协助，请联系 UQPAY 支持团队。
  contact:
    name: UQPAY Support
    url: https://www.uqpay.com/support
    email: banking.tech@uqpay.com
  license:
    name: Proprietary
    url: https://www.uqpay.com/legal/api-terms
  termsOfService: https://www.uqpay.com/legal/terms
  x-api-id: banking-api-v1.6.0
  x-logo:
    url: https://uqpay.com/img/UQPAY_LogoAnimv2.gif
    backgroundColor: '#FFFFFF'
    altText: UQPAY Logo
  x-categories:
    - Banking
    - Payment Processing
    - Foreign Exchange
servers:
  - url: https://api-sandbox.uqpaytech.com/api
    description: Sandbox 基础 URL。
  - url: https://api.uqpay.com/api
    description: 生产环境基础 URL。
security: []
tags:
  - name: Balances
    description: 查看并管理账户中不同币种的可用资金。
  - name: Transfers
    description: 钱包转账资源用于将资金从你的 UQPAY 账户直接转入关联账户。
  - name: Deposits
    description: 充值是指向你的 UQPAY 全球收款账户发起的银行转账，用于补充资金或从第三方收款。
  - name: Virtual Accounts
    description: 虚拟账户是以外币形式存在的本地银行账户。它们支持全球收款，提供可从各类平台收款的账户信息。虚拟账户也可用于为 UQPAY 余额充值。
  - name: Payout
    description: >-
      当你向受益人发起付款时会创建一个 Payout
      资源。它记录受益人、银行信息、付款金额、状态及其他相关信息。你可以使用直接填写的受益人信息，或使用先前创建的受益人 ID 来创建 payout。
  - name: Payers
    description: 付款人是发起 payout 并授权将资金从其账户转入受益人账户的一方。
  - name: Beneficiaries
    description: 受益人是资金的收款方，通常也是最终从 payout 中获益的一方。
  - name: Conversion
    description: 管理交易的换汇与汇率。
  - name: Exchange Rates
    description: 获取指定货币对或全部可用货币对的实时汇率。
  - name: Global Accounts
    description: ⚠️ 警告 此 API 版本已弃用。已弃用的 API 版本最终将不再受支持。全球收款账户是充当本地银行账户的外币账户。
  - name: Simulator
    description: 在 sandbox 环境中模拟充值交易。
paths:
  /v1/balances/transactions:
    get:
      tags:
        - Balances
      summary: List Balances Transactions
      description: >-
        返回影响你账户余额的交易列表，包括扣款、手续费及其他调整。你可以通过指定时间范围来筛选结果。如果未提供时间范围，或仅指定结束日期，返回结果将包含截至今天或指定结束日期前
        30 天内的交易。
      operationId: list-balances-transactions
      parameters:
        - $ref: '#/components/parameters/XOnBehalfOf'
        - $ref: '#/components/parameters/PageSize'
        - $ref: '#/components/parameters/PageNumber'
        - $ref: '#/components/parameters/StartTime'
        - $ref: '#/components/parameters/EndTime'
        - $ref: '#/components/parameters/Currency'
        - $ref: '#/components/parameters/TransactionType'
        - $ref: '#/components/parameters/TransactionStatus'
      responses:
        '200':
          description: OK —— 余额交易返回成功。
          headers:
            x-response-id:
              $ref: '#/components/headers/XResponseId'
          content:
            application/json:
              schema:
                title: listBalancesResponse
                properties:
                  total_pages:
                    $ref: '#/components/schemas/TotalPages'
                  total_items:
                    $ref: '#/components/schemas/TotalItems'
                  data:
                    type: array
                    items:
                      type: object
                      required:
                        - transaction_id
                        - account_name
                        - balance_id
                        - transaction_type
                        - currency
                        - amount
                        - credit_debit_type
                        - create_time
                        - complete_time
                        - reference_id
                        - transaction_status
                      properties:
                        transaction_id:
                          $ref: '#/components/schemas/TransactionId'
                        account_id:
                          type: string
                          description: 账户 ID。
                          example: 72970a7c-7921-431c-b95f-3438724ba16f
                        balance_id:
                          type: string
                          description: 账户余额 ID。
                          example: 72970a7c-7921-431c-b95f-3438724ba16f
                        transaction_type:
                          type: string
                          description: 交易类型。
                          example: DEPOSIT
                          enum:
                            - DEPOSIT
                            - PAYOUT
                            - TRANSFER
                            - CONVERSION
                            - FEE
                            - REFUND
                            - ADJUSTMENT
                            - INVOICE
                        currency:
                          type: string
                          description: 交易的币种。三位字母 ISO 4217 币种代码。
                          example: USD
                        amount:
                          type: string
                          description: 交易金额。
                          example: '100.02'
                        credit_debit_type:
                          type: string
                          description: 借贷类型，C 表示贷记，D 表示借记。
                          example: C
                          enum:
                            - C
                            - D
                        create_time:
                          $ref: '#/components/schemas/CreateTime'
                        complete_time:
                          $ref: '#/components/schemas/CompleteTime'
                        reference_id:
                          type: string
                          description: 编号。
                          example: b52aaed6-1274-41b8-999e-f036085a6da8
                        transaction_status:
                          type: string
                          example: PENDING
                          description: 交易状态。
                          enum:
                            - FAILED
                            - PENDING
                            - COMPLETED
                            - CANCELLED
                        transaction_way:
                          type: string
                          description: 交易方式，API 表示通过 API，留空表示其他方式。
                          example: API
      security:
        - XAuthToken: []
components:
  parameters:
    XOnBehalfOf:
      in: header
      name: x-on-behalf-of
      schema:
        type: string
      required: false
      description: >
        指定代表哪个子账户发起请求。应设为
        `account_id`，可通过[查询关联账户列表](/zh/account-center/v1.6/api-reference/list-connected-accounts-1)获取。如果省略或留空，请求将使用主账户执行。

        更多信息参见[关联账户](/zh/account-center/v1.6/guide/connected-accounts)。
      example: 18523f72-f4de-4f9c-bb8e-ec7d1c4f32be
    PageSize:
      name: page_size
      description: 每页返回的最大条目数。必须在 **10 到 100** 之间（含）。
      in: query
      required: true
      schema:
        type: integer
        minimum: 1
        maximum: 100
        example: 10
    PageNumber:
      name: page_number
      description: 用于获取特定一组条目的页码。必须 **大于等于 1**。
      in: query
      required: true
      schema:
        type: integer
        minimum: 1
        example: 1
    StartTime:
      name: start_time
      description: '`created_time` 的开始时间，ISO8601 格式（含）。'
      in: query
      required: false
      schema:
        type: string
        example: '2024-03-01T00:00:00+08:00'
    EndTime:
      name: end_time
      description: '`created_time` 的结束时间，ISO8601 格式（含）。'
      in: query
      required: false
      schema:
        type: string
        example: '2024-03-01T00:00:00+08:00'
    Currency:
      name: currency
      description: >-
        指定获取交易所用的币种。币种代码遵循 [ISO
        4217](https://en.wikipedia.org/wiki/ISO_4217#List_of_ISO_4217_currency_codes)
        标准。
      in: query
      schema:
        type: string
        example: USD
    TransactionType:
      name: transaction_type
      description: |
        交易类型。

        - `ALL`：包括系统中所有类型的资金交易。
        - `PAYIN`：从外部来源收到的入款。
        - `DEPOSIT`：通过银行转账或其他方式直接存入账户的资金。
        - `PAYOUT`：发往外部受益人的出款。
        - `TRANSFER`：内部账户之间的资金划转。
        - `CONVERSION`：不同币种之间的换汇。
        - `FEE`：服务费或交易手续费。
        - `REFUND`：对先前付款或交易的退款。
        - `ADJUSTMENT`：对账户余额的人工或自动校正。
        - `INVOICE`：发票交易。
      in: query
      required: false
      schema:
        type: string
        example: PAYOUT
        enum:
          - ALL
          - PAYIN
          - DEPOSIT
          - PAYOUT
          - TRANSFER
          - CONVERSION
          - FEE
          - REFUND
          - ADJUSTMENT
          - INVOICE
    TransactionStatus:
      name: transaction_status
      description: |
        交易状态。

        - `ALL`：表示所有可能的交易状态。
        - `COMPLETED`：交易已成功处理并完结。
        - `PENDING`：交易正在处理中，等待完成。
        - `FAILED`：交易因错误或被拒绝而无法完成。
      in: query
      required: false
      schema:
        type: string
        example: COMPLETED
        enum:
          - ALL
          - COMPLETED
          - PENDING
          - FAILED
  headers:
    XResponseId:
      description: 响应的通用唯一标识符（UUID v4）。在与 UQPAY 支持团队沟通时有助于定位某个请求。
      schema:
        type: string
        format: uuid
        example: 2adba88e-9d63-44bc-b975-9b6ae3440dde
  schemas:
    TotalPages:
      type: integer
      example: 10
      description: 可用条目的总页数。
    TotalItems:
      type: integer
      example: 105
      description: 可用条目的总数。
    TransactionId:
      type: string
      format: uuid
      description: 交易的唯一标识符
      example: 5135e6cc-28b6-4889-81dc-3b86a09e1395
    CreateTime:
      type: string
      format: date/time
      example: '2024-03-01T00:00:00+08:00'
      description: >-
        记录在系统中创建时的时间戳。时间戳遵循 [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601)
        标准。
    CompleteTime:
      type: string
      format: date/time
      example: '2024-03-01T00:00:00+08:00'
      description: 请求成功处理并标记为 `COMPLETED` 时的时间戳。
  securitySchemes:
    XAuthToken:
      type: apiKey
      in: header
      name: x-auth-token
      description: 由 UQPay 提供的登录 API Token。

````