search
Your Paytm for business app is working and will keep working beyond March 15th, 2024. Click to know more

Transaction Status via Webhook

Use Case

 

AI Router sends a server-to-server (S2S) response in key-value pairs on the webhook configured and on callback URL. Payment Success Webhook response is sent for the final transaction status i.e. success or failed. This webhook for payment status can be configured from merchant dashboard.

 

Body

Attributes Description Type
ORDERID OrderId passed in the request
Example: OREDRID_98765
String
MID Merchant ID passed in the request
Example: YOUR_MID_HERE
String
TXNID Unique reference number generated at AI router side for each transaction
Example: 202005081112128XXXXXX68470101509706
String
TXNAMOUNT Payment transaction Amount
Example: 1.00
String
CURRENCY Payment currency type
Example: INR
String
PAYMENTMODE Payment Mode used in payment
Example: PPI
String
TXNDATE Transaction Date
Example: 7/24/2020 15:13:02
String
STATUS This parameter indicates the status of an API call.
Example: TXN_SUCCESS
String
RESPCODE This is the resultCode corresponding to a particular message and is returned to the merchant. Its maximum length is 64. For a list of different RESPCODE and RESPMSG please refer to the PDF.
Example: 01
String
RESPMSG This parameter is the result message which contains information about the result.
Example: Txn Success
String
GATEWAYNAME  Name of the gateway used to process the transaction, this is the payment aggregator chosen to process the transaction.
Example: PAYTM, BILLDESK
String
GATEWAYINFO Response provided by the gateway during payment or transaction.  String
BANKTXNID Unique reference number generated at the bank side for each transaction
Example: 62909899
String
BANKNAME Bank Name used in payment
Example: WALLET
String
CHECKSUMHASH AI router validates the request and ensures that parameters are not tempered by verifying the signature in the request. For creating the checksum (signature) refer to the steps given in Checksum Logic. String
GATEWAYRESULTINFOCODE Result code from payment gateways / aggregators String
GATEWAYRESULTINFOMSG Result message from payment gateways / aggregators String

 

Sample Response

Success

{
"GATEWAYNAME":"Paytm",
"PAYMENTMODE":"NB",
"TXNDATE":"2022-05-22",
"TXNDATETIME":"2022-05-22 22:17:46.0",
"CUSTID":"0007804105",
"STATUS":"TXN_SUCCESS",
"MID":"YOUR_MID_HERE",
"ORDERID":"REN2205223CJHVBQCRNG",
"CURRENCY":"INR",
"TXNID":"20220522XXXX12809100168156603280537",
"TXNAMOUNT":"11451.90",
"BANKTXNID":"20220522111212800100168934054879098",
"BANKNAME":"State Bank of India",
"RESPMSG":"Txn Success",
"RESPCODE":"01",
"MERC_UNQ_REF":"",
"CHECKSUMHASH":"Vt1V3/qLkJ6lwfbHbTPfMLdW/M4Muyw2netnjTnqxYqz/kLqSbjb6tccUGVr8tVzpjpNUF5BohBPwchec6I+KOcByre1t0L5jiEGW6vNvI8=",
"RRN":"IGANPYQPO8",
"GATEWAYINFO":"{\"TXNID\":\"20220522111212800100168934054879098\",\"BANKTXNID\":\"IGANPYQPO8\",\"ORDERID\":\"REN2205223CJHVBQCRNG\",\"TXNAMOUNT\":\"11451.90\",\"STATUS\":\"TXN_SUCCESS\",\"TXNTYPE\":\"SALE\",\"GATEWAYNAME\":\"SBI\",\"RESPCODE\":\"01\",\"RESPMSG\":\"Txn Success\",\"BANKNAME\":\"SBI\",\"MID\":\"MERCH64129621595501\",\"PAYMENTMODE\":\"NB\",\"REFUNDAMT\":\"0.00\",\"TXNDATE\":\"2022-05-22 22:18:46.0\",\"UDF_1\":\"20220522325548145315\"}"
}

Failure

{
"GATEWAYNAME":"Paytm",
"PAYMENTMODE":"NB",
"TXNDATE":"2022-05-24",
"TXNDATETIME":"2022-05-24 22:51:47.0",
"CUSTID":"",
"STATUS":"TXN_FAILURE",
"MID":"YOUR_MID_HERE",
"ORDERID":"REN240522WTK0QFAS2M7",
"CURRENCY":"INR",
"TXNID":"20220524XXXX12809100168274403277312",
"TXNAMOUNT":"11082.06",
"BANKTXNID":"20220524111212800100168477054924419",
"BANKNAME":"Axis Bank",
"RESPMSG":"Your payment has been declined by your bank. Please try again or use a different method to complete the payment.",
"RESPCODE":"227",
"MERC_UNQ_REF":"",
"CHECKSUMHASH":"p/CE3ZyQqFk0XypY24G/JRONcf2U0IlXtGx9a1zeHDLLLLk+cro5vb3WIWpcdMvdJ10pNSWDJnQiedt1BBjArG0Sc79SSD6ncvcx7HEIcMo=",
"AUTHCODE":"",
"RRN":"",
"GATEWAYINFO":"{\"TXNID\":\"20220524111212800100168477054924419\",\"BANKTXNID\":\"\",\"ORDERID\":\"REN240522WTK0QFAS2M7\",\"TXNAMOUNT\":\"11082.06\",\"STATUS\":\"TXN_FAILURE\",\"TXNTYPE\":\"SALE\",\"GATEWAYNAME\":\"AXIS\",\"RESPCODE\":\"227\",\"RESPMSG\":\"Looks like you have abandoned the payment. Please try again\",\"BANKNAME\":\"AXIS\",\"MID\":\"MERCH64129621595501\",\"PAYMENTMODE\":\"NB\",\"REFUNDAMT\":\"0.0\",\"TXNDATE\":\"2022-05-24 22:51:54.0\",\"UDF_1\":\"20220524326341974827\"}"
}

 

Success

{
"GATEWAYNAME":"Paytm",
"PAYMENTMODE":"WALLET",
"TXNDATE":"2022-05-22",
"TXNDATETIME":"2022-05-22 21:50:49.0",
"CUSTID":"5014502246",
"STATUS":"TXN_SUCCESS",
"MID":"YOUR_MID_HERE",
"ORDERID":"REN220522D1PGED5FRDL",
"CURRENCY":"INR",
"TXNID":"2022052211121XXXX100168889003269573",
"TXNAMOUNT":"732.11",
"BANKTXNID":"20220522111212800110168348052276833",
"BANKNAME":"WALLET",
"RESPMSG":"Txn Success",
"RESPCODE":"01",
"MERC_UNQ_REF":"",
"CHECKSUMHASH":"ZEeB1Bd+BeUAJlxS+qvDkhAMptbbgzq+DiX1Led40v7om5tfUXVbIPjTsCcCra4MnBFzpK9ja4FhGJ9UkMzs2w0+me5DbAYnPxflow7ucQM=",
"GATEWAYINFO":"{\"TXNID\":\"20220522111212800110168348052276833\",\"BANKTXNID\":\"187665102590\",\"ORDERID\":\"REN220522D1PGED5FRDL\",\"TXNAMOUNT\":\"732.11\",\"STATUS\":\"TXN_SUCCESS\",\"TXNTYPE\":\"SALE\",\"GATEWAYNAME\":\"WALLET\",\"RESPCODE\":\"01\",\"RESPMSG\":\"Txn Success\",\"BANKNAME\":\"WALLET\",\"MID\":\"MERCH64129621595501\",\"PAYMENTMODE\":\"PPI\",\"REFUNDAMT\":\"0.00\",\"TXNDATE\":\"2022-05-22 21:50:59.0\"}"
}

Failure

{
"GATEWAYNAME":"Paytm",
"PAYMENTMODE":"WALLET",
"TXNDATE":"2022-05-24",
"TXNDATETIME":"2022-05-24 16:56:12.0",
"CUSTID":"",
"STATUS":"TXN_FAILURE",
"MID":"YOUR_MID_HERE",
"ORDERID":"REN240522PYI541URZ98",
"CURRENCY":"INR",
"TXNID":"20220524111XXXX09100168544703225715",
"TXNAMOUNT":"1225.31",
"BANKTXNID":"20220524111212800110168681452807648",
"BANKNAME":"WALLET",
"RESPMSG":"Your payment has been declined by your bank. Please try again or use a different method to complete the payment.",
"RESPCODE":"227",
"MERC_UNQ_REF":"",
"CHECKSUMHASH":"wxzBzv5ySCLdbSquxslp5eCjlq5yKiV/lXIVO/1uA+lgUjhYSGd3j0Fefsi8RhlQB/GyxJqFSK+sG8mIZ+CzSi/V3SbfARHqQvVkYHl5LOg=",
"GATEWAYINFO":"{\"TXNID\":\"20220524111212800110168681452807648\",\"BANKTXNID\":\"\",\"ORDERID\":\"REN240522PYI541URZ98\",\"TXNAMOUNT\":\"1225.31\",\"STATUS\":\"TXN_FAILURE\",\"TXNTYPE\":\"SALE\",\"RESPCODE\":\"810\",\"RESPMSG\":\"ORDER IS CLOSE.\",\"MID\":\"MERCH64129621595501\",\"REFUNDAMT\":\"0.0\",\"TXNDATE\":\"2022-05-24 16:59:26.0\"}"
}

 

Success

{
"cardScheme":"VISA",
"GATEWAYNAME":"Paytm",
"PAYMENTMODE":"CC",
"TXNDATE":"2022-05-22",
"TXNDATETIME":"2022-05-22 21:52:56.0",
"CUSTID":"5012585991",
"STATUS":"TXN_SUCCESS",
"MID":"YOUR_MID_HERE",
"ORDERID":"REN2205225UVL0YWUMAG",
"CURRENCY":"INR",
"TXNID":"2022052211121XXXX100168401903217727",
"TXNAMOUNT":"35282.68",
"BANKTXNID":"20220522111212800100168826855084701",
"BANKNAME":"HDFC Bank",
"RESPMSG":"Txn Success",
"RESPCODE":"01",
"MERC_UNQ_REF":"",
"CHECKSUMHASH":"q8YSR5mAATwQ6qJlhHwWqgrFUUr9PcDRDnzqZZtCwexGic6W7v2Mxkz32Zw9Ghl9U7T5TRuenG0FA2twC+IfX0n7aZU3VsxOvkwtgVUztd0=",
"RRN":"73895632958",
"BIN":"489377",
"LASTFOURDIGITS":"0028",
"GATEWAYINFO":"{\"TXNID\":\"20220522111212800100168826855084701\",\"BANKTXNID\":\"73895632958\",\"ORDERID\":\"REN2205225UVL0YWUMAG\",\"TXNAMOUNT\":\"35282.68\",\"STATUS\":\"TXN_SUCCESS\",\"TXNTYPE\":\"SALE\",\"GATEWAYNAME\":\"ICICIPAY\",\"RESPCODE\":\"01\",\"RESPMSG\":\"Txn Success\",\"BANKNAME\":\"HDFC Bank\",\"MID\":\"MERCH64129621595501\",\"PAYMENTMODE\":\"CC\",\"REFUNDAMT\":\"0.00\",\"TXNDATE\":\"2022-05-22 21:52:56.0\",\"UDF_1\":\"20220522338713968440\",\"BIN\":\"489377\",\"LASTFOURDIGITS\":\"0028\"}"
}

Failure

Payload: {
"head": {
"sourceService": "AOA_NOTIFICATION_SERVICE",
"requestCreationTime": "2023-06-27T04:30:41.709671Z",
"requestUniqueId": "f2234448-5ddc-4780-a856-c8f7edc7f835",
"businessFlowKey": "AOA_NOTIFICATION_SERVICE_PAYMENT_PEON",
"shadowRequest": false
},
"body": {
"requeCount": 0,
"peonServiceName": "AoAPeonSentServiceImpl",
"extendInfoMap": null,
"dataType": null,
"PaytmTxnId": "20230627010550000880391189105967104",
"peonUrl":
"https://b7k3a67cv6.execute-api.ap-south-1.amazonaws.com/prod/payments/api/s2s/v1/transaction/handl
estatuswebhook",
"data": {
"cardScheme": "AMEX",
"clientId": null,
"GATEWAYNAME": "Billdesk",
"PAYMENTMODE": "CC",
"TXNDATE": "2023-06-27",
"TXNDATETIME": "2023-06-27 10:00:16.0",
"CUSTID": "0003468555",
"STATUS": "TXN_FAILURE",
"MID": "YOUR_MID_HERE",
"ORDERID": "REN270623WSPVY92ETM26K",
"CURRENCY": "INR",
"TXNID": "20230627010550000880391189105967104",
"TXNAMOUNT": "11092.00",
"BANKTXNID": "XAM81228592322",
"BANKNAME": "IndusInd Bank",
"RESPMSG": "Your payment has been declined by your bank. Please try again or use a different
method to complete the payment.",
"RESPCODE": "227",
"MERC_UNQ_REF": "PAY_NOW_889397162",
"CHECKSUMHASH":
"F/4LRZ0iNlYmzu2JT/yRimrvIFXPkGZpC7tGKDAPmes5RlMnYdQFUUX5q3I1Z+JDyLg4bRL/X4pMPFk0
h3CEPyMd6f805hJfZOI2j0ARo0Q=",
"RRN": "",
"PGTXNID": "XAM81228592322",
"SUBS_ID": null,
"BIN": "377151",
"LASTFOURDIGITS": "0456",
"PAYMENT_OFFER_DETAILS": "null",
"PROMO_CAMP_ID": null,
"PROMO_RESPCODE": null,
"PROMO_STATUS": null,
"cardIndexNo": null,
"MASKED_CARD_NUMBER": null,
"ENC_DATA": null,
"CHILDTXNLIST": null,
"TXNTYPE": null,
"REFUNDAMT": null,
"Masked_customer_mobile_number": null,
"POS_ID": null,
"uniqueReferenceLabel": null,
"uniqueReferenceValue": null,
"pccCode": null,
"PRN": null,
"udf_1": null,
"udf_2": null,
"udf_3": null,
"comments": null,
"AUTHCODE": null,
"LOYALTYPOINTS": null,
"VPA": "",
"ACCNUMVERSUCCESS": null,
"GATEWAYINFO":
"{\"TXNID\":\"XAM81228592322\",\"BANKTXNID\":\"720056145\",\"ORDERID\":\"REN270623WSPVY92E
TM26K\",\"TXNAMOUNT\":\"11092.00\",\"STATUS\":\"Payment processing
error\",\"GATEWAYNAME\":\"AM8\",\"RESPCODE\":\"TRPPE0033\",\"RESPMSG\":\"payment_processing
_error\",\"MID\":\"MAXLIFEWR2\",\"PAYMENTMODE\":\"card\",\"TXNDATE\":\"2023-06-27T10:00:16+05:3
0\",\"OBJECTID\":\"transaction\",\"ADDITIONALINFO\":{\"additional_info1\":\"880391189244379136\",\"ad
ditional_info2\":\"PAY_NOW_889397162\",\"additional_info3\":\"NA\",\"additional_info4\":\"NA\",\"additional
_info5\":\"NA\",\"additional_info6\":\"NA\",\"additional_info7\":\"NA\",\"additional_info8\":\"NA\",\"additional_i
nfo9\":\"NA\",\"additional_info10\":\"NA\"},\"TXNPROCESSTYPE\":\"3ds\",\"BANKID\":\"AM8\",\"AUTHSTA
TUS\":\"0399\",\"ECI\":\"05\"}",
"GATEWAYRESULTINFOCODE": "TRPPE0033",
"GATEWAYRESULTINFOMSG": "Payment processing error"
},
"headers": {
"content-type": "application/x-www-form-urlencoded"
}
}
}sentforpushingtokafkatopic: AOA_PEON_NOTIFY

 

Success

{
"cardScheme":"VISA",
"GATEWAYNAME":"Paytm",
"PAYMENTMODE":"DC",
"TXNDATE":"2022-05-25",
"TXNDATETIME":"2022-05-25 09:00:58.0",
"CUSTID":"1230667",
"STATUS":"TXN_SUCCESS",
"MID":"Your_MID_HERE",
"ORDERID":"REN250522DVQSMV1R5QF",
"CURRENCY":"INR",
"TXNID":"20220525XXXX12809100168297603307452",
"TXNAMOUNT":"18155.00",
"BANKTXNID":"20220525111212800100168939455342951",
"BANKNAME":"HDFC Bank",
"RESPMSG":"Txn Success",
"RESPCODE":"01",
"MERC_UNQ_REF":"",
"CHECKSUMHASH":"1Wgan9O0ZXckNAGXZ+I25lqcfNk+iD8hsAt4N6bVJpLKcHybEKwhBzYT2LweM0cY0kgEVpqzilk9E2PBXagmZhojT4wCM7H75xK0U1kKEN4=",
"BIN":"416021",
"LASTFOURDIGITS":"1719",
"GATEWAYINFO":"{\"TXNID\":\"20220525111212800100168939455342951\",\"BANKTXNID\":\"\",\"ORDERID\":\"REN250522DVQSMV1R5QF\",\"TXNAMOUNT\":\"18155.00\",\"STATUS\":\"TXN_SUCCESS\",\"TXNTYPE\":\"SALE\",\"GATEWAYNAME\":\"HDFCPAY\",\"RESPCODE\":\"01\",\"RESPMSG\":\"Txn Success\",\"BANKNAME\":\"HDFC Bank\",\"MID\":\"MERCH64129621595501\",\"PAYMENTMODE\":\"DC\",\"REFUNDAMT\":\"0.00\",\"TXNDATE\":\"2022-05-25 09:00:58.0\",\"UDF_1\":\"20220525326413801129\",\"BIN\":\"416021\",\"LASTFOURDIGITS\":\"1719\"}"
}

Failure

{
"cardScheme":"VISA",
"GATEWAYNAME":"Paytm",
"PAYMENTMODE":"DC",
"TXNDATE":"2022-05-25",
"TXNDATETIME":"2022-05-25 09:53:16.0",
"CUSTID":"",
"STATUS":"TXN_FAILURE",
"MID":"YOUR_MID_HERE",
"ORDERID":"REN250522EQ80VWE8CCJ",
"CURRENCY":"INR",
"TXNID":"20220525XXXX12809100168634603285502",
"TXNAMOUNT":"124471.00",
"BANKTXNID":"20220525111212800100168595755608335",
"BANKNAME":"State Bank of India",
"RESPMSG":"Your payment has been declined by your bank. Please try again or use a different method to complete the payment.",
"RESPCODE":"227",
"MERC_UNQ_REF":"",
"CHECKSUMHASH":"RpIuQG3kKrq3fKBb9xCtiXV1EA3OXhcpYxBzMD/ONsSKPkx5f7XXcvz72okNTom5bGqfPxIkIR1MK+WnnZ3pZATYQeMMahPQ1hfJuOsas7Q=",
"RRN":"",
"BIN":"459156",
"LASTFOURDIGITS":"0305",
"GATEWAYINFO":"{CURRENCY=INR, GATEWAYNAME=ICICIPAY, RESPMSG=Your payment has been declined by your bank. Please try again or use a different method to complete the payment., BANKNAME=State Bank of India, MID=MERCH64129621595501, RESPCODE=227, merchant_key=VbN8Z2xh7hsYTS+IQWFKta1A/BrhC5yyO/gqYiWyxKs=, TXNID=20220525111212800100168595755608335, TXNAMOUNT=124471.00, RRN=73907901634, ORDERID=REN250522EQ80VWE8CCJ, STATUS=TXN_FAILURE, TXNDATE=2022-05-25 09:53:16.0}"
}

 

Success

{
"GATEWAYNAME":"Paytm",
"PAYMENTMODE":"UPI",
"TXNDATE":"2022-05-25",
"TXNDATETIME":"2022-05-25 09:00:03.0",
"CUSTID":"5014797328",
"STATUS":"TXN_SUCCESS",
"MID":"YOUR_MID_HERE",
"ORDERID":"REN2505226WXLDF9OLNR",
"CURRENCY":"INR",
"TXNID":"20220525XXXX12809100168705703285906",
"TXNAMOUNT":"2463.18",
"BANKTXNID":"20220525111212800100168923855418708",
"BANKNAME":"",
"RESPMSG":"Txn Success",
"RESPCODE":"01",
"MERC_UNQ_REF":"",
"CHECKSUMHASH":"me8/OcUHEprgq3qk5UcjydnQpMw5gGOhe7qO2pMy6LuD2wKfA9rBaT0ius/qVOQXWSU96wOT/A1LlzFChwkQjoOwx28nJo96s1Lo8Sa/5qw=",
"RRN":"214505413263",
"VPA":"702******4@ybl",
"GATEWAYINFO":"{\"TXNID\":\"20220525111212800100168923855418708\",\"BANKTXNID\":\"214505413263\",\"ORDERID\":\"REN2505226WXLDF9OLNR\",\"TXNAMOUNT\":\"2463.18\",\"STATUS\":\"TXN_SUCCESS\",\"TXNTYPE\":\"SALE\",\"GATEWAYNAME\":\"PPBLC\",\"RESPCODE\":\"01\",\"RESPMSG\":\"Txn Success\",\"MID\":\"MERCH64129621595501\",\"PAYMENTMODE\":\"UPI\",\"REFUNDAMT\":\"0.00\",\"TXNDATE\":\"2022-05-25 09:01:53.0\",\"UDF_1\":\"20220525325930143770\",\"VPA\":\"702******4@ybl\"}"
}

Failure

{
"GATEWAYNAME":"Paytm",
"PAYMENTMODE":"UPI",
"TXNDATE":"2022-05-24",
"TXNDATETIME":"2022-05-24 19:42:25.0",
"CUSTID":"",
"STATUS":"TXN_FAILURE",
"MID":"YOUR_MID_HERE",
"ORDERID":"REN240522Q6Q55G84R9O",
"CURRENCY":"INR",
"TXNID":"20220524XXXX12809100168512703319130",
"TXNAMOUNT":"5254.30",
"BANKTXNID":"20220524111212800100168718355275039",
"BANKNAME":"",
"RESPMSG":"Your payment has been declined by your bank. Please try again or use a different method to complete the payment.",
"RESPCODE":"227",
"MERC_UNQ_REF":"",
"CHECKSUMHASH":"axHIprPQ6M3sfBcPR5GQvYpfBJ69CDxxm7PvzfCjb6z0yO54qlvZ26iUtAeR6V7AIh0UVZovPm1D9vRFnzLPgd0YhryKMB9ZIbMff6oaGcw=",
"RRN":"",
"VPA":"",
"GATEWAYINFO":"{CURRENCY=INR, ORDERID=REN240522Q6Q55G84R9O, STATUS=TXN_FAILURE, GATEWAYNAME=PPBLC, RESPMSG=Sorry, you do not have enough balance in your bank account. Please try again with different payment method., TXNDATE=2022-05-24 19:42:41.0, MID=MERCH64129621595501, RESPCODE=202, merchant_key=VbN8Z2xh7hsYTS+IQWFKta1A/BrhC5yyO/gqYiWyxKs=, TXNID=20220524111212800100168718355275039, TXNAMOUNT=5254.30, RRN=}"
}