Documentation

RestoreIOSPurchases

Restores all in-app purchases based on the given restore receipt

Request Details

The title should obtain a refresh receipt via restoreCompletedTransactions in the SKPaymentQueue of the Apple StoreKit and pass that in to this call. The resultant receipt contains new receipt instances for all non-consumable goods previously purchased by the user. This API call iterates through every purchase in the receipt and restores the items if they still exist in the catalog and can be validated.

RestoreIOSPurchasesRequest
Request Properties
ReceiptData (required) String

Base64 encoded receipt data, passed back by the App Store as a result of a successful purchase.

POST https://{{TitleID}}.playfabapi.com/Client/RestoreIOSPurchases
    Content-Type: application/json
    X-Authentication: <user_session_ticket_value>
{
  "ReceiptData": "F00000000000000000000"
}
        

Response Details

Once verified, the valid items will be restored into the user's inventory.

RestoreIOSPurchasesResult
Result Properties

Sample Response

HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8
{
  "code": 200,
  "status": "OK",
  "data": {}
}

Authentication

SessionTicket

Possible Error Codes

Name Code
DownstreamServiceUnavailable 1127
InvalidBundleID 1098
InvalidCurrencyCode 1179
InvalidReceipt 1021
InvalidVirtualCurrency 1051
NoMatchingCatalogItemForReceipt 1178
ReceiptAlreadyUsed 1022
ReceiptContainsMultipleInAppItems 1097
ReceiptDoesNotContainInAppItems 1096