Use App Tester

The App Tester tool enables you to test Amazon In-App Purchasing (IAP) features before publishing your app to the Amazon Appstore. Once you have downloaded, installed, and set up the App Tester tool, you can start testing purchasing features in your app.

If you have not already set up the App Tester for your app, see Install and Configure App Tester.

Amazon App Tester is a tool to simulate authorization with the Appstore. Download the App Tester.

Steps to use App Tester

To use Amazon App Tester to verify your app, do the following:

1. Verify that the below configuration is added in the manifest.toml.

   Copy code Copied to clipboard.

   [wants]// ... other wants
   [[wants.service]]id = "com.amazon.iap.tester.service"
   

2. Connect your computer to a Fire TV through VDA. See details about VDA.

3. Set your app in sandbox mode using the following steps:
   1. Create a JSON file and name it amazon.config.json. The contents of the JSON file will be as follows.

   Copy code Copied to clipboard.

     {
              "debug.amazon.sandboxmode": "debug"
     }
   

   This is different from the JSON file provided for the IAP Tester.

   1. Create a directory /tmp/scratch/<your-application-id> inside the Vega Virtual Device (VVD) or the device.
   2. Push the JSON file to the location you just created. To push to a device, see Install App Tester on your device. To push to VVD, see How to install App Tester on VVD.
   3. Relaunch (terminate and relaunch) the application for the changes to take place.

   4. To disable sandbox mode, change the value present in the JSON file from debug to prod or delete the JSON file.

      Note: Every time you make a change in the JSON file, the application should be relaunched (terminated and relaunched). If you don’t, the changes won’t be applied.

   Sandbox mode constrains calls that would normally go to the Appstore client to route to the Amazon App Tester app instead. Use this mode only for testing locally.

4. Uninstall any existing version of the Amazon App Tester, and then download it and open it on your Fire device.

How to install App Tester on VVD

Install App Tester on VVD with the following.

Copy code Copied to clipboard.

   vpm install <appname.vpkg>

Uninstall App Tester from VVD with the following.

Copy code Copied to clipboard.

   vpm uninstall <package_id>

Choose the IAP API

When you first launch the App Tester App, the you will see a splash screen:

Tap the Appstore SDK API's prompt to begin.

The App Tester displays a list of navigation options for IAP API:

1. User Account Settings: Configure the user test accounts for your app.
2. Subscription Purchase Settings: Use Subscription Purchase Settings to test RVS Sandbox responses.
3. IAP API Response Settings: Configure the conditions and responses for your test cases.
4. Manage Transactions: Manage the active IAP transactions for your app.
5. Notification Settings: Enable or disable the notifications that are added to the notification drawer.
6. IAP Items in JSON File: View the data that you added to the App Tester from your JSON file in an easily human-readable format.

Manage users

You can log a user in and out, change users, and change the market place associated with a user. These options facilitate testing different scenarios with different users in different marketplaces.

To access the user management screen, select the IAP API from the App Tester landing page, then tap User Account Settings.

Log in and out

To toggle the current user between being logged in and logged out, under Status tap the Logged in or Logged Out option.

Change the current user

App Tester provides three different test user accounts. Test users are named Amazon User 1, Amazon User 2, and Amazon User 3.

To change users, look under Amazon User Id, and select the user Id that you want to use for testing.

Change user marketplace for the current user

App Tester provides you with the ability to test your app in different international markets. To change the market place associated with the current user, look under User Marketplace and select a new market. The following markets are available:

• US: United States of America
• CA: Canada
• BR: Brazil
• MX: Mexico
• GB: Great Britain
• DE: Germany
• ES: Spain
• FR: France
• IT: Italy
• IN: India
• JP: Japan
• AU: Australia

Change the consent status for user profile access

App Tester provides two options for consent status: UNAVAILABLE and CONSENTED. To change the consent status, see the Consent Status for User Profile Access and select the status you want to use for testing.

Subscription settings

Use Subscription Purchase Settings to test RVS Sandbox responses.

Configure API response settings

Use the IAP API Response Settings tab to set the conditions and responses for your test calls to the IAP API:

When specifying a response, "Default" in the following sections simply means to use the existing default settings. "Default" is not an available setting itself. If you explicitly select a value, such as SUCCESSFUL or FAILED, the App Tester will return the selected value. For example, getProductData will return SUCCESSFUL if the JSON file contains the requested SKU. GetUserData will return FAILED if the user is set to Logged Out in User Account Settings.

The following table shows the available responses for the IAP APIs.

Manage transactions

Use the Manage Transactions tab to view, cancel, and delete purchase transactions for the current user. Cancelling and deleting transactions are helpful tools when testing entitlements and subscriptions. This tab displays all transactions for the current user.

The Manage Transactions tab contains the following information for each transaction:

• RECEIPT: Type of product purchased. Valid values for IAP are CONSUMABLE, ENTITLEMENT, and SUBSCRIPTION.
• RECEIPT ID: Unique identifier for the transaction.
• SOLD BY: App that sold the item.
• PURCHASED ON: Date that the item was purchased.
• STATUS: Transaction status. Valid values are PURCHASED or CANCELED. These App Tester values map to the IAP API values FULFILLED and UNAVAILABLE, respectively.

When an app calls PurchasingService.notifyFulfillment({receiptId: receipt.receiptId, fulfillmentResult: FulfillmentResult.FULFILLED}), the receipt shows up in the Manage Transactions section with status: FULFILLED.

 From the Manage Transactions tab, you can perform the following tasks:

• Refresh the list of transactions for the current user.
• Delete all transactions for the current user.
• Cancel an individual transaction.
• Delete an individual transaction.

Enable or disable your notifications

Use the Notifications Settings tab to easily enable or disable the notifications that are added to the system's notification drawer.

The following image shows the Notification Settings tab:

The following notification settings are available:

• Purchase Updates Notifications: By default, Amazon sends a notification when an app loads a purchase dialog but has never called getPurchaseUpdates().  Amazon stops sending this notification after the app calls getPurchaseUpdates() once. Use the Purchase Updates Notifications setting to toggle whether Amazon ever sends this notification.

• Notify Fulfillment Notifications: By default, Amazon sends a notification if a user makes a purchase and the item is not fulfilled within 30 seconds. Use Notify Fulfillment Notifications to toggle this notification on or off.

• Reset Purchase Updates: Resets the state indicating whether or not getPurchaseUpdates() has been called.

View the IAP items in your JSON file

To provide an easy way to view the IAP items in the JSON file that you configured in Installing and Configuring the App Tester, tap the IAP Items in JSON File tab. If you have correctly added a valid JSON file, the App Tester will parse and display the contents of the file under this tab.

If you have not correctly added a valid JSON file, this tab will either display an error message or will specify that the JSON file does not exist.

Simulate the users experience

In addition to providing responses to API requests, the App Tester can display purchase flow dialogs, just like a live, published app does. The benefit of this feature is that the dialogs can help you to evaluate the user experience for your app's purchase process.

App Tester displays two interstitial dialogs for each Purchase Request. The first dialog is a detail screen that shows the purchase price and other details, as shown in the following IAP example:

Here is an example of an in-app purchase:

The second dialog is a "thank you" screen that a user must manually close by tapping the "X" button in the upper right-hand corner, as shown in the following IAP example:

IAP Tester logs

Here are some details about logging in IAP Tester:

• To learn more, see Debug Your App.
• To get the IAP Tester logs, grep for this keyword: “AmazonIAPTester”.

  Copy code Copied to clipboard.

   grep "AmazonIAPTester" -rn .
  

Last updated: Sep 30, 2025