Handle errors in iOS SDK
Adapty SDK has its own wrapper for all kinds of errors, called AdaptyError. Basically, every error returned by an SDK is AdaptyError. It has two useful properties: originalError and adaptyErrorCode, described below.
originalError contains an original error in case you need the original one to work with. Can be SKError, NSError or just general Swift Error. This property is optional since some errors can be generated directly by SDK, like inconsistent or missing data, and won't have the original error around which the wrapper was initially built.
adaptyErrorCode can be used to handle common issues, like:
- invalid credentials
- network errors
- cancelled payments
- billing issues
- invalid receipt
- and much more
It's pretty easy to check the error for specific codes and react to them accordingly.
do {
let info = try await Adapty.makePurchase(product: product)
} catch {
if error.adaptyErrorCode == .paymentCancelled {
// purchase was cancelled
// you can offer discount to your user or remind them later
}
}
If these solutions don't resolve your issue, see Other issues for steps to take before contacting support to help us assist you more efficiently.
StoreKit errors
| Error | Code | Solution |
|---|---|---|
| unknown | 0 | Error code indicating that an unknown or unexpected error occurred. Retry or see the Other issues section. |
| clientInvalid | 1 | This error code indicates that the client is not allowed to perform the attempted action. |
| paymentCancelled | 2 | This error code indicates that the user canceled a payment request. No action is required, but in terms of the business logic, you can offer a discount to your user or remind them later. |
| paymentInvalid | 3 | This error indicates that one of the payment parameters was not recognized by the App Store. |
| paymentNotAllowed | 4 | This error code indicates that the user is not allowed to authorize payments. |
| storeProductNotAvailable | 5 | This error code indicates that the requested product is not available in the store. Try re-installing the app. |
| cloudServicePermissionDenied | 6 | This error code indicates that the user has not allowed access to Cloud service information. |
| cloudServiceNetworkConnectionFailed | 7 | This error code indicates that the device could not connect to the network. |
| cloudServiceRevoked | 8 | This error code indicates that the user has revoked permission to use this cloud service. |
| privacyAcknowledgementRequired | 9 | This error code indicates that the user has not yet acknowledged Apple’s privacy policy. |
| unauthorizedRequestData | 10 | This error code indicates that the app is attempting to use a property for which it does not have the required entitlement. |
| invalidOfferIdentifier | 11 | The offer Make sure you set up desired offers in AppStore Connect and pass a valid offer identifier. |
| invalidSignature | 12 | This error code indicates that the signature in a payment discount is not valid. |
| missingOfferParams | 13 | This error code indicates that parameters are missing in a payment discount. |
| invalidOfferPrice | 14 | This error code indicates that the price you specified in App Store Connect is no longer valid. Offers must always represent a discounted price. |
| noProductIDsFound | 1000 | This error indicates that none of the products you requested on the paywall are available for purchase in the App Store, even though they’re listed there. This error may sometimes come with an If you’re encountering this error, follow the steps in the Fix for Code-1000 |
| noProductsFound | 1001 | This error indicates that the product requested for purchase is not available in the store. |
| productRequestFailed | 1002 | Unable to fetch available products at the moment. |
| cantMakePayments | 1003 | In-app purchases are not allowed on this device. See the troubleshooting guide. |
| noPurchasesToRestore | 1004 | This error indicates that the App Store did not find the purchase to restore. |
| cantReadReceipt | 1005 | There is no valid receipt available on the device. This can be an issue during sandbox testing. In the sandbox, you won't have a valid receipt file until you actually make a purchase, so make sure you do one before accessing it. During sandbox testing also make sure you signed in on a device with a valid Apple sandbox account. |
| productPurchaseFailed | 1006 | Product purchase failed. The StoreKit error unrelated to Adapty. Try using a new sandbox profile. If it doesn't help, contact the Apple support. |
| missingOfferSigningParams | 1007 | This error indicates issues with Adapty integration or with offers. Refer to the Configure App Store integration and to Offers for details on how to set them up. |
Network errors
| Error | Code | Solution |
|---|---|---|
| notActivated | 2002 | The Adapty SDK is not activated. You need to properly configure Adapty SDK using the Adapty.activate method. |
| badRequest | 2003 | Bad request. Ensure you've completed all the steps required to integrate with the App Store. |
| serverError | 2004 | Server error. Try again after some time. If the issue is not resolved, contact the Adapty support team. |
| networkFailed | 2005 | The error indicates issues with the network connection on the user's device. Try disabling VPN or switching to WiFi from a cellular network or vice versa. |
| decodingFailed | 2006 | This error indicates that response decoding failed. Review your code and ensure that you the parameters you send are valid. For example, this error can indicate that you're using an invalid API key. |
| encodingFailed | 2009 | This error indicates that request encoding failed. |
| missingURL | 2010 | The requested URL is nil. |
General errors
| Error | Code | Solution |
|---|---|---|
| analyticsDisabled | 3000 | We can't handle analytics events, since you've opted it out. |
| wrongParam | 3001 | This error indicates that some of your parameters are not correct. If you're using the Adapty paywall builder and can't display a paywall because of this error, toggle on Show on device in the paywall builder. Another possible reason for this issue is that the local fallback file version doesn't match the SDK version. Download a new file in the dashboard. |
| activateOnceError | 3005 | It is not possible to call .activate method more than once. |
| profileWasChanged | 3006 | The user profile was changed during the operation. This error can occur when you call identify, and then call another method before identify succeds. To avoid it, wait untill identify suceeds before calling other methods. |
| unsupportedData | 3007 | This error indicates that the data format is not supported by the SDK. |
| persistingDataError | 3100 | It was an error while saving data. |
| fetchTimeoutError | 3101 | This error indicates that the fetch operation timed out. |
| operationInterrupted | 9000 | This operation was interrupted by the system. |
Other issues
If you haven't found a solution yet, the next steps can be:
- Upgrading the SDK to the latest version: We always recommend upgrading to the latest SDK versions since they are more stable and include fixes for known issues.
- Contact the support team via [email protected] or via the chat: If you are not ready to upgrade the SDK or it didn't help, contact our support team. Note that your issue will be resolved faster if you enable verbose logging and share logs with the team. You can also attach relevant code snippets.