Skip to main content
POST
Validate Windows Store Receipt

Authorizations

X-Authorization
string
header
required

This API requires a client session ticket, available from any Client Login function.

Body

application/json
CurrencyCode
string
required

Currency used to pay for the purchase (ISO 4217 currency code).

PurchasePrice
number
required

Amount of the stated currency paid, in centesimal units.

Receipt
string
required

XML Receipt returned by the Windows App Store in-app purchase API

CatalogVersion
string

Catalog version of the fulfilled items. If null, defaults to the primary catalog.

CustomTags
object

The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.).

Response

Once verified, the catalog item matching the Product name will be added to the user's inventory. This result should be used for immediate updates to the local client game state as opposed to the GetUserInventory API which can have an up to half second delay.

code
integer

The Http status code. If X-ReportErrorAsSuccess header is set to true, this will report the actual http error code.

status
string

The Http status code as a string.

data
object

Once verified, the catalog item matching the Product name will be added to the user's inventory. This result should be used for immediate updates to the local client game state as opposed to the GetUserInventory API which can have an up to half second delay.

Example:
Last modified on October 1, 2026