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

# Get balance



## OpenAPI

````yaml /openapi/wallet.json get /v1/kaspi/balance/
openapi: 3.0.3
info:
  title: Yume API — Wallet
  version: 1.0.0
  description: Apple Wallet и Google Wallet passcards (Kaspi).
servers:
  - url: https://api.yume.cloud
    description: Production
  - url: https://api.stage.yume.cloud
    description: Stage
security: []
paths:
  /v1/kaspi/balance/:
    get:
      tags:
        - balance
      summary: Get balance
      operationId: balance_retrieve
      parameters:
        - $ref: '#/components/parameters/TenantId'
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/KaspiBalanceRequest'
          description: ''
      security:
        - jwtAuth: []
        - {}
components:
  parameters:
    TenantId:
      name: X-Tenant-Id
      in: header
      required: false
      schema:
        type: integer
      description: >-
        Компания, в контексте которой выполняется запрос — её id из `GET
        /v1/tenant/`. Пользователь должен состоять в этой компании: чужой id
        доступа к данным не даёт. Без заголовка компания определяется по домену
        запроса.
  schemas:
    KaspiBalanceRequest:
      type: object
      properties:
        txn_id:
          type: string
          pattern: ^[0-9]{1,18}$
        txn_date:
          type: string
          format: date-time
        account:
          type: string
          maxLength: 200
        command:
          $ref: '#/components/schemas/CommandEnum'
        sum:
          type: string
          format: decimal
          pattern: ^-?\d{0,14}(?:\.\d{0,2})?$
      required:
        - account
        - command
        - txn_date
        - txn_id
    CommandEnum:
      enum:
        - check
        - pay
      type: string
      description: |-
        * `check` - check
        * `pay` - pay
  securitySchemes:
    jwtAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT

````