Paytm

Overview

Paytm is a payment method for payments performing in India by using e-wallets. Purchases are performed by using Payment Page and Gate, refunds—by using Gate.

General information

Payment method type Payments by using e-wallets
Countries and regions IN
Payment currencies INR
Currency conversion On ECommPay side
Purchases +
Payouts
Stored credentials payments
Full refunds +
Partial refunds +
Chargebacks
Notes
Onboarding and access fee Refer to your ECommPay key account manager

Interaction diagram

Payment processing by using the Paytm payment method requires merchant's web service, one of ECommPay interfaces, and the ECommPay payment platform, as well as Paytm service.

Operations support

  Interfaces Amounts, INR Times *
Payment Page CMS Plug-ins Gate Old Dashboard minimum maximum Basic Threshold
Purchases + + 1.00 9,999,999.99
Full refunds +
Partial refunds +
* The basic and threshold times are defined as follows:
  • The basic time is the average estimated time between the moment a payment is initiated in the payment platform to the moment the payment result is sent to the initiator. The basic time evaluation is made on the assumption of normal operation of all technical facilities and communication channels and typical customer behaviour (if any input from customer is required). Use the basic time to estimate when to react to the absence of payment result notifications or when to check payment status.
  • The threshold time is the maximum possible time between the moment a payment is initiated in the payment platform to the moment the initiator receives the callback with the payment result. A payment is automatically declined, if its waiting time exceeds the threshold time. For individual setting of the threshold time limit, contact ECommPay technical support.

Processing scenarios

To perform a purchase operation, you need to redirect a customer to the Paytm service, while to initiate a refund, you need to receive a request from a customer via your web service and then notify the customer about funds crediting.

Figure: Purchase by using Payment Page



Figure: Purchase by using Gate



Figure: Refund by using Gate



The sections that follow provide detailed information about what you need to perform payments and how you can analyse the information on payments and operations.

Purchase by using Payment Page

General information

In the Paytm method, to perform a purchase by using Payment Page, the merchant web service should send a request with all the required parameters and signature to the ECommPay URL and get the callback with the payment result from the payment platform. When opening Payment Page, you can have Payment Page opened with the Paytm method selected. For more information about preselecting payment methods, see in Preselecting payment methods.

The full sequence and particularities of the purchase process are provided below.



Figure: Purchase sequence by using Payment Page

  1. A customer initiates a purchase on the merchant's web service.
  2. The web service sends the request for Payment Page opening to the specified ECommPay URL.
  3. The request for opening is redirected to the payment platform.
  4. The payment platform performs the initial request processing that involves validation of the required parameters and signature.
  5. Requested Payment Page is generated into the ECommPay payment platform as specified in the project settings and the request parameters.
  6. Payment Page is displayed to the customer.
  7. The customer selects the Paytm method.
  8. The payment platform receives the purchase request for payment processing.
  9. The payment platform performs the internal purchase request processing and sends it to the Paytm service.
  10. The purchase request is processed on the Paytm service side.
  11. The service generates the data for redirecting the customer to its payment form and sends it to the payment platform.
  12. The payment platform sends the customer redirection data to Payment Page.
  13. The customer is redirected to the Paytm service.
  14. The customer completes all the payment steps required.
  15. The payment is processed on Paytm side.
  16. The result is displayed to the customer on the service.
  17. The customer is redirected to Payment Page.
  18. Paytm sends the result notification to the payment platform.
  19. The payment platform sends a callback with the payment result information to the web service.
  20. The payment platform sends the result information to Payment Page.
  21. A page with the payment result information is displayed to the customer on Payment Page.

The sections that follow discuss in more details the request format and the Payment Page parameters to use in the Paytm payment method and provide the information on the format of callbacks with payment results. For the general information on how to use the API, see Payment Page API Description.

Request format

There are several things you need to consider when requesting a payment through the Paytm method:

  1. You must provide values for the basic minimum of parameters. Listed below are the parameters that are mandatory for any payment method:
    • project_id—the project ID obtained from ECommPay
    • payment_id—payment ID unique within the project
    • payment_currency—payment currency in ISO-4217 alpha-3 format
    • payment_amount—payment amount in minor units
    • customer_id—customer ID unique within the project
  2. The currency of a payment can only be INR.
  3. If you need to have payment form displayed with the Paytm method selected, set the force_payment_method parameter to paytm-wallet.
  4. If required, you can also add any other additional parameters Payment Page supports. For information about all parameters available in the Paytm method, see Payment Page invocation parameters.
  5. After you specify all the parameters you need, you must create the signature for the request. For instructions on how to sign a payment request, see Signature generation and verification.

Thus, a correct payment request in the Paytm method must include project and payment IDs, the currency and the amount of the payment, and customer data, as shown in the following example:

EPayWidget.run(
    { project_id: 198, 
      payment_id: '3936',
      payment_amount: 2500, 
      payment_currency: 'INR',      
      customer_id: 'customer1'
      signature: "kUi2x9dKHAVNU0FYldJrxh4yo+52Kt8KU+Y1Y4HASCQ9vySODJr...=="
    }
)

Callback format

The Paytm method uses the standard format for callbacks to deliver purchase results. For more information, see Callbacks.

The following is the example of a callback with an information about successful 25.00 USD purchase from the customer in the 200 project.

Figure: Example of a successful purchase callback

   {
        "project_id": 200,
        "payment": {
            "id": "TEST_Ref1215267492448813313",
            "type": "purchase",
            "status": "success",
            "date": "2019-09-03T10:58:10+0000",
            "method": "paytm",
            "sum": {
                "amount": 2500,
                "currency": "INR"
            },
            "description": "TEST_Ref1215267492448813313"
        },
        "customer": {
            "id": "12345",    
            "phone": "31647812345"
        },
        "operation": {
            "id": 49572000001893,
            "type": "sale",
            "status": "success",
            "date": "2019-09-03T10:58:10+0000",
            "created_date": "2019-09-03T09:43:12+0000",
            "request_id": "d2debda97843c0c",
            "sum_initial": {
                "amount": 2500,
                "currency": "INR"
            },
            "sum_converted": {
                "amount": 2500,
                "currency": "INR"
            },
            "provider": {
                "id": 2469,
                "payment_id": "fcccab5d465e",
                "date": "2019-09-03T09:43:50+0000",
                "auth_code": ""
            },
            "code": "0",
            "message": "Success"
        },
        "signature": "KsbudtqaOTFGb+ZXwrbhzGeMTSuNsAX1+3YOdDt32jvfh9NDU/MiK94...=="
    }

The following is the example of a callback for a declined purchase.

Figure: Example of a declined purchase callback

 {
        "project_id": 200,
        "payment": {
            "id": "TEST_1567592437",
            "type": "purchase",
            "status": "decline",
            "date": "2019-09-06T07:41:03+0000",
            "method": "paytm",
            "sum": {
                "amount": 2500,
                "currency": "INR"
            },
            "description": "TEST_156759437"
        },
        "customer": {
            "id": "12345",
            "phone": "31647812345"
        },
        "operation": {
            "id": 48853000002113,
            "type": "sale",
            "status": "decline",
            "date": "2019-09-06T07:41:03+0000",
            "created_date": "2019-09-06T07:25:26+0000",
            "request_id": "60a7b84844677185e",
            "sum_initial": {
                "amount": 2500,
                "currency": "INR"
            },
            "sum_converted": {
                "amount": 2500,
                "currency": "INR"
            },
            "provider": {
                "id": 2469,
                "payment_id": ""
            },
            "code": "603",
            "message": "Auto decline"
        },
        "signature": "fsSFeOQTuMoMwRDptS21wQuWHUoxDWr/0Y2veJcIJBHpg7lIjl7...=="
    }

Related topics

The following topics might be useful when implementing payments through Payment Page:

Purchase by using Gate

General information

In the Paytm methods, when processing a purchase by using Gate, the merchant web service is required to do the following:

  1. Send a request with all the required parameters and signature to the ECommPay URL.
  2. Perform the redirection of a customer to the Paytm service.
  3. Get the callback with the payment result from the payment platform.

The following diagram provides the detailed picture of the payment processing procedure.



Figure: Purchase by using Gate

  1. A customer initiates a purchase through Paytm on the merchant's web service side.
  2. The web service sends the request for processing the purchase by using Gate to the specified ECommPay URL.
  3. The payment platform receives the request for processing the purchase from Gate.
  4. The payment platform performs the initial request processing that includes validation of the required parameters and signature.
  5. The payment platform sends the response with request receipt confirmation and correctness check result to the web service. For more information, see Response format.
  6. The payment platform performs the internal payment request processing and redirects the request to the Paytm service.
  7. The request is processed on the Paytm side.
  8. The Paytm service sends the data for redirecting the customer to the Paytm service to the payment platform.
  9. The payment platform sends the callback with the redirection data in the redirect_data object to the web service.
  10. The customer is redirected from the web service to the Paytm service.
  11. The customer completes all the payment steps required.
  12. The payment is processed on the Paytm side.
  13. The result is displayed to the customer.
  14. The customer is redirected to the merchant's web service.
  15. The Paytm service sends the payment result notification to the payment platform.
  16. The payment platform sends a callback to the web service.
  17. The customer receives the payment result on the web service.

The sections that follow discuss in more details the request format and the Gate parameters to use in the Paytm payment method and provide the information on the format of callbacks with purchase results.

Request format

There are several things you must consider when using purchase requests in the Paytm method:
  1. You perform refunds by sending the /v2/payment/wallet/paytm/sale request by using POST (HTTP) method. This is a request group for e-wallets payments: /v2/payment/wallet/{payment_method}/sale.
  2. The following objects and parameters must be specified in any request:
    • Object general—general purchase information:
      • project_id—project identifier
      • payment_id—unique purchase identifier
      • signature—signature created after you specify all the required parameters. For more information about signature generation, see Signature generation and verification
    • Object customer—customer information:
      • id—unique ID in the project
      • ip_address—IP address
    • Object payment—purchase information:
      • amount—purchase amount in the minor currency units
      • currency—purchase currency in the ISO-4217 alpha-3 format.
  3. The currency of a payment can only be INR.
  4. If required, you can also add any other additional parameters Gate supports.

Thus, a correct payment request in the Paytm method must include project and payment IDs, customer data, currency and amount of the purchase, as shown in the following example:

Figure: Example of a purchase request

{
    "general": {
        "project_id": 200,
        "payment_id": "payment_id",
        "signature": "PJkV8ej\/UG0Di8NN5e7cV+VHq3LwY3T\/pOMeSaRfBaNIip...=="
    },
    "customer": {
      "id": "12345",
      "ip_address": "1.1.1.1"
    },
    "payment": {
      "amount": 250,
      "currency": "INR"
    }
}

Formats of the customer redirection data

To redirect a customer from the web service to the Paytm site, you must receive a callback from the payment platform containing the URL for redirection in the redirect_data.url parameter and data to be sent in the request body in the redirect_data.body parameter, and use these parameters when opening the HTML page using the method specified in the redirect_data.method parameter.

The following is the callback fragment containing the redirection data.

 "redirect_data": {
                    "body": [],
                    "method": "GET",
                    "url": "https://pay.com/collect/pay/M-ce2f-11e9-9f3e-9f869464802f?xtid=CATH-ST"
                }

Callback format

The Paytm method uses the standard format for callbacks to deliver purchase results. For more information, see Callbacks.

The following is the example of a callback with an information about successful 20.00 INR purchase from the customer in the 200 project.

Figure: Example of a successful purchase callback

   {
        "project_id": 200,
        "payment": {
            "id": "TEST_Ref1215267492448813313",
            "type": "purchase",
            "status": "success",
            "date": "2019-09-03T10:58:10+0000",
            "method": "paytm",
            "sum": {
                "amount": 2500,
                "currency": "INR"
            },
            "description": "TEST_Ref1215267492448813313"
        },
        "customer": {
            "id": "12345",    
            "phone": "31647812345"
        },
        "operation": {
            "id": 49572000001893,
            "type": "sale",
            "status": "success",
            "date": "2019-09-03T10:58:10+0000",
            "created_date": "2019-09-03T09:43:12+0000",
            "request_id": "d2debda97843c0c",
            "sum_initial": {
                "amount": 2500,
                "currency": "INR"
            },
            "sum_converted": {
                "amount": 2500,
                "currency": "INR"
            },
            "provider": {
                "id": 2469,
                "payment_id": "fcccab5d465e",
                "date": "2019-09-03T09:43:50+0000",
                "auth_code": ""
            },
            "code": "0",
            "message": "Success"
        },
        "signature": "KsbudtqaOTFGb+ZXwrbhzGeMTSuNsAX1+3YOdDt32jvfh9NDU/MiK94...=="
    }

The following is the example of a callback for a declined purchase.

Figure: Example of a declined purchase callback

 {
        "project_id": 200,
        "payment": {
            "id": "TEST_1567592437",
            "type": "purchase",
            "status": "decline",
            "date": "2019-09-06T07:41:03+0000",
            "method": "paytm",
            "sum": {
                "amount": 2500,
                "currency": "INR"
            },
            "description": "TEST_156759437"
        },
        "customer": {
            "id": "12345",
            "phone": "31647812345"
        },
        "operation": {
            "id": 48853000002113,
            "type": "sale",
            "status": "decline",
            "date": "2019-09-06T07:41:03+0000",
            "created_date": "2019-09-06T07:25:26+0000",
            "request_id": "60a7b84844677185e",
            "sum_initial": {
                "amount": 2500,
                "currency": "INR"
            },
            "sum_converted": {
                "amount": 2500,
                "currency": "INR"
            },
            "provider": {
                "id": 2469,
                "payment_id": ""
            },
            "code": "603",
            "message": "Auto decline"
        },
        "signature": "fsSFeOQTuMoMwRDptS21wQuWHUoxDWr/0Y2veJcIJBHpg7lIjl7...=="
    }

Related topics

The following topics might be useful when implementing payments through Gate:

Refunds by using Gate

General information

Paytm supports full and partial refunds processing by using Gate: merchant's web service sends a request with all the required parameters and signature to ECommPay URL, and receives a callback with the payment result. The full sequence of the refund process is provided below.



Figure: Refund sequence by using Gate

  1. A customer orders a refund by using merchant's web service.
  2. Merchant's web service sends the refund request for processing the purchase by using Gate to the appropriate ECommPay URL.
  3. Gate redirects the request to the ECommPay payment platform.
  4. The payment platform performs all the necessary check and processes the request.
  5. The reply with the request processing results is sent to the merchant's web service. For more information, see Response format.
  6. The payment platform redirects the refund request to the Paytm service.
  7. The refund is processed on Paytm side.
  8. Paytm sends the result notification to the payment platform.
  9. The payment platform sends a callback with the payment result to the web service.
  10. The customer receives the information about the receipt of the requested funds from the web service.

The sections that follow discuss in more details the request format and the Gate parameters to use in the Paytm payment method and provide the information on the format of callbacks with refund results.

Request format

There are several things you must consider when using refund requests in the Paytm method:
  1. You perform refunds by sending the /v2/payment/wallet/paytm/refund request by using POST (HTTP) method. This is a request group for e-wallets payments: /v2/payment/wallet/{payment_method}/refund.
  2. The following objects and parameters must be specified in any request:
    • Object general—general payment information:
      • project_id—project identifier
      • payment_id—unique payment identifier
      • signature—signature created after you specify all the required parameters. For more information about signature generation, see Signature generation and verification
    • Object payment—refund information:
      • description—comment or description
      • amount—refund amount in minor units of the currency (mandatory for partial refund only)
      • currency—refund currency in ISO-4217 alpha-3 format (mandatory for partial refund only)
  3. If required, you can also add any other additional parameters Gate supports.

Thus, a correct refund request in the Paytm method must include project and payment IDs, description of the refund, as shown in the following example:

Figure: Example of a refund request

{
  "general": {
    "project_id": 200,
    "payment_id": "TEST_1572258898441234343232",
    "signature": "NUpXRpdrU/rRcwEa/jQYoYbXA/YIc/dgeuncPmD/BJZGZvt59GbTSAUKHI/WrQ=="
  },
  "payment": {
    "description":"test_refund"
  }

Callback format

The Paytm method uses the standard format for callbacks to deliver refund results. For more information, see Callbacks.

Here is an example of callback with an information about successful 350.00 INR refund for the customer account in the 200 project.

Figure: Example of a successful refund callback

{
        "project_id": 200,
        "payment": {
            "id": "TEST_554862",
            "type": "purchase",
            "status": "refunded",
            "date": "2020-09-09T10:02:18+0000",
            "method": "paytm",
            "sum": {
                "amount": 35000,
                "currency": "INR"
            },
            "merchant_refund_id": "TEST_554862",
            "description": "TEST_554862"
        },
        "customer": {
            "id": "123456",
            "phone": "1234567890"
        },
        "operation": {
            "id": 90266010010271,
            "type": "refund",
            "status": "success",
            "date": "2020-09-09T10:02:18+0000",
            "created_date": "2020-09-09T09:46:14+0000",
            "request_id": "6b77b588d77d5c27be31be7b72bf9adf...b1c85eda238b73cac-00090267",
            "sum_initial": {
                "amount": 35000,
                "currency": "INR"
            },
            "sum_converted": {
                "amount": 35000,
                "currency": "INR"
            },
            "code": "0",
            "message": "Success",
            "provider": {
                "id": 2469,
                "payment_id": "4952688",
                "auth_code": ""
            }
        },
        "signature": "WUZUy26FHZglsro9PYFr89suJAciQ...5Fev4NtHl56VGTgX9m/g=="
    }

Here is an example of callback for a refund declined due to the refund amount is greater than amount of the initial payment.

Figure: Example of a declined refund callback

{
        "project_id": 200,
        "payment": {
            "id": "TEST_554863",
            "type": "purchase",
            "status": "success",
            "date": "2020-09-09T10:02:18+0000",
            "method": "paytm",
            "sum": {
                "amount": 35000,
                "currency": "INR"
            },
            "merchant_refund_id": "TEST_554863",
            "description": "TEST_554863"
        },
        "customer": {
            "id": "12345",
            "phone": "1234567890"
        },
        "operation": {
            "id": 90266010010272,
            "type": "refund",
            "status": "decline",
            "date": "2020-09-09T10:02:18+0000",
            "created_date": "2020-09-09T09:46:14+0000",
            "request_id": "6b77b588d77d5c27be31be7b72bf9adf...b1c85eda238b73cac-00090268",
            "sum_initial": {
                "amount": 35000,
                "currency": "INR"
            },
            "sum_converted": {
                "amount": 35000,
                "currency": "INR"
            },
            "code": "3283",
            "message": "Refund amount more than init amount"
            }
        },
        "signature": "WUZUy26FHZglsro9PYFr89suJAciQ...5Fev4NtHl56VGTgX9m/g=="
    }

Related topics

The following topics might be useful when implementing payments through Gate:

Analysis of payments results

As with other payment methods ECommPay offers, when using the Paytm method, you have several options to analyse the information about payments and operations performed by using the method—alone or in conjunction with other methods.

You can load and analyse all the necessary information in Dashboard (Old Dashboard), for instance you can use the analytic panels on the Analytics tab to this end.

Also, you can export the information for further analysis by using third party analytical tools. The following options are available:

  • Dashboard (Old Dashboard) allows you to download reports in CSV and XLS formats—by using the tools on the Payments tab. You can perform export as a one-time download to your local computer or have payment data regularly exported and delivered to email addresses you specify.
  • Data API allows you to have payment information exported in JSON format and delivered to a URL you specify. The payment information is exported by using the /operations/get queries.

If you have any further questions regarding payment data analysis, contact ECommPay technical support.