Access
Connect cross-platform accounts & identity management
AccelByte Cloud’s Payment service allows transactions to be performed with both real and virtual currency, and integrates with Adyen, Xsolla, Stripe, PayPal, AliPay, WxPay, and wallet services. The payment service provides a retry mechanism that prevents notifications from failing to appear during the payment process. This retry mechanism will resend failed notifications until the client acknowledges their receipt, or the maximum number of retries has been reached.
AccelByte Cloud’s Payment service boasts several features to support the payment process, including:
Permissions (opens new window) are used to grant access to specific resources within our services. Make sure your account has the following permissions before you attempt to manage catalog in the Admin Portal. For a full list of permissions that impact catalog management, see the Platform/Commerce tab of the Permissions Reference (opens new window).
Usage | Resource | Action |
Setting Up a Payment Configuration | ADMIN:PAYMENT:CONFIG | Create |
Get Payment Configuration | ADMIN:PAYMENT:CONFIG | Read |
Permissions work slightly differently depending on whether they are assigned to IAM Clients (opens new window) or Roles (opens new window) assigned to users. For more information, read the Authentication and Authorization (opens new window) documentation.
In the Admin Portal, go to the top-right menu menu, click Platform Configurations, and select Payment Configurations.
Click New Configuration.
Fill in the required fields.
Once completed, click the Submit button and you will be redirected to the Payment Configuration page.
In your newly created payment configurations, go to the Payment Aggregator section and click the Configure Now button.
Fill in the required fields.
Once completed, click Add to save your configuration.
In response to Adyen’s decision to phase out Checkout Web SDK, AccelByte has started migrating to Drop-in. If you currently use Checkout Web SDK, you will need to follow the below steps to migrate.
In the Adyen Payment Configuration Details page, scroll down to Payment Aggregator (ADYEN) select the Drop-In Setting tab. Adjust these settings according to your preferences. See Adyen’s Optional Configuration documentation for a full list and definition of each setting.
In the Admin Portal, go to the Payment Configurations menu under the Platform Configurations dropdown on the top-right header.
Add a new configuration by clicking the New Configuration button.
Fill in the required information.
Click Submit to continue. You will be redirected to the Payment Configuration page.
In the Payment Aggregator section, under the Xsolla tab, fill in the required information.
Input your Xsolla Merchant ID.
Input your Project ID / Project Number from Xsolla.
Input your Project Secret Key from Xsolla.
Input the API Key from Xsolla.
Input the Completion URL with the appropriate format, as seen below:
Dev environment:
https://dev.example.accelbyte.io/paymentCallback
Production environment:
https://example.com/paymentCallback
Click the Test button, and make sure you get Xsolla Configured Correctly notification.
In the Admin Portal, go to the Platform Configurations dropdown and choose Payment Configurations.
Click the New Configuration button to add a new configuration.
Fill in the required fields.
When you’re done, click the Submit button and you will be redirected to the Payment Configuration page.
In the Payment Aggregator section, click Configure Now.
Fill in the required fields.
Click the Test button and make sure you receive a notification that Stripe has been configured correctly.
In the Admin Portal, go to the Payment Configurations menu under the Platform Configurations dropdown on the top-right header.
Add a new configuration by clicking the New Configuration button.
Fill in the required fields.
In the Payment Aggregator section, click the Configure Now button.
A configuration form appears. Fill in the required information.
After configuring the Payment Configuration, you’ll be directed to the Payment Configuration Details. You can click the Test button to make sure that your payment aggregator configuration is working.
After you’ve configured your payment aggregator, you can also configure the payment methods you support.
In the Admin Portal, go to Payment Configurations Details and scroll down to the Payment Methods panel.
In the Payment Methods, choose your payment method and input the required information.
a. For AliPay
b. For AliPay Sandbox
c. For WxPay:
d. For PayPal:
e. For PayPal Sandbox:
Once completed, click the Test button to test the payment configuration.
You can view detailed payment metadata history in the Admin Portal.
In the Admin Portal, go to the E-Commerce section, open the Sales section, and select Payment Metadata.
Here you can see a list of all the payment metadata history in your game namespace. To see the details of a specific payment, click View in the Action column of your selected metadata.
The Metadata List will appear. Here you can see the selected metadata’s detailed information.
In some countries and regions, sales tax needs to be collected during the sale of digital products. Tax law can differ depending on the state, city, or even the district that the player making the purchase lives in. To comply with all of these different regulations, tax handling services can be used. AccelByte supports integration with TaxJar which can be used to automatically calculate and apply sales tax to online purchases.
Integration with TaxJar allows you to configure how sales tax is applied to online purchases. There are two types of configurations that you can create in the Admin Portal:
This can be used if the publisher and developer of your game have separate TaxJar accounts, or are located in different regions. This way, even if the publisher’s TaxJar account is used for the global configuration, online sales made in-game can still use the developer’s TaxJar account for sales tax calculation.
For now, TaxJar can only be enabled for online stores published in the US. Follow the tutorials below to create a global or specific TaxJar integration.
On the Payment Configuration page of the Admin Portal, switch to the TaxJar Integration tab.
On the TaxJar Integration tab, toggle the integration to enable.
Fill in the TaxJar Configuration form.
When you’re done, click Submit.
Next, add the appropriate TaxJar product code to each item type in the TaxJar Product Codes Mapping panel by clicking the pencil icon next to each item type and typing the product code. For digital goods, the product tax code is 31000. You can also browse a list of TaxJar codes in the TaxJar documentation
On the Payment Configuration page of the Admin Portal, click the New Configuration button.
Fill in the Add New Configuration form that appears with the required information:
When you’re done, click Submit.
The specific configuration has been added to the Payment Configuration Details page.
After setting up either a global or specific TaxJar configuration, your TaxJar account will be used to calculate and apply sales tax to online purchases made in your game and publishing platform.