If you are using Android Components v5.0.0 or later:
This payment method requires no additional configuration.
Follow the Components integration guide and use the following module and Component names:
- To import the module: instant
- To launch and show the Component: InstantPaymentComponent
You do not need to collect any information from your shopper in your payments form. If you have an existing Android Components integration, you can use our Redirect Component to redirect the shopper to Paytm to complete the payment.
When making a Paytm payment, you need to:
Requirements
Requirement | Description |
---|---|
Integration type | Make sure that you have built an Advanced flow Android Components integration. |
Setup steps | Before you begin, add in your Customer Area. |
Show Paytm in your payment form
Include Paytm in the list of available payment methods. You do not need to collect any information from the shopper in your payment form.
- Specify in your /paymentMethods request:
- countryCode: IN
- amount.currency: INR
The response contains paymentMethod.type
: paytm.
We provide logos for Paytm which you can use on your payment form. For more information, refer to Downloading logos.
Make a payment
When the shopper proceeds to pay, you need to:
-
From your server, make a /payments request, specifying:
paymentMethod.type
: Set this to paytm.returnURL
: URL to where the shopper should be redirected back to after they complete the payment. Get this URL from the Component in theRedirectComponent.getReturnUrl(context)
.shopperReference
(optional) : Your unique identifier for the shopper.For improved conversion rates, we recommend that you pass the
shopperReference
.
In the /payments response, note the `action` object. This contains the information needed to redirect the shopper.
-
Pass the
action
object to your client app. You need this to initialize the Redirect Component.
Handle the redirect
-
Use the Redirect Component to redirect the shopper to Paytm.
-
After the shopper returns to your app, make a POST /payments/details request from your server, providing:
details
: TheactionComponentData.details
object from the Redirect Component.
You receive a response containing:
resultCode
: Use this to present the payment result to your shopper.pspReference
: Our unique identifier for the transaction.
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 ask them to 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 or Received |
The shopper has completed the payment but the final result is not yet known. | Inform the shopper that you have received their order, and are waiting for the payment to be completed. You will receive the final result of the payment in an AUTHORISATION webhook. |
If the shopper failed to return to your website or app, wait for webhooks to know the outcome of the payment:
eventCode | success field | Description | Action to take |
---|---|---|---|
AUTHORISATION | false | The transaction failed. | Cancel the order and inform the shopper that the payment failed. |
AUTHORISATION | true | The shopper successfully completed the payment. | Inform the shopper that the payment has been successful and proceed with the order. |
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.