**What is Merchant Simulator?** The merchant simulator is used to simulate the end-to-end payment flows for online merchants. A template is a mapping of APIs and their mock responses using which merchants can simulate the scenarios like Success, Failure, and Pending.

**Benefits of using the Merchant Simulator**

  • Even when the PhonePe UAT server is down, the Merchant simulator gives you a seamless user experience through which you will be able to test the end-to-end payment flow without any interruptions.


## Postman Collection and Setup

  • Download the PhonePe Simulator postman collection from [here](🔗).

  • Once downloaded, import the collection to your Postman.



## Quick Links

  • [Steps for Autopay - UPI](🔗)

  • [Android/iOS Simulator App](🔗)

  • [Configure Template](🔗)

  • [Templates](🔗)

<!-- [Get Configured Template]\([https://developer.phonepe.com/v1/docs/uat-simulator#get-configured-template]()-->

## Steps for Autopay - UPI

Follow the below steps to verify different payment methods on the Custom Checkout page.

  • Update the Host URL of the UAT Simulator:

**Host**: <https://api-preprod.phonepe.com/apis/merchant-simulator>

### Android/iOS Simulator App

  • Download and install the Simulator PhonePe Android/iOS App using the Firebase. **Share the Email Id with the PhonePe Integration Team on the integration thread to send the invite via Firebase.**

<!-- Download and install the Simulator PhonePe App on an android mobile device. APK can be downloaded from [here](https://docs.phonepe.com/public/yp0iw4UBc_SpDb09We7u). https://docs.phonepe.com/public/mCY6eoQBGj1px-63kmEI -->

UAT Simulator App

Android Package Name: **com.phonepe.simulator**

### Configure Template

Download the Demo Video - [Here](🔗)

To configure the required template,

  • Open the UAT Simulator App- Select the **"Test Case Templates"** button.

  • Enter the "Merchant ID" and click "GET CONFIGURED TEMPLATES"

  • Enter the "Merchant ID" and click "GET CONFIGURED TEMPLATES" to fetch the current templates if already set. Else, you will get "No Template Configured"

    • For AutoPay Integration - use the "**Flow: Subscription**" to configure the required template for Success, Failure, or Pending scenarios

Make sure to set the right templates for the Subscription integration.


### Templates


### **Configure Template API**


  • If the merchant wants to test the **UPI Autopay Setup - Success scenario**, the merchant will select **"Autopay - Subscription Setup"** and take the template corresponding to the Success error code **"subscription_setup_upiIntent_success"**.

  • Similarly, for Pending - "subscription_setup_upiIntent_pending" and for Failure - "subscription_setup_upiIntent_failure"

Once configured, you can initiate and complete the payment on the UAT Simulator app.

## Get Configured Template

To get the current configured Template, you can use the **"Get Configured Template"** API call.

### **Get Configured Template API**