Configure revocation rules
Overview
The AccelByte Gaming Services (AGS) Revocation service enables you to configure and customize your revocation strategy logic for durable entitlements, consumable entitlements, and virtual currencies.
This article walks you through how to configure revocation rules correctly based on your preferences and business needs as well as the implications of each rule.
Prerequisites
- Store, wallets, and in-app purchase services are configured properly.
- If the user intends to use customized revocation rules, the custom service address must be configured properly.
Configure revocation strategies
Revoke virtual currency
In the AGS Admin Portal, go to your namespace.
On the sidebar, go to Commerce> Revocations > Configurations.
If you would like to enable virtual currency revocation, turn on the Allow Revocation toggle, then select your preferred revocation strategy.
Fail Revocation if Wallet Balance would drop below 0: Select this when the amount to be revoked is greater than a player's wallet balance, the revocation will be failed.
Allow negative wallet balance: Select this when the amount to be revoked is greater than a player's wallet balance, the player's wallet balance will be deducted accordingly and become negative.
Customization: Select this to use your own custom revocation strategy by using gRPC Custom Service.
note- Virtual currencies can only be deducted from their corresponding wallets.
- Custom Service gRPC Server Address needs to be configured if you would like to use customization.
Durable entitlements revocation
To configure your preferred strategy for durable entitlements, follow these steps:
In the AGS Admin Portal, go to your namespace.
On the sidebar, go to Commerce> Revocations > Configurations.
On the Revocation Configurations page, select Entitlement (Durable).
Select your preferred strategy for durable entitlements.
- Default: Entitlement will be revoked from the player's account.
- Customization: Use your own custom revocation strategy by using gRPC Custom Service.
Consumable entitlements revocation
In the AGS Admin Portal, go to your namespace.
On the sidebar, go to Commerce> Revocations > Configurations.
On the Revocation Configurations page, select Entitlement (Consumable).
Select your preferred strategy for consumable entitlements.
- Default: Only consumable entitlements that are unused or with enough use count will be revoked from players.
- Customization: Use your own custom revocation strategy by using gRPC Custom Service.
View revocation history
In the AGS Admin Portal, go to your namespace.
On the sidebar, go to Commerce> Revocations > Revocation History. The Revocation History page appears, showing a table of all historical revocation records is displayed.
On the Revocation History page, you can narrow down your search by using the All Source and All Status filters, or search for individual user records by using the Search by User ID search box.
- All Source: This includes Order, downloaded content (DLC), and Other, which indicates where these revocations came from.
- All Status: This includes "Success" and "Failed".
To open a specific revocation record, click its View button to view its details.
Refund and chargeback
Refund and chargeback events that occur on third-party platforms are hard to detect as AGS is not directly integrated with third-party platforms.
For PlayStation, AGS uses Sony's Commerce Management API to detect when there is a refund or a chargeback event and will revoke or reinstate player entitlements or ownership accordingly.
For other platforms, AGS cross-references durable entitlements a player has on the third-party platform with what the player has on AGS. Then, AGS will revoke or grant entitlements accordingly.
note- This is an automatic process but only happens when a player logs into the game.
- There is no automatic process to revoke consumable entitlements and virtual currencies. Currently, the process has to be manually performed by admins.