English 中文TürkçeРусскийFrançaisTiếng ViệtEspañol日本語
GET /api/v2/server-side-api/vc/balances/

Список балансов виртуальных валют

Copy as Markdown

Возвращает текущий баланс каждой виртуальной валюты для профиля. Если в приложении нет виртуальных валют, data будет пустым массивом.

Header parameters

adapty-customer-user-idstring

Уникальный идентификатор пользователя в вашей системе. Необходимо указать либо adapty-customer-user-id, либо adapty-profile-id.

adapty-profile-idstring

Уникальный идентификатор профиля в вашей системе. Предпочтительный вариант при работе с анонимными профилями. Необходимо указать либо adapty-customer-user-id, либо adapty-profile-id.

Responses

Балансы успешно возвращены

Schema

Текущие балансы всех виртуальных валют профиля.

response_created_atintegerrequired

Время генерации ответа в виде Unix-временной метки в миллисекундах.

dataarray of objectrequired
codestringrequired

Уникальный код виртуальной валюты в приложении. Буквы ASCII, цифры и символ подчёркивания.

namestringrequired

Отображаемое название виртуальной валюты.

balanceintegerrequired

Общий баланс, включая суммы, находящиеся в резерве.

heldintegerrequired

Сумма всех активных резервов (зарезервированные средства). В настоящее время всегда равна 0.

availableintegerrequired

Баланс, доступный для использования, вычисляется как balance - held.

Example 
{
  "response_created_at": 1779791400000,
  "data": [
    {
      "code": "COINS",
      "name": "Gold Coins",
      "balance": 12450,
      "held": 0,
      "available": 12450
    },
    {
      "code": "GEMS",
      "name": "Gems",
      "balance": 3280,
      "held": 0,
      "available": 3280
    },
    {
      "code": "ENERGY",
      "name": "Energy",
      "balance": 840,
      "held": 0,
      "available": 840
    }
  ]
}

Некорректный запрос.

Schema
errorsarray of objectrequired
sourcestring

Источник ошибки

errorsarray of string

Массив сообщений об ошибках

error_codestringrequired

Краткое название ошибки

status_codeintegerrequired

HTTP-код статуса

Не авторизован. API-ключ отсутствует или недействителен.

Schema
errorsarray of objectrequired
sourcestring

Источник ошибки

errorsarray of string

Массив сообщений об ошибках

error_codestringrequired

Краткое название ошибки

status_codeintegerrequired

HTTP-код статуса

Доступ запрещён. Server API для виртуальных валют не включён для этого приложения.

Schema
errorsarray of objectrequired
sourcestring

Источник ошибки

errorsarray of string

Массив сообщений об ошибках

error_codestringrequired

Краткое название ошибки

status_codeintegerrequired

HTTP-код статуса

Профиль не найден.

Schema
errorsarray of objectrequired
sourcestring

Источник ошибки

errorsarray of string

Массив сообщений об ошибках

error_codestringrequired

Краткое название ошибки

status_codeintegerrequired

HTTP-код статуса

Внутренняя ошибка сервера