Перейти к основному содержимому

Типы данных игровой валюты

Страница содержит типы текущего публичного контракта игровой валюты. Типы пополнения баланса приведены рядом с полными примерами в разделе «Пополнение баланса игрока».

Типы игровой валюты​

GameCurrencyOffer​

ПолеТипОписание
idID!Идентификатор предложения
skuString!Код предложения
nameString!Локализованное название
descriptionString!Локализованное описание
shortNameString!Короткое название валюты
iconReferenceString!Ссылка на оформление
messageString!Сообщение о выдаче
deliveryTypeGameCurrencyDeliveryType!Тип выдачи
unitsPerPurchaseInt!Единицы в одном пакете
unitPriceGameCurrencyMoney!Цена одного пакета

GameCurrencyMoney​

ПолеТипОписание
unitsString!Атомарное целое значение
codeString!Код денежного актива
scaleInt!Точность
decimalString!Готовое десятичное представление

При нулевом итоге покупка подтверждается без оплаты: paymentId равен null, paymentStatus равен NOT_REQUIRED. Заказ проходит состояния CONFIRMED, FULFILLING и FULFILLED; подтверждение ещё не означает завершённую выдачу.

GameCurrencyQuote​

ПолеТипОписание
idID!Идентификатор зафиксированного расчёта покупки
offerGameCurrencyOffer!Снимок предложения
quantityInt!Число пакетов
deliveredUnitsInt!Итоговая выдача
unitAmountGameCurrencyMoney!Цена пакета
subtotalGameCurrencyMoney!Сумма до скидок
adjustments[GameCurrencyPriceAdjustment!]!Корректировки
totalGameCurrencyMoney!Итог к оплате
hasSavingsBoolean!Есть ли скидка
deliveryGameCurrencyDeliveryTarget!Получатель
expiresAtDateTime!Срок действия

GameCurrencyPriceAdjustment​

ПолеТипОписание
codeString!Код корректировки
kindGameCurrencyPriceAdjustmentKind!DISCOUNT или SURCHARGE
sourceGameCurrencyPriceAdjustmentSource!Источник правила
amountGameCurrencyMoney!Размер корректировки

GameCurrencyDeliveryTarget​

ПолеТипОписание
typeGameCurrencyDeliveryTargetType!CHARACTER или GAME_ACCOUNT
accountNameStringИгровой аккаунт или null для гостевой доставки персонажу
characterNameStringПерсонаж или null

GameCurrencyPurchase​

ПолеТипОписание
orderIdID!Заказ
quoteIdID!Идентификатор использованного расчёта покупки
orderStatusGameCurrencyOrderStatus!Состояние заказа
paymentIdIDПлатёж из кошелька
paymentStatusGameCurrencyPaymentStatus!Состояние списания
totalGameCurrencyMoney!Сумма заказа
createdAtDateTime!Время создания

StorefrontMoney​

ПолеТипОписание
unitsString!Атомарное целое значение
decimalString!Готовое десятичное представление
currencyCodeString!Код валюты
currencyScaleInt!Точность валюты

StorefrontExternalPaymentPreparation​

ПолеТипОписание
orderIdID!Заказ, ожидающий внешней оплаты
quoteIdID!Расчёт покупки
orderStatusStorefrontOrderStatus!Состояние заказа
intentStorefrontExternalPaymentIntent!Намерение оплаты
methods[StorefrontExternalPaymentMethod!]!Подходящие способы с расчётами

StorefrontExternalPaymentMethod​

ПолеТипОписание
idID!Идентификатор профиля способа
codeString!Код способа
nameString!Отображаемое название
iconAssetIdStringЗарегистрированная иконка или null
paymentQuoteStorefrontExternalPaymentQuote!Сумма, комиссия и срок действия

StorefrontExternalPaymentQuote​

ПолеТипОписание
idID!Расчёт выбранного способа
paymentAmountStorefrontMoney!Сумма в валюте платежа
destinationAmountStorefrontMoney!Сумма заказа
payerFeeStorefrontMoney!Комиссия плательщика
expiresAtDateTime!Срок действия

StorefrontExternalPaymentExecution​

ПолеТипОписание
orderIdID!Заказ
quoteIdID!Расчёт покупки
orderStatusStorefrontOrderStatus!Состояние заказа
intentStorefrontExternalPaymentIntent!Состояние намерения
attemptStorefrontExternalPaymentAttempt!Текущая попытка
actionStorefrontExternalPaymentActionДействие клиента или null

StorefrontExternalPaymentIntent и StorefrontExternalPaymentAttempt содержат id, типизированное состояние и expiresAt. StorefrontExternalPaymentAction содержит kind, expiresAt и ровно одно подходящее представление: redirect, formPost, qrCode, deepLink или wait.

Перечисления игровой валюты​

EnumЗначения
GameCurrencyDeliveryTypeCHARACTER_ITEM, ACCOUNT_POINTS
GameCurrencyDeliveryTargetTypeCHARACTER, GAME_ACCOUNT
GameCurrencyPriceAdjustmentKindDISCOUNT, SURCHARGE
GameCurrencyPriceAdjustmentSourceCATALOG_SALE, REFERRAL, VIP, CAMPAIGN
GameCurrencyOrderStatusCONFIRMED, PENDING_PAYMENT, PAID, FULFILLING, FULFILLED, CANCELLED
GameCurrencyPaymentStatusNOT_REQUIRED, DEBIT_PENDING, PAID, REVERSAL_PENDING, REVERSED, REQUIRES_REVIEW
StorefrontOrderStatusCONFIRMED, PENDING_PAYMENT, PAID, FULFILLING, FULFILLED, CANCELLED
StorefrontExternalPaymentIntentStatusOPEN, PROCESSING, SETTLED, CANCELLED, EXPIRED
StorefrontExternalPaymentAttemptStatusCREATED, REQUIRES_CUSTOMER_ACTION, PENDING_PROVIDER, AUTHORIZED, CAPTURED, DECLINED, CANCELLED, EXPIRED, REVIEW_REQUIRED
StorefrontExternalPaymentActionKindREDIRECT, FORM_POST, QR_CODE, DEEP_LINK, WAIT

PrepareGameCurrencyPurchaseInput​

ПолеТипОбязательноеОписание
requestIdID!даUUIDv7 подготовки
offerIdID!даПредложение
quantityInt!даОт 1 до 1 000 000
accountNameString!даПринадлежащий игроку аккаунт
characterNameStringнетОбязателен для выдачи персонажу

PurchaseGameCurrencyInput​

ПолеТипОбязательноеОписание
orderRequestIdID!даUUIDv7 создания заказа
paymentRequestIdID!даUUIDv7 списания
quoteIdID!даИдентификатор действующего расчёта покупки

PrepareGuestGameCurrencyPurchaseInput​

ПолеТипОбязательноеОписание
gameServerIdInt!даВыбранный игровой сервер
requestIdID!даUUIDv7 расчёта
offerIdID!даГостевое предложение CHARACTER_ITEM
quantityInt!даЧисло пакетов от 1 до 1 000 000
characterNameString!даПерсонаж-получатель
payerEmailString!даEmail плательщика

PrepareGuestGameCurrencyCheckoutInput​

ПолеТипОбязательноеОписание
gameServerIdInt!даИгровой сервер расчёта
orderRequestIdID!даUUIDv7 заказа
paymentRequestIdID!даUUIDv7 подготовки оплаты
quoteIdID!даРасчёт покупки
characterNameString!даТот же персонаж
payerEmailString!даТот же email
payerCountryStringнетДвухбуквенный код страны

ExecuteGuestGameCurrencyCheckoutInput​

ПолеТипОбязательноеОписание
gameServerIdInt!даИгровой сервер заказа
requestIdID!даUUIDv7 запуска или повтора
orderIdID!даПодготовленный заказ
quoteIdID!даРасчёт покупки
characterNameString!даПроверенный персонаж
payerEmailString!даEmail плательщика
methodProfileIdID!даВыбранный способ
paymentQuoteIdID!даДействующий расчёт способа