Skip to main content

Reference: payments

Player balance top-up​

OperationParametersResultDescription
playerWalletTopUpMethodsDiscoverPlayerWalletTopUpMethodsInput!PlayerWalletTopUpMethodDiscovery!Discover methods for an amount and context
preparePlayerWalletTopUpPreparePlayerWalletTopUpInput!PlayerWalletTopUpPreparation!Freeze an authenticated top-up calculation
startPlayerWalletTopUpStartPlayerWalletTopUpInput!PlayerWalletTopUpCheckout!Start payment from the calculation
prepareGuestPlayerWalletTopUpPrepareGuestPlayerWalletTopUpInput!PlayerWalletTopUpPreparation!Verify the recipient and prepare a guest top-up
startGuestPlayerWalletTopUpStartGuestPlayerWalletTopUpInput!PlayerWalletTopUpCheckout!Start guest payment
playerPaymentHistoryfirst, after, statusesPlayerPaymentHistoryConnection!Read cursor-paginated payment history
playerPaymentpaymentId: ID!PlayerPayment!Read an owned payment by public identifier

Complete inputs, states, client actions, and exchanges are documented in Player balance top-up.

Game currency​

Wallet purchases use the authenticated player context:

OperationParametersResultDescription
gameCurrencyOffersfirst, afterGameCurrencyOfferConnection!Cursor-paginated offer catalog
prepareGameCurrencyPurchasePrepareGameCurrencyPurchaseInput!GameCurrencyQuote!Prepare a purchase calculation
purchaseGameCurrencyPurchaseGameCurrencyInput!GameCurrencyPurchase!Create and pay an order from the wallet

Character purchases without signing in use rate-limited public operations:

OperationParametersResultDescription
guestGameCurrencyOffersgameServerId, first, afterGameCurrencyOfferConnection!Character-delivery offer catalog
prepareGuestGameCurrencyPurchasePrepareGuestGameCurrencyPurchaseInput!GameCurrencyQuote!Verify the recipient and calculate the purchase
prepareGuestGameCurrencyCheckoutPrepareGuestGameCurrencyCheckoutInput!StorefrontExternalPaymentPreparation!Create an order and load payment methods
startGuestGameCurrencyCheckoutExecuteGuestGameCurrencyCheckoutInput!StorefrontExternalPaymentExecution!Start the selected method
retryGuestGameCurrencyCheckoutExecuteGuestGameCurrencyCheckoutInput!StorefrontExternalPaymentExecution!Continue an existing payment

Details and examples: game currency.