Get Transactions API
The new Get Transactions API allows you to retrieve transaction data for a given time period.Content API Service
We’ve added a newtag property to the following Content APIs:This property lets you add an internal tag to each content item to better organize your content. Tags are for internal use only and are not visible to players.Offer Components API and Assets API
We’ve added new GET endpoints that allow you to retrieve a complete list of each entity type, including offer designs, products, badges, and assets.Offer Components API:Assets API:Offers V2 API Service
We added a newprogressBarPoints object to the productsSequence property in following Offers V2 APIs:This object assigns point values to offers that contribute toward a progress bar. It includes the following properties:publisherBarId: ID of the Progress Bar this offer contributes to.points: Number of points awarded when this offer is purchased or claimed.
Progress Bar API Service
The new Progress Bar API service allows you to create and manage Progress Bar offers in your web store. Progress Bars are offers that encourage players to purchase additional offers.The Progress Bars API includes the endpoints:- Create Progress Bar: Creates a new Progress Bar offer.
- Update Progress Bar: Updates an existing Progress Bar offer.
- Get Offers: Retrieves a specific Progress Bar offer, or a list of all Progress Bar offers.
- Delete Offer: Deletes a Progress Bar offer.
Create Checkout Session API
We added a newparsedUrl property to the Create Checkout Session API response.This property will now be used in upcoming SDK updates. In a later release, parsedUrl will replace the existing url and checkoutSessionToken properties. We’ll notify you in advance when migration is required.Web Store Events
We added a newoffers.tab property to the Offers Loaded and Offers Displayed events. This property represents the tab in which the offer is in.WebGL
We’ve consolidated our WebGL support into the Payment Links SDK for Unity. As of this release, the standalone WebGL SDK is deprecated, and all WebGL-related features, updates, and integrations are now fully included within the Payment Links SDK.Content API Service
The new Content API service allows you to create and manage content items in your Game Portal.The Content API includes the endpoints:- Create Content: Creates a new content item.
- Get Content: Retrieves a list of all content items.
- Get Content By ID: Retrieves a specific content item by its ID.
- Update Content: Updates a content item.
- Delete Content: Deletes a content item.
Personalize Web Store Callback
We added a newstoreTheme object to the Personalize Web Store Callback, allowing you to override the background images configured in the Publisher Dashboard for both mobile and desktop versions of your web store.The object includes the following properties:bgImageMobile: Name of the asset to use as the background image on mobile devices.bgImageDesktop: Name of the asset to use as background image on desktop devices.
Personalize Web Store Callback
We added a newoffers.productsSequence.progressBarPoints object to the Personalize Web Store Callback for implementing the new Progress Bar offer. This object assigns point values to offers that contribute toward a progress bar.The object includes the following properties:publisherBarId: ID of the Progress Bar this offer contributes to.points: Number of points awarded when this offer is purchased or claimed.
Trigger Web Store Personalization By Player ID
We’ve added a new API, Trigger Web Store Personalization By Player ID, that allows you to trigger Web Store Personalization on-demand for individual players.This gives you finer control by letting you refresh personalization for a single player instead of triggering a refresh for all active players.Web Store Personalization
We’ve updated our terminology to make it more consistent and easier to use:The Personalization API is now called Personalize Web Store Callback.Learn more about the Web Store Personalization feature.Unity Payment Links SDK
We’ve released a new Payment Links SDK for Unity that provides a unified cross-platform solution for both iOS and Android. This replaces the previous platform-specific Unity implementations.What’s changed:Previously, the Payment Links SDK was organized by platform with separate Unity implementations:- iOS (Native and Unity)
- Android (Native and Unity)
- iOS (Native)
- Android (Native)
- Unity (Cross-platform for iOS and Android)
Personalization Response Error Event
We’ve added a new Personalization Response Error event, which replaces the deprecated Invalid Property Error event. The deprecated event will continue to be supported for backward compatibility, but we recommend migrating to the new event.Create Checkout Session API
We added a newcountryCode2 property to the Create Checkout Session API request. Use this to specify the player’s two-letter country code in ISO-3166 alpha-2 format. If not provided, Appcharge determines the customer’s country from the player’s IP address.Create Checkout Session API
We added a newreceiptMetadata object to the Create Checkout Session API request. Use this object to specify the language of customer receipts. If the property isn’t included, the receipt defaults to English, en.The object includes the following property:locale: The locale code. Both ISO-639 language code and ISO-3166 country code formats are supported.
Player Authentication
We’ve updated our terminology for clarity:- The Authenticate Player API is now called Authenticate Player Callback
- The Initiate Game Auth API is now called Initiate Game Auth Callback
Translations
The new Translations API service lets you manage translations in the web store, checkout, and game portal, allowing players to view content in their preferred language. The Translations API service includes the following endpoints:- Get Translations: Retrieves a list of all translatable fields and their translations.
- Set Translations: Sets translation content for translatable fields.
Awards
We’ve updated our terminology to make it more consistent and easier to use:Grant Award Callback is now called Grant Award Callback. For more details, see the Awards API service.Learn more about the Awards feature.Offers API
We added a newpublisherTabId property, which allows you to assign offers to tabs in your web store. This property is available in the following APIs:- Bundles
- Special Offers
- Rolling Offers
- Get and Delete Offers
Player Authentication
We’ve updated the Player Authentication terminology to make it more consistent and easier to use:- Player Authentication Webhook is now called Authenticate Player API.
- OTP Authentication Webhook and Pre-Authenticated Login Webhook have been consolidated into the Authenticate Player API. See the introduction for details.
- Password-less Authentication (OTP) is now called Game Redirect Login. Its webhook, previously OTP Deeplink Webhook is now the Initiate Game Auth API.
Personalization API
We added a newlogo property to the Personalization API. This property is the asset ID of a logo uploaded via the Assets Library. Use it to display a custom logo in your web store.Grant Award Callback
The Grant Award Callback now includes thetaxRate property, allowing you to track the percentage of tax paid by the player.Offer Components API
The new Offer Components API is a suite of APIs that allows you to create and manage the individual elements that make up your web store’s offers, including products, layout designs, and badges.The Offer Components API includes the following:- Offer Designs API: Design the layout of your bundles, special offers, popups, and rolling offers.
- Products API: Configure products for your offers, such as virtual or time-based items.
- Badges API: Create visual badges in the form of ribbons or emblems to highlight offers.
Assets API
The new Assets API allows you to create and manage visual assets such as backgrounds, logos, favicons, and offer headers in the Assets Library.Player Authentication Webhook
We added a newplayerLocation object to the Player Authentication Webhook request. This object provides information about the player’s location, and includes the following properties:countryCode: Two-letter country code in ISO-3166 alpha-2 format.state: Two-letter state code.
Initiate Refund API
The new Initiate Refund API allows you to initiate a full refund for a specified order. Upon successful processing, the full amount is reimbursed to the player, and the order status is updated accordingly.Personalization API
We added 2 new properties to the Personalization API:offers.offerDescriptionOverride: Replaces the current offer description in the store UI with a custom description.offers.productsSequence.products.traits: Defines a list of visual or descriptive features associated with the product, such as bonuses or variants. Each trait includes atextfield describing the feature and anassetIdreferencing the associated asset from your Asset Library.
Personalization and Create Checkout Session APIs
We added a newattributes property to both the Personalization API and the Create Checkout Session API. This object allows you to define custom key-value pairs to tag players for A/B testing, segmentation, or other use cases. These tags can then be used to filter players in the Publisher Dashboard.iOS Payment Links SDK for Unity
The iOS Payment Links SDK is now available for Unity iOS. The SDK makes it easy to add the iOS Payment Links feature to your app. Instead of relying on traditional in-app purchases, players can buy items like coin packs, character skins, or bundles through a fast, mobile-optimized checkout page.Personalization API
We added a newoffers.productsSequence.products.endsIn property to the Personalization API. This property indicates how much time remains before an offer expires, using an epoch timestamp in milliseconds.Cancel Checkout Session API
The new Cancel Checkout Session API allows you to cancel an open checkout session at any time, such as when multiple checkout tabs are open.iOS Payment Links SDK
The new iOS Payment Links SDK allows you to easily integrate a mobile checkout experience directly into your iOS game. Instead of relying on traditional in-app purchases, players can buy items like coin packs, character skins, or bundles through a fast, mobile-optimized checkout page.Store Interaction Events
We added thesessionId property to Store Interaction Events, allowing you to identify the player session associated with each event.Pre-Authenticated Login Webhook
The Seamless Login Webhook has been renamed to the Pre-Authenticated Login Webhook.Grant Award Callback
We added a newpaymentPriceInDollar property to Grant Award Callback. This property represents the base price of the offer in USD cents.Note that this is not the same as originalPriceInDollar, which is also the base price in USD cents—but if you’re using Appcharge’s Web Store and pricePointMetadata is provided, then pricePointMetadata overrides originalPriceInDollar.Create Checkout Session API
We added a newquantityDisplay property to items object in the Create Checkout Session API. This property overrides the quantity value displayed in the checkout.Auto-Update SDK
The new Auto-Update SDK enables you to seamlessly update your app without requiring players to manually download and install a new version. This allows you to quickly roll out critical updates, new content, or bug fixes. It ensures a smoother player experience and helps maintain version consistency.The Auto-Update SDK is available for Android and Unity.Appcharge Payment Links
The new Appcharge Payment Links feature allows players to make secure purchases in your iOS game. Players can buy digital content such as bundles, coin packs, or skins through a secure and branded page outside your app, giving you more control over the purchase experience and a seamless checkout flow.See a sample Unity app flow that guides you through the recommended process for integrating Appcharge Payment Links into an iOS game.Personalization Trigger API
The new Personalization Trigger API enables you to invoke the Personalization API on demand, giving you more control over when player data is refreshed. This gives you the flexibility to respond to time sensitive moments, like when a player runs out of resources and needs a personalized refill offer. It also helps with operational fixes, such as correcting an invalid offer to avoid unnecessary costs.Learn more about the Personalization feature.Checkout Link Offers API
The Offers V2 API now includes a new Checkout Link Offers API, which allows you to generate deeplinks that direct players to the checkout page, pre-configured with a unique offer. This feature is useful for sending exclusive, personalized offers outside the webstore, such as through a social media broadcast distributor.With the new Checkout Link Offers API you can:Learn more in the Checkout Link Offers guide.Personalization API
The Player Info Sync Webhook has been renamed to the Personalization API.UTM Parameters
We added newutmSource, utmMedium, and utmCampaign properties to the Player Authentication Webhook. These same properties are now also included as a utms object within the storeMetadata field of the Grant Award Callback. This allows you to track the origin of your players, the channels they came through, and the campaigns that brought them in.Player Info Sync Webhook
ThedynamicOfferUi object is deprecated. See the new structure below:For Rolling Offers:dynamicOfferUi.badges→offers.productsSequence.badgesdynamicOfferUi.offerDesignId→offerDesignSyncOverride.offerDesignIddynamicOfferUi.salePercentage→offers.productsSequence.productSale.saledynamicOfferUi.salePercentageDisplayType→offers.productsSequence.productSale.type
dynamicOfferUi.badges→offers.badgesdynamicOfferUi.offerDesignId→offerDesignOverride.offerDesignIddynamicOfferUi.salePercentage→offers.productSale.saledynamicOfferUi.salePercentageDisplayType→offers.productSale.type
Note: These properties do not apply to Checkout Link Offers because there is no support for configuring badges, sale percentages, or offer designs for them.
Player Info Sync Webhook
We added a newplayerLevelBanners object to the Player Info Sync Webhook, allowing you to dynamically display specific banners to players based on their game level.VueJS 3 SDK
We released a new VueJS 3 SDK that supports the latest Vue.js version, Vue 3. See the documentation for more details.WebGL SDK for Unity
The new WebGL SDK for Unity provides a streamlined in-game payment solution, enabling secure and native transactions. With a quick and easy setup, it supports multiple payment methods, ensuring accessibility for all players. This integration enhances the player experience while maximizing revenue with minimal effort.For updates to the SDK, refer to the WebGL SDK for Unity Changelog.Offers V2 API
A new version of the Offers API is now available. Offers V2 API enables you to create and manage offers more effectively, helping to enhance player engagement and improve customer retention. It supports various offer types, including bundles, special offers, daily bonuses, and post-purchase deals.With the Offers V2 API, you can:- Create and update a bundle.
- Create and update a special offer.
- Create and update a rolling offer.
- Create and update a daily bonus.
- Create and update a post-purchase popup.
- Get and delete offers.
- A new
productSaleobject includes theamountBeforeSaleproperty. - The
dynamicOfferUiproperty is deprecated. Sending this in the payload will result in failure:dynamicOfferUi.badges→ moved to root asbadgesdynamicOfferUi.salePercentage→ moved toproductSale.salePercentagedynamicOfferUi.salePercentageType→ moved toproductSale.salePercentageType
- The
intervalsproperty is deprecated. Use thescheduleproperty instead. - The
coolDownInHoursproperty is deprecated. - The
publisherSectionIdproperty is now only relevant for the Bundles API.
Rolling Offers API
The Offers API contains a new Rolling Offers API that allows players to unlock deals in succession. As each offer is claimed, the next one is revealed, keeping players engaged and eager to continue. The rolling offer feature boosts player interaction and maximizes revenue potential.With the new Rolling Offer API you can:- Create a rolling offer.
- Update a rolling offer.
Offers API
We added a newschedule property in the Create an Offer and Update an Offer APIs, allowing you to specify the time intervals when promotions are available to players.