Skip to main content

Balance withdrawals

These operations apply to the authenticated player and current project. Withdrawals are a core feature and do not require an add-on subscription.

Configuration​

QuerydocumentId: balanceWithdrawalConfigauth: Bearer session

balanceWithdrawalConfig​

Returns feature availability and configured payout methods.

Request
documentId: balanceWithdrawalConfig
{
  "documentId": "balanceWithdrawalConfig",
  "variables": {}
}
Response
200 OK
{
  "data": {
    "balanceWithdrawalConfig": {
      "enabled": true,
      "minimumAmount": 20,
      "feePercent": 5,
      "exchangeRate": 1,
      "methods": [
        {
          "code": "paypal",
          "name": {
            "ru": "PayPal",
            "en": "PayPal"
          },
          "destinationType": "EMAIL",
          "placeholder": "[email protected]",
          "icon": "ti ti-brand-paypal"
        }
      ]
    }
  }
}

History​

QuerydocumentId: balanceWithdrawalHistoryauth: Bearer session

balanceWithdrawalHistory​

Variables: first is a page size from 1 to 50; after is the opaque cursor returned by the previous page.

Request
documentId: balanceWithdrawalHistory
{
  "documentId": "balanceWithdrawalHistory",
  "variables": {
    "first": 20,
    "after": null
  }
}
Response
200 OK
{
  "data": {
    "balanceWithdrawalHistory": {
      "items": [
        {
          "requestId": "019b2f3a-64d7-7f20-8e4b-420a67498c41",
          "amount": 100,
          "payoutAmount": 95,
          "feePercent": 5,
          "exchangeRate": 1,
          "methodCode": "paypal",
          "destination": "[email protected]",
          "status": "PENDING",
          "createdAt": "2026-07-23T10:30:00Z",
          "processedAt": null
        }
      ],
      "pageInfo": {
        "endCursor": "MTA1",
        "hasNextPage": false
      }
    }
  }
}

Create a request​

MutationdocumentId: createBalanceWithdrawalauth: Bearer session

createBalanceWithdrawal​

The mutation accepts one CreateBalanceWithdrawalInput: UUIDv7 requestId, amount, a methodCode returned by the configuration query, destination, and an optional protected-operation pin.

Request
documentId: createBalanceWithdrawal
{
  "documentId": "createBalanceWithdrawal",
  "variables": {
    "input": {
      "requestId": "019b2f3a-64d7-7f20-8e4b-420a67498c41",
      "amount": 100,
      "methodCode": "paypal",
      "destination": "[email protected]",
      "pin": "1234"
    }
  }
}
Response
200 OK
{
  "data": {
    "createBalanceWithdrawal": {
      "message": "Withdrawal request created",
      "requestId": "019b2f3a-64d7-7f20-8e4b-420a67498c41",
      "status": "PENDING",
      "payoutAmount": 95,
      "balance": 2400,
      "bonusBalance": 0
    }
  }
}

Retry the same payload with the same requestId after a transport failure. Reusing that ID with different data returns WITHDRAWAL_REQUEST_CONFLICT.

See withdrawal configuration.