search

EMI Subvention through All-in-One SDK

EMI subvention on All-in-One SDK solution can be integrated with minimal effort at merchant's end by just sending one extra object in the Initiate transaction API. This object is required to be passed whenever merchant intends to offer EMI subvention as payment mode to their users.

 

Paytm backend will configure the banks and EMI plans on which merchant wants to offer EMI subvention. Once this configuration is done then Paytm would manage the eligibility during the transaction.

Transaction flow

  1. User visits merchant's mobile application and adds goods/services into the shopping/order cart. Merchant's backend server calls Initiate Transaction API with an additional simplifiedSubvention object to get the transaction token. Below example shows the simplifiedSubvention object required to be added to the Initiate Transaction API call based on the subvention strategy.

     

    In case you want to integrate an amount based EMI subvention, you need to pass the simplifiedSubvention Object as explained in the example below. In this example, the total cart amount is of Rs. 2000 out of which you want to offer EMI Subvention on Rs. 1100.
     

    "simplifiedSubvention":{ 
          "customerId": "1234",
          "subventionAmount": "1100.00", //amount eligible for EMI subvention
          "selectPlanOnCashierPage": true  
    }
    

    In case you want to integrate an item based EMI subvention, you need to pass the simplifiedSubvention Object as explained in the example below. In this example, there is 1 item in the cart and you want to give EMI subvention on it, then you pass the identifier of the item in the simplifiedSubvention Object. You need to send the same identifiers as you have got configured at Paytm Subvention engine.
     

    "simplifiedSubvention": {
        "customerId": "1234",
        "items": [
           { 
              "quantity": 1, //quantity of the product.quantity
              "productId": "321067334", //unique product identifier for the merchant
              "price": 10000, //cumulative price of the product
              "brandId": "53066",
              "categoryList": [
                    "66781"
                     ], //Product category identifiers for the merchant
              "model": "",
              "merchantId": "1152435",
              "id": "1" //unique identifier for one item in the request
          } 
        ],   
       "selectPlanOnCashierPage": true 
    }
    
    
  2. Launch Paytm All-in-One SDK with the transaction token received as the response of Initiate Transaction API from step 1. Please refer All-in-One SDK integration document for detailed steps.

  3. In case the Paytm app is installed on a user's device, the user completes the payment on invoked Paytm app else the transaction will be processed via web view within the All-in-One SDK(Paytm hosted redirection flow).

  4. User selects the EMI as a payment instrument and fills the details of the credit card. User selects one of the different subvention plans available and proceeds for the payment.

  5. Paytm backend server processes the transaction and returns the transaction response to the merchant's app.

  6. Merchant's backend server calls the Transaction Status API to verify the transaction response.

  7. After the successful validation of the transaction, order status is shown to the user on the app.

     Note: To learn about prerequisites, please refer to Prerequisite section.

Post Integration Steps

Post completion of integration on merchant's staging environment, do a complete transaction from order summary page on the mobile app.

  1. Attempt a test transaction using the test paymodes credentials.
  2. Re-verify transaction response with Transaction Status API via server to server call in payment flow and not separately as a one-time activity.
  3. See the transaction details in the "Test Data" mode on your dashboard.

Once the test transaction is complete, move the code to a live environment with production account details, which merchant would have received from Paytm.
 
In case of any issues with integration, please get in touch.