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

# List balance transactions

> Returns a paginated list of balance transactions showing all changes to your account balance.



## OpenAPI

````yaml /openapi.yaml get /v1/balance/transactions
openapi: 3.1.0
info:
  title: Kyren Pay API
  description: >
    The Kyren Pay API enables merchants to accept payments from customers
    worldwide.

    Integrate checkout sessions, manage products, track orders, and handle
    webhooks.


    **Data types**: The API uses the following types for request/response data:

    - **string**: For text, identifiers, and **all amount/price fields** (e.g.
    `price`, `amount`, `platformFee`, `available`)
      to avoid floating-point precision issues. Use decimal format like `"9.99"`.
    - **integer**: For counts, pagination, and timestamps

    - **timestamp**: Unix timestamp in milliseconds (integer) for all time
    fields (e.g. `createdAt`, `paidAt`, `expiresAt`).
      Time parameters (e.g. `startDate`, `endDate`) also use Unix milliseconds.
  version: 1.0.0
  contact:
    name: Kyren Pay Support
    email: support@kyren.top
    url: https://kyren.top
servers:
  - url: https://api.kyren.top
    description: Production
  - url: https://staging-api.kyren.top
    description: Staging, available only with credentials issued by Kyren
security:
  - ApiKeyAuth: []
tags:
  - name: Config
    description: Retrieve platform configuration such as supported currencies.
  - name: Products
    description: Create and manage products that represent the goods or services you sell.
  - name: Checkouts
    description: Create checkout sessions to collect payments from your customers.
  - name: Orders
    description: View and manage orders created from completed checkout sessions.
  - name: Balance
    description: View your account balance and transaction history.
  - name: Epay Compatibility
    description: >
      Compatibility endpoints for existing integrations built on 易支付 API
      conventions.

      These endpoints use form/query parameters with `pid + sign` verification
      (MD5), not `x-api-key` header auth.
paths:
  /v1/balance/transactions:
    get:
      tags:
        - Balance
      summary: List balance transactions
      description: >-
        Returns a paginated list of balance transactions showing all changes to
        your account balance.
      operationId: listBalanceTransactions
      parameters:
        - name: type
          in: query
          required: false
          schema:
            $ref: '#/components/schemas/BalanceTransactionType'
          description: Filter by transaction type
        - $ref: '#/components/parameters/Page'
        - $ref: '#/components/parameters/Size'
      responses:
        '200':
          description: A paginated list of balance transactions
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BalanceTransactionListResponseWrapper'
              example:
                code: 0
                message: success
                data:
                  items:
                    - id: btx_ghi789
                      type: PAYMENT
                      amount: '9.29'
                      currency: USD
                      availableAfter: '1250.00'
                      pendingAfter: '350.00'
                      frozenAfter: '0.00'
                      sourceType: order
                      sourceId: order_def456
                      description: Payment received for order order_def456
                      createdAt: 1736932500000
                  pagination:
                    page: 1
                    size: 20
                    total: 1
                    totalPages: 1
        '401':
          $ref: '#/components/responses/Unauthorized'
components:
  schemas:
    BalanceTransactionType:
      type: string
      enum:
        - PAYMENT
        - SETTLEMENT
        - PAYOUT
        - FREEZE
        - UNFREEZE
        - CHARGEBACK
        - CHARGEBACK_FEE
        - ROLLING_RESERVE
        - ROLLING_RESERVE_RELEASE
        - ROLLING_RESERVE_OFFSET
        - ADMIN_RECHARGE
        - REFUND
        - FEE
      description: >
        - `PAYMENT` — Payment received (added to pending)

        - `SETTLEMENT` — Funds settled (pending → available)

        - `PAYOUT` — Payout deducted from available

        - `FREEZE` / `UNFREEZE` — Funds frozen or released

        - `CHARGEBACK` — Chargeback deduction

        - `CHARGEBACK_FEE` — Chargeback fee deduction

        - `ROLLING_RESERVE` — Rolling reserve hold

        - `ROLLING_RESERVE_RELEASE` — Rolling reserve release

        - `ROLLING_RESERVE_OFFSET` — Rolling reserve used to offset chargeback
        loss

        - `ADMIN_RECHARGE` — Manual admin recharge

        - `REFUND` — Refund deduction

        - `FEE` — Fee deduction
    BalanceTransactionListResponseWrapper:
      type: object
      properties:
        code:
          type: integer
          example: 0
        message:
          type: string
          example: success
        data:
          type: object
          properties:
            items:
              type: array
              items:
                $ref: '#/components/schemas/BalanceTransaction'
            pagination:
              $ref: '#/components/schemas/Pagination'
    BalanceTransaction:
      type: object
      properties:
        id:
          type: string
        type:
          $ref: '#/components/schemas/BalanceTransactionType'
        amount:
          type: string
          description: Amount change (positive for increase, negative for decrease)
        currency:
          type: string
        availableAfter:
          type: string
          description: Available balance after this transaction
        pendingAfter:
          type: string
        frozenAfter:
          type: string
        rollingReserveAfter:
          type: string
          nullable: true
        sourceType:
          type: string
          description: Type of the source resource (e.g. order, payout)
        sourceId:
          type: string
          description: ID of the source resource
        receiptUrl:
          type: string
          nullable: true
        description:
          type: string
          nullable: true
        createdAt:
          type: integer
          format: int64
          description: Unix timestamp in milliseconds
    Pagination:
      type: object
      properties:
        page:
          type: integer
        size:
          type: integer
        total:
          type: integer
          format: int64
        totalPages:
          type: integer
    ErrorResponse:
      type: object
      properties:
        code:
          type: integer
        message:
          type: string
        error:
          type: object
          properties:
            field:
              type: string
            reason:
              type: string
  parameters:
    Page:
      name: page
      in: query
      required: false
      schema:
        type: integer
        default: 1
        minimum: 1
      description: Page number (1-indexed)
    Size:
      name: size
      in: query
      required: false
      schema:
        type: integer
        default: 20
        minimum: 1
        maximum: 100
      description: Number of items per page
  responses:
    Unauthorized:
      description: Unauthorized — missing or invalid API key
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
          example:
            code: 401
            message: Unauthorized
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      in: header
      name: x-api-key
      description: >
        Your API key. Public production API-key endpoints accept `kyren_live_*`
        keys. Staging credentials are environment-specific and must be used only
        with the staging environment for which Kyren issued them.

````