Search

Are you looking for test card numbers?

Would you like to contact support?

Payment-method icon

Paytm for API only

Add Paytm to an existing API-only integration.

Accept Paytm payments using our APIs, and build your own payment form to have full control over the look and feel of your checkout page.

Before you begin

These instructions explain how to add Paytm to your existing API-only integration. The API-only integration works the same way for all payment methods. If you haven't done this integration yet, refer to our API-only integration guide.

Before starting your Paytm integration:

  1. Make sure that you have set up your back end implementation.
  2. Add Paytm in your test Customer Area.

Build your payment form for Paytm

Include Paytm in the list of available payment methods. You don't need to collect any information from the shopper in your payment form.

We provide logos for Paytm which you can use on your payment form. For more information, refer to Downloading logos.

If you are using the /paymentMethods to show available payment methods to the shopper, specify the following:

The response contains paymentMethod.type: paytm.

Make a payment

In your /payments request, specify:

  • paymentMethod.type: paytm
  • returnUrl: The URL to where the shopper should be taken back to after a redirection.
  • shopperReference(optional) : Your unique identifier for the shopper.

    For improved conversion rates, we recommend that you pass the shopperReference.

curl https://checkout-test.adyen.com/v51/payments \
-H "x-API-key: YOUR_X-API-KEY" \
-H "content-type: application/json" \
-d '{
  "merchantAccount":"YOUR_MERCHANT_ACCOUNT",
  "reference":"YOUR_ORDER_NUMBER",
  "amount":{
    "currency":"INR",
    "value":1000
  },
  "paymentMethod":{
    "type":"paytm"
  },
  "returnUrl":"https://your-company.com/checkout?shopperOrder=12xy.."
}'
# Set your X-API-KEY with the API key from the Customer Area.
adyen = Adyen::Client.new
adyen.api_key = "YOUR_X-API-KEY"
 
response = adyen.checkout.payments({
  :amount => {
    :currency => "INR",
    :value => 1000
  },
  :reference => "YOUR_ORDER_NUMBER",
  :paymentMethod => {
    :type => "paytm"
  },
  :returnUrl => "https://your-company.com/checkout?shopperOrder=12xy..",
  :merchantAccount => "YOUR_MERCHANT_ACCOUNT"
})
// Set YOUR_X-API-KEY with the API key from the Customer Area.
// Change to Environment.LIVE and add the Live URL prefix when you're ready to accept live payments.
    Client client = new Client("YOUR_X-API-KEY", Environment.TEST);
    Checkout checkout = new Checkout(client);

    PaymentsRequest paymentsRequest = new PaymentsRequest();

    String merchantAccount = "YOUR_MERCHANT_ACCOUNT";
    paymentsRequest.setMerchantAccount(merchantAccount);

    Amount amount = new Amount();
    amount.setCurrency("INR");
    amount.setValue(15000L);
    paymentsRequest.setAmount(amount);

    DefaultPaymentMethodDetails paymentMethodDetails = new DefaultPaymentMethodDetails();
    paymentMethodDetails.setType("paytm");
    paymentsRequest.setPaymentMethod(paymentMethodDetails);

    paymentsRequest.setReference("YOUR_ORDER_NUMBER");
    paymentsRequest.setReturnUrl("https://your-company.com/checkout?shopperOrder=12xy..");

    PaymentsResponse paymentsResponse = checkout.payments(paymentsRequest);
// Set your X-API-KEY with the API key from the Customer Area.
$client = new \Adyen\Client();
$client->setXApiKey("YOUR_X-API-KEY");
$service = new \Adyen\Service\Checkout($client);

$params = array(
  "amount" => array(
    "currency" => "INR",
    "value" => 1000
  ),
  "reference" => "YOUR_ORDER_NUMBER",
  "paymentMethod" => array(
    "type" => "paytm"
  ),
  "returnUrl" => "https://your-company.com/checkout?shopperOrder=12xy..",
  "merchantAccount" => "YOUR_MERCHANT_ACCOUNT"
);
$result = $service->payments($params);
#Set your X-API-KEY with the API key from the Customer Area.
adyen = Adyen.Adyen()
adyen.client.xapikey = 'YOUR_X-API-KEY'

result = adyen.checkout.payments({
   'amount': {
      'value': 1000,
      'currency': 'INR'
   },
   'reference': 'YOUR_ORDER_NUMBER',
   'paymentMethod': {
      'type': 'paytm'
   },
   'returnUrl': 'https://your-company.com/checkout?shopperOrder=12xy..',
   'merchantAccount': 'YOUR_MERCHANT_ACCOUNT'
})
// Set your X-API-KEY with the API key from the Customer Area.
var client = new Client ("YOUR_X-API-KEY", Environment.Test);
var checkout = new Checkout(client);

var amount = new Model.Checkout.Amount("INR", 1000);
var details = new Model.Checkout.DefaultPaymentMethodDetails{
  Type = "paytm"
};
var paymentsRequest = new Model.Checkout.PaymentRequest
{
  Reference = "YOUR_ORDER_NUMBER",
  Amount = amount,
  ReturnUrl = @"https://your-company.com/checkout?shopperOrder=12xy..",
  MerchantAccount = "YOUR_MERCHANT_ACCOUNT",
  PaymentMethod = details
};

var paymentResponse = checkout.Payments(paymentsRequest);
// Set your X-API-KEY with the API key from the Customer Area.
const {Client, Config, CheckoutAPI} = require('@adyen/api-library');
const config = new Config();
// Set your X-API-KEY with the API key from the Customer Area.
config.apiKey = '[API_KEY]';
config.merchantAccount = '[YOUR_MERCHANT_ACCOUNT]';
const client = new Client({ config });
client.setEnvironment("TEST");
const checkout = new CheckoutAPI(client);
checkout.payments({
    amount: { currency: "INR", value: 1000 },
    paymentMethod: {
        type: 'paytm'
    },
    reference: "YOUR_ORDER_NUMBER",
    merchantAccount: config.merchantAccount,
    returnUrl: "https://your-company.com/checkout?shopperOrder=12xy.."
}).then(res => res);

The /payments response contains:

  • resultCode: RedirectShopper
  • details: Array that contains the key parameter name and the corresponding data type that you should expect when the shopper is redirected to your returnURL. You need to submit this value in your /payments/details request when handling the redirect.
  • action: Object containing information about the redirect.
  • action.paymentData: Value that you need to submit in your /payments/details request when handling the redirect.
  • action.url: Link to where you should redirect your shopper.
  • action.method: GET or POST. The HTTP request method that you should use. After the shopper completes the payment, they will be redirected back to your returnURL using the same method.
    The redirect method depends on your payment method configuration and the length of the data included in the request, so make sure that your integration can handle both HTTP GET and HTTP POST methods.

{
   "resultCode":"RedirectShopper",
   "action":{
      "method":"GET",
      "paymentData":"Ab02b4c0!BQABAgCSZT7t...",
      "paymentMethodType":"",
      "type":"redirect",
      "url":"https://test.adyen.com/hpp/skipDetails.shtml?brandCode=paytm..."
   },
   "details":[
      {
         "key":"payload",
         "type":"text"
      }
   ],
   ...
}

Handle the redirect

To complete a Paytm payment, you need to redirect the shopper to Paytm. After the shopper is redirected back to your website or app, make a /payments/details request to check the payment result.

For more information and detailed instructions, refer to Handling redirects.

Present the payment result

Use the resultCode that you received the /payments/details response to present the payment result to your shopper.

The resultCode values you can receive for Paytm are:

resultCode Description Action to take
Authorised The payment was successful. Inform the shopper that the payment has been successful.
Cancelled The shopper cancelled the payment while on their bank's website. Ask the shopper whether they want to continue with the order, or request that they select a different payment method.
Refused The payment was refused by the shopper's bank. Ask the shopper to try the payment again using a different payment method.
Pending
Received
The shopper has completed the payment but the final result is not yet known. Inform the shopper that you've received their order, and are waiting for the payment to be completed.
You will receive the final result of the payment in an AUTHORISATION notification.
If a shopper completed the payment but failed to return to your website or app, you will receive the outcome of the payment in an AUTHORISATION notification.

Test and go live

Before you go live, test your integration using the following credentials:

Mobile number OTP Password
7777777777 489871 Paytm12345

Check the status of Paytm test payments in your Customer Area > Transactions > Payments.

Before you can accept live Paytm payments, you need to submit a request for Paytm in your live Customer Area.

See also