# Создать транзакцию виртуальной валюты

> Начисляет или списывает одну или несколько виртуальных валют для профиля в рамках одной атомарной транзакции. Используйте положительное значение `amount` для начисления (зачисления) и отрицательное — для списания (расходования). Все позиции применяются вместе — если какая-либо позиция не проходит, ни одна из них не применяется.
>
> Каждый код валюты может встречаться в запросе только один раз. Начисление через этот эндпоинт всегда создаёт бессрочный баланс.

## OpenAPI

```yaml
/api-specs/adapty-api.yaml post /api/v2/server-side-api/vc/transactions/
openapi: 3.1.0
info:
  title: Серверный API Adapty
  version: 1.0.0
servers:
  - url: https://api.adapty.io
    description: Продакшн-сервер
paths:
  /api/v2/server-side-api/vc/transactions/:
    post:
      summary: Создать транзакцию виртуальной валюты
      description: |
        Начисляет или списывает одну или несколько виртуальных валют для профиля в рамках одной атомарной транзакции. Используйте положительное значение `amount` для начисления (зачисления) и отрицательное — для списания (расходования). Все позиции применяются вместе — если какая-либо позиция не проходит, ни одна из них не применяется.

        Каждый код валюты может встречаться в запросе только один раз. Начисление через этот эндпоинт всегда создаёт бессрочный баланс.
      operationId: createVirtualCurrencyTransaction
      tags:
        - Virtual Currency
      security:
        - apikeyAuth: []
      parameters:
        - name: adapty-customer-user-id
          in: header
          required: false
          schema:
            type: string
          description: Уникальный ID пользователя в вашей системе. Необходимо указать либо `adapty-customer-user-id`, либо `adapty-profile-id`.
        - name: adapty-profile-id
          in: header
          required: false
          schema:
            type: string
          description: Уникальный ID профиля в вашей системе. Лучший вариант при работе с анонимными профилями. Необходимо указать либо `adapty-customer-user-id`, либо `adapty-profile-id`.
        - name: Idempotency-Key
          in: header
          required: false
          schema:
            type: string
            format: uuid
          description: |
            UUID v4, обеспечивающий идемпотентность запроса. При повторном запросе с тем же ключом Adapty возвращает результат исходной транзакции, не изменяя балансы повторно. Должен быть валидным UUID v4.

            Ключи хранятся до одного часа в рамках одного профиля. По истечении этого времени запрос с тем же ключом применяется как новая транзакция — используйте ключ для безопасного повтора вызова, а не для дедупликации начислений в долгосрочной перспективе.
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/VirtualCurrencyTransactionRequest"
            examples:
              debit:
                summary: Списание (дебет) одной валюты
                value:
                  items:
                    - currency_code: COINS
                      amount: -10
              credit:
                summary: Начисление (кредит) одной валюты
                value:
                  items:
                    - currency_code: COINS
                      amount: 500
              multi_currency:
                summary: Одновременное списание двух валют
                value:
                  items:
                    - currency_code: GOLD
                      amount: -50
                    - currency_code: SILVER
                      amount: -200
              conversion:
                summary: Конвертация одной валюты в другую
                value:
                  items:
                    - currency_code: SILVER
                      amount: -100
                    - currency_code: GOLD
                      amount: 10
                  metadata:
                    reason: exchange
      responses:
        "200":
          description: Транзакция успешно применена
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/VirtualCurrencyTransactionResponse"
              example:
                transaction_id: 0190e8a4-1c2b-7def-8abc-2c1a4b6d8e90
                balances:
                  - code: COINS
                    name: Gold Coins
                    balance: 12950
                    held: 0
                    available: 12950
        "400":
          description: |
            Некорректный запрос. Поле `error_code` указывает на причину: `insufficient_balance`, `unknown_currency`, `duplicate_currency`, `amount_zero`, `balance_overflow`, `empty_items` или `idempotency_key_invalid`.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorResponse"
              example:
                errors:
                  - source: currency_code
                    errors:
                      - Insufficient balance for currency COINS
                error_code: insufficient_balance
                status_code: 400
        "401":
          description: Не авторизован. API-ключ отсутствует или недействителен.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorResponse"
        "403":
          description: Доступ запрещён. Server API для виртуальных валют не включён для этого приложения. Обратитесь в службу поддержки Adapty для получения доступа.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorResponse"
              example:
                errors:
                  - source: null
                    errors:
                      - Server API for virtual currencies is not enabled for this app. Contact Adapty support to request access.
                error_code: feature_not_enabled
                status_code: 403
        "404":
          description: Профиль не найден.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorResponse"
        "409":
          description: |
            Конфликт. Поле `error_code` указывает на причину:

            - `idempotency_in_flight` — запрос с тем же `Idempotency-Key` всё ещё обрабатывается. Повторите попытку после интервала, указанного в заголовке ответа `Retry-After`.
            - `duplicate_source_transaction` — базовая транзакция стора уже была зачислена, поэтому повторно не применяется.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorResponse"
              example:
                errors:
                  - source: null
                    errors:
                      - A similar request is being processed.
                error_code: idempotency_in_flight
                status_code: 409
        "422":
          description: |
            Необрабатываемая сущность. Тело запроса не прошло валидацию схемы — например, `items` содержит более 20 записей, или ключ либо значение `metadata` нарушает установленные ограничения.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorResponse"
        "429":
          description: |
            Слишком много запросов. Превышен лимит запросов для приложения или глобальный лимит (`error_code` равен `rate_limited`). Лимиты по умолчанию: 600 запросов в минуту на приложение и 6000 запросов в минуту глобально.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorResponse"
        "500":
          description: Внутренняя ошибка сервера
components:
  schemas:
    VirtualCurrencyTransactionRequest:
      type: object
      description: Тело запроса для создания транзакции виртуальной валюты.
      properties:
        items:
          type: array
          minItems: 1
          maxItems: 20
          description: Корректировки баланса, применяемые атомарно. Каждый код валюты может встречаться только один раз.
          items:
            $ref: "#/components/schemas/VirtualCurrencyBalanceAdjustment"
        metadata:
          type: object
          nullable: true
          additionalProperties:
            type: string
          description: |
            Необязательные пары ключ-значение, сохраняемые вместе с транзакцией. Не более 5 ключей. Каждый ключ соответствует шаблону `^[a-z0-9_]{1,30}$`, а каждое значение содержит не более 200 символов.
      required:
        - items
    VirtualCurrencyTransactionResponse:
      type: object
      description: Результат транзакции виртуальной валюты.
      properties:
        transaction_id:
          type: string
          format: uuid
          description: Уникальный идентификатор созданной транзакции.
        balances:
          type: array
          description: |
            Баланс после транзакции для каждой валюты, затронутой этим запросом (по одной записи на каждый элемент в `items`). Чтобы получить полный список балансов для профиля, используйте `GET /api/v2/server-side-api/vc/balances/`.
          items:
            $ref: "#/components/schemas/VirtualCurrencyBalanceSnapshot"
      required:
        - transaction_id
        - balances
    ErrorResponse:
      type: object
      properties:
        errors:
          type: array
          items:
            type: object
            properties:
              source:
                type: string
                nullable: true
                description: Источник ошибки
              errors:
                type: array
                items:
                  type: string
                description: Массив сообщений об ошибках
        error_code:
          type: string
          description: Краткое название ошибки
        status_code:
          type: integer
          description: HTTP-код статуса
      required:
        - errors
        - error_code
        - status_code
    VirtualCurrencyBalanceAdjustment:
      type: object
      properties:
        currency_code:
          type: string
          description: Код виртуальной валюты для корректировки.
        amount:
          type: integer
          format: int32
          description: |
            Сумма для применения. Положительное значение зачисляет (начисляет) валюту; отрицательное значение списывает (тратит) её. Не может быть равно нулю.
      required:
        - currency_code
        - amount
    VirtualCurrencyBalanceSnapshot:
      type: object
      properties:
        code:
          type: string
          description: Код виртуальной валюты.
        name:
          type: string
          description: Отображаемое название виртуальной валюты.
        balance:
          type: integer
          format: int32
          minimum: 0
          description: Общий баланс, включая суммы, находящиеся в удержании.
        held:
          type: integer
          format: int32
          minimum: 0
          description: Сумма всех активных удержаний (зарезервированные суммы). В настоящее время всегда равна 0.
        available:
          type: integer
          format: int32
          description: Баланс, доступный для списания, вычисляется как `balance - held`.
      required:
        - code
        - name
        - balance
        - held
        - available
  securitySchemes:
    apikeyAuth:
      type: apiKey
      name: Authorization
      in: header
      default: Api-Key {Your secret API key}
      description: |
        API-запросы должны быть аутентифицированы с помощью вашего секретного API-ключа, передаваемого в заголовке **Authorization** со значением `Api-Key {your_secret_api_key}`, например `Api-Key secret_live_...`. Найдите этот ключ в дашборде Adapty -> **App Settings** -> вкладка **General** -> раздел **API keys**.
```