> ## 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

> Returns a list of transactions that have contributed to your account balance, including charges, fees, and other adjustments. You can filter the results by specifying a time range. If no time range is provided, or only the end date is specified, the response will include transactions from the past 30 days up to today or the specified end date.



## OpenAPI

````yaml /global-account/v1.6/banking.yaml get /v1/balances/transactions
openapi: 3.0.2
info:
  title: Banking API
  version: 0.0.1
  description: >
    UQPAY Banking API provides comprehensive banking and payment solutions for
    global money movement.


    ## Key Features

    - International payments and transfers

    - Multi-currency account management

    - Real-time currency conversion

    - Virtual account services

    - Fund deposit and withdrawal


    ## Authentication

    Use API keys to authenticate your client requests when utilizing UQPAY APIs.

    API keys are unique data strings used to authenticate users and enable
    access to privileged operations.

    Your API key should be kept confidential and secure at all times.


    ## Service Components

    - **Payout**: Create and manage international fund transfers to
    beneficiaries

    - **Payer**: Manage entities making payments and authorizing fund transfers

    - **Beneficiary**: Handle recipient information and bank details

    - **Balance**: View and manage multi-currency account balances

    - **Deposit**: Process incoming fund transfers

    - **Virtual Accounts**: Utilize local bank accounts in foreign currencies

    - **Conversion**: Execute currency exchange at competitive rates


    ## Getting Started

    1. Obtain API credentials

    2. Set up test environment using sandbox URL

    3. Implement authentication

    4. Start with basic operations


    ## Support

    For technical support and integration assistance, contact UQPAY support
    team.
  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 base URL.
  - url: https://api.uqpay.com/api
    description: Production base URL.
security: []
tags:
  - name: Balances
    description: >-
      View and manage available funds across different currencies in your
      account.
  - name: Transfers
    description: >-
      A wallet transfer resource is used for sending funds directly from your
      UQPAY account to a connected account.
  - name: Deposits
    description: >-
      Deposits are bank transfers made into your UQPAY Global Accounts for
      adding funds or collecting funds from third parties.
  - name: Virtual Accounts
    description: >-
      Virtual Accounts function as local bank accounts in foreign currencies.
      They enable worldwide fund collection with account details that allow you
      to receive funds from various platforms. Virtual Accounts can also be used
      to top up your UQPAY balance.
  - name: Payout
    description: >-
      A Payout resource is created when you send funds to a beneficiary. It
      details the beneficiary, bank details, the amount being paid, its status,
      and other relevant information. You can create the payout using either
      direct beneficiary details or a previously created beneficiary ID.
  - name: Payers
    description: >-
      The payer is the party making the payout and authorizing the transfer of
      funds from their account to the beneficiary's account.
  - name: Beneficiaries
    description: >-
      The beneficiary is the recipient of the funds and is typically the party
      who will ultimately benefit from the payout.
  - name: Conversion
    description: Manage currency conversions and exchange rates for your transactions.
  - name: Exchange Rates
    description: >-
      Retrieve real-time exchange rates for a specified currency pair or all
      available pairs.
  - name: Global Accounts
    description: >-
      ⚠️ WARNING This API version is deprecated. Eventually, a deprecated API
      version becomes unsupported. Global Accounts are foreign currency accounts
      that function as local bank accounts.
  - name: Simulator
    description: Simulate deposit transactions on the sandbox environment.
paths:
  /v1/balances/transactions:
    get:
      tags:
        - Balances
      summary: List Balances Transactions
      description: >-
        Returns a list of transactions that have contributed to your account
        balance, including charges, fees, and other adjustments. You can filter
        the results by specifying a time range. If no time range is provided, or
        only the end date is specified, the response will include transactions
        from the past 30 days up to today or the specified end date.
      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 - Balances transactions returned successfully.
          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: The account id.
                          example: 72970a7c-7921-431c-b95f-3438724ba16f
                        balance_id:
                          type: string
                          description: The account balance id.
                          example: 72970a7c-7921-431c-b95f-3438724ba16f
                        transaction_type:
                          type: string
                          description: The transaction type.
                          example: DEPOSIT
                          enum:
                            - DEPOSIT
                            - PAYOUT
                            - TRANSFER
                            - CONVERSION
                            - FEE
                            - REFUND
                            - ADJUSTMENT
                            - INVOICE
                        currency:
                          type: string
                          description: >-
                            Currency of the transaction. Three-letter ISO 4217
                            currency code.
                          example: USD
                        amount:
                          type: string
                          description: Transaction amount.
                          example: '100.02'
                        credit_debit_type:
                          type: string
                          description: The credit debit type, C for credit and D for debit.
                          example: C
                          enum:
                            - C
                            - D
                        create_time:
                          $ref: '#/components/schemas/CreateTime'
                        complete_time:
                          $ref: '#/components/schemas/CompleteTime'
                        reference_id:
                          type: string
                          description: The reference ID.
                          example: b52aaed6-1274-41b8-999e-f036085a6da8
                        transaction_status:
                          type: string
                          example: PENDING
                          description: The transaction status.
                          enum:
                            - FAILED
                            - PENDING
                            - COMPLETED
                            - CANCELLED
                        transaction_way:
                          type: string
                          description: >-
                            The transaction way, API for API, empty for other
                            ways.
                          example: API
      security:
        - XAuthToken: []
components:
  parameters:
    XOnBehalfOf:
      in: header
      name: x-on-behalf-of
      schema:
        type: string
      required: false
      description: >
        Specifies the sub-account on whose behalf the request is made. This
        should be set to the `account_id`, which can be retrieved via the [List
        Connected
        Accounts](/account-center/v1.6/api-reference/list-connected-accounts-1).
        If omitted or empty, the request is executed using the master account.

        More information at [Connected
        Accounts](/account-center/v1.6/guide/connected-accounts).
      example: 18523f72-f4de-4f9c-bb8e-ec7d1c4f32be
    PageSize:
      name: page_size
      description: >-
        The maximum number of items to return per page. Must be between **10 and
        100**, inclusive.
      in: query
      required: true
      schema:
        type: integer
        minimum: 1
        maximum: 100
        example: 10
    PageNumber:
      name: page_number
      description: >-
        The page number to retrieve a specific set of items. Must be **1 or
        greater**.
      in: query
      required: true
      schema:
        type: integer
        minimum: 1
        example: 1
    StartTime:
      name: start_time
      description: The start time of `created_time` in ISO8601 format (inclusive).
      in: query
      required: false
      schema:
        type: string
        example: '2024-03-01T00:00:00+08:00'
    EndTime:
      name: end_time
      description: The end time of `created_time` in ISO8601 format (inclusive).
      in: query
      required: false
      schema:
        type: string
        example: '2024-03-01T00:00:00+08:00'
    Currency:
      name: currency
      description: >-
        Specifies the currency for which transactions are retrieved. Currency
        codes follow the [ISO
        4217](https://en.wikipedia.org/wiki/ISO_4217#List_of_ISO_4217_currency_codes)
        standard.
      in: query
      schema:
        type: string
        example: USD
    TransactionType:
      name: transaction_type
      description: >
        Transaction type.


        - `ALL`: Includes all types of financial transactions in the system.

        - `PAYIN`: Incoming payment received from external sources.

        - `DEPOSIT`: Funds added directly to an account through bank transfer or
        other means.

        - `PAYOUT`: Outgoing payment sent to external beneficiaries.

        - `TRANSFER`: Movement of funds between internal accounts.

        - `CONVERSION`: Currency exchange between different currencies.

        - `FEE`: Service charges or transaction fees.

        - `REFUND`: Reversal of a previous payment or transaction.

        - `ADJUSTMENT`: Manual or automated correction to account balance.

        - `INVOICE`: Invoice transaction.
      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: >
        Transaction status.


        - `ALL`: Represents all possible transaction statuses.

        - `COMPLETED`: Transaction has been successfully processed and
        finalized.

        - `PENDING`: Transaction is currently being processed and awaiting
        completion.

        - `FAILED`: Transaction could not be completed due to an error or
        rejection.
      in: query
      required: false
      schema:
        type: string
        example: COMPLETED
        enum:
          - ALL
          - COMPLETED
          - PENDING
          - FAILED
  headers:
    XResponseId:
      description: >-
        Universally unique identifier (UUID v4) for the response. Helpful for
        identifying a request when communicating with UQPAY support.
      schema:
        type: string
        format: uuid
        example: 2adba88e-9d63-44bc-b975-9b6ae3440dde
  schemas:
    TotalPages:
      type: integer
      example: 10
      description: The total number of pages of available items.
    TotalItems:
      type: integer
      example: 105
      description: The total counts of available items.
    TransactionId:
      type: string
      format: uuid
      description: Unique Identifier for transaction
      example: 5135e6cc-28b6-4889-81dc-3b86a09e1395
    CreateTime:
      type: string
      format: date/time
      example: '2024-03-01T00:00:00+08:00'
      description: >-
        The timestamp when the record was created in the system. Timestamp
        follows the [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) standard.
    CompleteTime:
      type: string
      format: date/time
      example: '2024-03-01T00:00:00+08:00'
      description: >-
        The timestamp when the request was successfully processed and marked as
        `COMPLETED`.
  securitySchemes:
    XAuthToken:
      type: apiKey
      in: header
      name: x-auth-token
      description: The API token for login provided by UQPay.

````