Player Info Sync

Response fields reference:

Parameter Table

Language

URL

Click Try It! to start a request and see the response here!

Parameter	Type	Optional	Description
status	Enum: valid / invalid	No	Indicates if the request was valid or invalid.
version	int	No	The used version, value is 2.
sessionMetadata	any	No	Container for storing any pertinent information related to the player's session. Sent back in the Player Orders Reporting web-hook, and Player Info Sync (if enabled).
profileFrameId	string	Yes	Corresponds to the profile frame picture ID uploaded to the asset library in Appcharge's dashboard. Displayed above the user's profile picture.
playerLevelName	string	Yes	Aligns with the player level picture name/ID uploaded to the asset library in Appcharge's dashboard. Displayed alongside the footer.
offers	array	Yes	The list of offers to show to the player.
publisherOfferId	string	No	The publisher's offer id.
productsSequence	array	No	The list of sequences in the offer. Only Daily Bonus offer can have more than 1 sequence.
index	int	No	The index of the sequence, index should always start from 1.
playerAvailability	object	Yes	Contains the total and remaining number of times that the product can be purchased by the player. Supported only for Special Offers (Promotions).
total	int	No	The total number of times that the offer is available for the player. Should be greater than 0.
products	array	No	The products in the sequence. Daily Bonus offers should have only 1 product per sequence.
publisherProductId	string	No	The product Id.
quantity	int	No	The quantity of the product. Should be greater than 0 and equal to or less than 19 digits long.
badgeText	string	No	The product's badge text.
rarityProductInfo	object	No	The rarity information of the product.
stars	int	No	The number of icons (stars) representing the rarity of the product. Displayed next to the product and inside the tooltip.
tooltipText	string	No	The text of the tooltip.
rarityText	string	No	The text that appears next to the product and inside the tooltip, before the rarity icons (stars).
dynamicOfferUi	object	Yes	The dynamic OfferUi details.
badges	array	No	The list of badges in the offer.
publisherBadgeId	string	No	The publisher's badge id.
position	int	No	This field is outdated. The position of the badge should be set from Dashboard only.
salePercentage	int	Yes	The sale percentage of the offer.
salePercentageDisplayType	enum	Yes	The sale percentage type for the offer. Optional Values: percentage, multiplier, fixed_amount.
amountBeforeSale	int	Yes	The original price of a product before discounts. Copied to FE without any logic on Appcharge's side.
segments	array of strings	Yes	The list of segments of the player.
balances	array	Yes	A list of product balances of the player.
publisherProductId	string	No	The publisher's product id.
quantity	int	No	The quantity of the product. Should be greater than or equal to 0 and less than or equal to 24 digits long.
focus	object	No	Customize which offer you want to focus on.
publisherBundleId	string	No	The id of the bundle to focus on in the web store.
sectionsOrder	array	Yes	An array of publisher’s section ids that defines the order of sections for the store.
offersOrder	string	Yes	Defines order of offers. Optional values: publisherOrder, priceHighToLow, priceLowToHigh. Default value will be priceLowToHigh.