Wallet

Overview

The wallet service handles virtual payments made through our other Commerce services. Players can fill up their wallet by purchasing coins with real currency. Then, players can use those coins to purchase in-game items.

From the Admin Portal, admins can debit or credit coins from or to a player’s wallet, and see the wallet history by searching for a particular User ID, Wallet ID, or email.

Tutorials

Get a Player’s Wallet Info

Get a Player’s Wallet Info Using API

Follow the steps below to retrieve information about a player’s wallet:

  1. Use the GET /admin/namespaces/{namespace}/users/{userId}/wallets/{walletId} endpoint.
  2. Input the Namespace with Publisher Namespace.
  3. Input the Wallet ID. When you’re done, the User ID, Currency Code, Currency Symbol, and Balance for the player will be retrieved.

Get a Player’s Wallet Info Through the Admin Portal

  1. In the E-Commerce section of the Admin Portal, open the Wallets menu.

    wallet

  2. Filter the search to search by Wallet ID. Then, input the Wallet ID.

    wallet

  3. Here you can see the information about the wallet along with options to credit or debit funds to or from the wallet.

    wallet

List a Player’s Wallet Transactions

List a Player’s Wallet Transactions Using API

You can list a player’s wallet transactions by following the steps below. The transactions will start from the time the wallet was created and will be listed in descending order.

  1. Use the List user wallet transactions: GET /admin/namespaces/{namespace}/users/{userId}/wallets/{walletId}/transactions endpoint.
  2. Input the Namespace field with the publisher namespace.
  3. Input the User ID of the player whose wallet transaction history you want to retrieve.
  4. Input the player’s Wallet ID.
  5. Input the Offset and Limit if you want the results to be paginated.

Upon successful request, the player’s transaction history will appear.

List a Player’s Wallet Transactions Through the Admin Portal

  1. In the E-Commerce section of the Admin Portal, open the Wallets menu.

    wallet

  2. Filter the search with either the player’s Wallet ID, Email, or User ID. In this case, we’ll select User ID.

    wallet

  3. The player’s wallet information will appear, divided into rows based on currency. Choose which currency you want to view transactions for, then click View in the History column of that row.

    wallet

  4. A pop up of the Wallet History will appear which displays the history in descending order.

    wallet

Credit a Player’s Wallet

Credit a Player’s Wallet Using API

You can credit funds to a player’s wallet. If the wallet does not exist, this function will create a new wallet with the defined certain currency code for the player. Follow the steps below to credit a wallet.

  1. Use the Credit a user wallet by currency code: PUT /admin/namespaces/{namespace}/users/{userId}/wallets/{currencyCode}/credit endpoint.

  2. Input the Namespace with the publisher namespace.

  3. Input the User ID.

  4. Input the Currency Code of the Currency you want to credit.

  5. Fill out the Request Body:

    • Input Amount you want to credit.
    • Input the Source field with where the credit is coming from. For example, the player could be receiving the credit as a Referral Bonus.
    • Describe the Reason for the credit.

Upon successful request, the credit will be added to the player’s wallet.

Credit a Player’s Wallet Through the Admin Portal

  1. In the Admin Portal, search for the player’s wallet. Choose the wallet you want to credit, then click Credit in the Actions column.

    wallet

  2. After the Credit Wallet form appears, fill in the required information.

    • Input the Amount you want to credit. In this example we’ll input 50 JC.
    • Select the Source of the credit. For example, the credit could be a Referral Bonus.
    • Describe the Reason for the credit.

    wallet

  3. Click Credit and the amount will be credited to the player.

    wallet

    The credited amount will appear in the player’s balance in the Player Portal.

    wallet

Debit a Player’s Wallet

Debit a Player’s Wallet Using API

You can debit funds from a player’s wallet by following the steps below.

  1. Use the Debit a User Wallet: PUT /admin/namespaces/{namespace}/users/{userId}/wallets/{walletId}/debit endpoint.
  2. Input the Namespace with the publisher namespace.
  3. Input the player’s User ID.
  4. Input their Wallet ID.
  5. Fill out the Request Body.
    • Input the Amount to be debited.
    • Describe the Reason for the debit.

Debit a Player’s Wallet Through the Admin Portal

  1. In the Admin Portal, search for the player’s wallet. Choose the correct wallet from the search results and in the Actions column for that wallet, click Debit.

    wallet

  2. After the Debit Wallet form appears, fill in the required information.

    • Input the Amount you want to debit. In this example, we input 30 JC.
    • Describe the Reason for the debit.

    wallet

  3. Click Debit and the defined amount will be debited from the player’s wallet.

    wallet

    The debited amount will be removed from the player’s balance in the Player Portal.

    wallet

What’s Next?

  • Check out the API Reference for the payment service.
  • Learn more about our Payment service by reading our Payments guide.