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

# Get balance transaction

> Get one prepaid credits ledger transaction.



## OpenAPI

````yaml /openapi/v0-api/public.openapi.yaml get /api/v1/billing/balance-transactions/{transaction_id}
openapi: 3.1.0
info:
  title: MyRouter V0 Public API
  version: 0.1.0
  description: >-
    Customer-facing MyRouter V0 API. Core paths follow OpenRouter where
    possible; billing is a MyRouter extension using Stripe-style resource
    naming.
  license:
    name: Proprietary
    identifier: LicenseRef-Proprietary
  x-platform-contract-commit: 56b047ef2c076be151e090aa4e2f5e974180ea14
  x-phase-sources:
    - phase1/2026-05-28-source-inventory.md
    - phase8/2026-05-28-public-v0-api-review-matrix.md
servers:
  - url: https://api.myrouter.example
    description: Placeholder until public environment is finalized.
security:
  - bearerApiKey: []
paths:
  /api/v1/billing/balance-transactions/{transaction_id}:
    get:
      tags:
        - Billing
      summary: Get balance transaction
      description: Get one prepaid credits ledger transaction.
      operationId: getBalanceTransaction
      parameters:
        - $ref: '#/components/parameters/RequestIdHeader'
        - name: transaction_id
          in: path
          required: true
          schema:
            type: string
            minLength: 1
          description: Balance transaction id.
          x-source: Stripe Balance Transaction concept plus product prepaid ledger
          x-owner: product
          x-status: product-to-build
          x-platform-dependency: Product ledger; platform usage where usage charges apply
          x-rationale: >-
            Balance transactions provide customer-verifiable ledger movements
            for top-ups, usage charges, refunds, and adjustments.
      responses:
        '200':
          description: Get balance transaction response.
          headers:
            x-request-id:
              $ref: '#/components/headers/RequestId'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BalanceTransactionResponse'
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/NotFound'
        '429':
          $ref: '#/components/responses/RateLimited'
        '500':
          $ref: '#/components/responses/InternalError'
components:
  parameters:
    RequestIdHeader:
      name: x-request-id
      in: header
      required: false
      schema:
        type: string
      description: Optional caller request id.
      x-source: Platform error contracts and product API convention
      x-owner: shared
      x-status: product-to-build
      x-platform-dependency: Platform runtime errors and product API errors
      x-rationale: Every API needs a stable supportable error envelope with request id.
  headers:
    RequestId:
      schema:
        type: string
      description: Effective request id.
      x-source: Platform error contracts and product API convention
      x-owner: shared
      x-status: product-to-build
      x-platform-dependency: Platform runtime errors and product API errors
      x-rationale: Every API needs a stable supportable error envelope with request id.
  schemas:
    BalanceTransactionResponse:
      type: object
      additionalProperties: false
      required:
        - data
      properties:
        data:
          $ref: '#/components/schemas/BalanceTransaction'
          description: Balance transaction.
          x-source: Stripe Balance Transaction concept plus product prepaid ledger
          x-owner: product
          x-status: product-to-build
          x-platform-dependency: Product ledger; platform usage where usage charges apply
          x-rationale: >-
            Balance transactions provide customer-verifiable ledger movements
            for top-ups, usage charges, refunds, and adjustments.
        request_id:
          type: string
          description: Request id.
          x-source: Stripe Balance Transaction concept plus product prepaid ledger
          x-owner: product
          x-status: product-to-build
          x-platform-dependency: Product ledger; platform usage where usage charges apply
          x-rationale: >-
            Balance transactions provide customer-verifiable ledger movements
            for top-ups, usage charges, refunds, and adjustments.
      x-source: Stripe Balance Transaction concept plus product prepaid ledger
      x-owner: product
      x-status: product-to-build
      x-platform-dependency: Product ledger; platform usage where usage charges apply
      x-rationale: >-
        Balance transactions provide customer-verifiable ledger movements for
        top-ups, usage charges, refunds, and adjustments.
    BalanceTransaction:
      type: object
      additionalProperties: false
      required:
        - id
        - type
        - amount
        - balance_after
        - status
        - created_at
      properties:
        id:
          type: string
          description: Transaction id.
          x-source: Stripe Balance Transaction concept plus product prepaid ledger
          x-owner: product
          x-status: product-to-build
          x-platform-dependency: Product ledger; platform usage where usage charges apply
          x-rationale: >-
            Balance transactions provide customer-verifiable ledger movements
            for top-ups, usage charges, refunds, and adjustments.
        type:
          type: string
          description: Transaction type.
          x-source: Stripe Balance Transaction concept plus product prepaid ledger
          x-owner: product
          x-status: product-to-build
          x-platform-dependency: Product ledger; platform usage where usage charges apply
          x-rationale: >-
            Balance transactions provide customer-verifiable ledger movements
            for top-ups, usage charges, refunds, and adjustments.
          enum:
            - credit_purchase
            - usage_charge
            - refund
            - adjustment
        amount:
          $ref: '#/components/schemas/MoneyAmount'
          description: Positive for credits, negative for debits.
          x-source: Stripe Balance Transaction concept plus product prepaid ledger
          x-owner: product
          x-status: product-to-build
          x-platform-dependency: Product ledger; platform usage where usage charges apply
          x-rationale: >-
            Balance transactions provide customer-verifiable ledger movements
            for top-ups, usage charges, refunds, and adjustments.
        balance_after:
          $ref: '#/components/schemas/MoneyAmount'
          description: Credits balance after transaction.
          x-source: Stripe Balance Transaction concept plus product prepaid ledger
          x-owner: product
          x-status: product-to-build
          x-platform-dependency: Product ledger; platform usage where usage charges apply
          x-rationale: >-
            Balance transactions provide customer-verifiable ledger movements
            for top-ups, usage charges, refunds, and adjustments.
        status:
          type: string
          description: Transaction status.
          x-source: Stripe Balance Transaction concept plus product prepaid ledger
          x-owner: product
          x-status: product-to-build
          x-platform-dependency: Product ledger; platform usage where usage charges apply
          x-rationale: >-
            Balance transactions provide customer-verifiable ledger movements
            for top-ups, usage charges, refunds, and adjustments.
          enum:
            - pending
            - posted
            - void
            - failed
        created_at:
          type: string
          description: Creation timestamp.
          x-source: Stripe Balance Transaction concept plus product prepaid ledger
          x-owner: product
          x-status: product-to-build
          x-platform-dependency: Product ledger; platform usage where usage charges apply
          x-rationale: >-
            Balance transactions provide customer-verifiable ledger movements
            for top-ups, usage charges, refunds, and adjustments.
          format: date-time
        description:
          type: string
          description: Customer-safe description.
          x-source: Stripe Balance Transaction concept plus product prepaid ledger
          x-owner: product
          x-status: product-to-build
          x-platform-dependency: Product ledger; platform usage where usage charges apply
          x-rationale: >-
            Balance transactions provide customer-verifiable ledger movements
            for top-ups, usage charges, refunds, and adjustments.
        related_generation_id:
          type: string
          description: Related generation for usage charges.
          x-source: Stripe Balance Transaction concept plus product prepaid ledger
          x-owner: product
          x-status: product-to-build
          x-platform-dependency: Product ledger; platform usage where usage charges apply
          x-rationale: >-
            Balance transactions provide customer-verifiable ledger movements
            for top-ups, usage charges, refunds, and adjustments.
        related_checkout_session_id:
          type: string
          description: Related checkout session for credit purchase.
          x-source: Stripe Balance Transaction concept plus product prepaid ledger
          x-owner: product
          x-status: product-to-build
          x-platform-dependency: Product ledger; platform usage where usage charges apply
          x-rationale: >-
            Balance transactions provide customer-verifiable ledger movements
            for top-ups, usage charges, refunds, and adjustments.
        invoice_id:
          type: string
          description: Related invoice id.
          x-source: Stripe Balance Transaction concept plus product prepaid ledger
          x-owner: product
          x-status: product-to-build
          x-platform-dependency: Product ledger; platform usage where usage charges apply
          x-rationale: >-
            Balance transactions provide customer-verifiable ledger movements
            for top-ups, usage charges, refunds, and adjustments.
      x-source: Stripe Balance Transaction concept plus product prepaid ledger
      x-owner: product
      x-status: product-to-build
      x-platform-dependency: Product ledger; platform usage where usage charges apply
      x-rationale: >-
        Balance transactions provide customer-verifiable ledger movements for
        top-ups, usage charges, refunds, and adjustments.
    ErrorEnvelope:
      type: object
      additionalProperties: false
      required:
        - error
        - request_id
      properties:
        error:
          type: object
          additionalProperties: false
          required:
            - code
            - message
          properties:
            code:
              type: string
              description: Stable machine-readable error code.
              x-source: Platform error contracts and product API convention
              x-owner: shared
              x-status: product-to-build
              x-platform-dependency: Platform runtime errors and product API errors
              x-rationale: >-
                Every API needs a stable supportable error envelope with request
                id.
            message:
              type: string
              description: Human-readable error message.
              x-source: Platform error contracts and product API convention
              x-owner: shared
              x-status: product-to-build
              x-platform-dependency: Platform runtime errors and product API errors
              x-rationale: >-
                Every API needs a stable supportable error envelope with request
                id.
            type:
              type: string
              description: Error category.
              x-source: Platform error contracts and product API convention
              x-owner: shared
              x-status: product-to-build
              x-platform-dependency: Platform runtime errors and product API errors
              x-rationale: >-
                Every API needs a stable supportable error envelope with request
                id.
          x-source: Platform error contracts and product API convention
          x-owner: shared
          x-status: product-to-build
          x-platform-dependency: Platform runtime errors and product API errors
          x-rationale: Every API needs a stable supportable error envelope with request id.
        request_id:
          type: string
          description: Effective request id for support.
          x-source: Platform error contracts and product API convention
          x-owner: shared
          x-status: product-to-build
          x-platform-dependency: Platform runtime errors and product API errors
          x-rationale: Every API needs a stable supportable error envelope with request id.
      x-source: Platform error contracts and product API convention
      x-owner: shared
      x-status: product-to-build
      x-platform-dependency: Platform runtime errors and product API errors
      x-rationale: Every API needs a stable supportable error envelope with request id.
    MoneyAmount:
      type: object
      additionalProperties: false
      required:
        - value
        - currency
      properties:
        value:
          type: string
          description: Decimal amount represented as a string.
          x-source: Stripe Balance Transaction concept plus product prepaid ledger
          x-owner: product
          x-status: product-to-build
          x-platform-dependency: Product ledger; platform usage where usage charges apply
          x-rationale: >-
            Balance transactions provide customer-verifiable ledger movements
            for top-ups, usage charges, refunds, and adjustments.
        currency:
          type: string
          description: ISO currency code.
          x-source: Stripe Balance Transaction concept plus product prepaid ledger
          x-owner: product
          x-status: product-to-build
          x-platform-dependency: Product ledger; platform usage where usage charges apply
          x-rationale: >-
            Balance transactions provide customer-verifiable ledger movements
            for top-ups, usage charges, refunds, and adjustments.
      x-source: Stripe Balance Transaction concept plus product prepaid ledger
      x-owner: product
      x-status: product-to-build
      x-platform-dependency: Product ledger; platform usage where usage charges apply
      x-rationale: >-
        Balance transactions provide customer-verifiable ledger movements for
        top-ups, usage charges, refunds, and adjustments.
  responses:
    BadRequest:
      description: Invalid request.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorEnvelope'
    Unauthorized:
      description: Missing or invalid authentication.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorEnvelope'
    Forbidden:
      description: Authenticated principal is not allowed.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorEnvelope'
    NotFound:
      description: Resource not found.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorEnvelope'
    RateLimited:
      description: Rate limit exceeded.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorEnvelope'
    InternalError:
      description: Internal error.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorEnvelope'
  securitySchemes:
    bearerApiKey:
      type: http
      scheme: bearer
      bearerFormat: MyRouter API key

````