search

Payment Status

Paytm 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. To configure the URL, please Get in touch.

The sample response of different payment sources are mentioned below.

Success

[ORDERID] => ORDERID_98765
[MID] => INTEGR7769XXXXXX9383
[TXNID] => 202005081112128XXXXXX68470101509706
[TXNAMOUNT] => 1.00
[PAYMENTMODE] => PPI
[CURRENCY] => INR
[TXNDATE] => 2020-07-24 15:13:02.0
[STATUS] => TXN_SUCCESS
[RESPCODE] => 01
[RESPMSG] => Txn Success
[GATEWAYNAME] => WALLET
[BANKTXNID] => 62909899
[BANKNAME] => WALLET
[CHECKSUMHASH] => y5Tn02QKOQdhyYKK+uHHgNIIZOjC/xPf4jSPQRBNSrcP6DR3ejFuQ4+kQi0a8KX2txJCnQkTnUxtJhM6jImU8FU+E1GlSSK5VjMLsSm/R6w=

Failure

[ORDERID] => ORDERID_98765
[MID] => INTEGR7769XXXXXX9383
[TXNID] => 202005081112128XXXXXX68470101509706
[TXNAMOUNT] => 1.00
[PAYMENTMODE] => PPI
[CURRENCY] => INR
[TXNDATE] => 2020-07-24 15:13:02.0
[STATUS] => TXN_FAILURE
[RESPCODE] => 227
[RESPMSG] => Your payment has been declined by your bank. Please try again or use a different method to complete the payment.
[GATEWAYNAME] => WALLET
[BANKTXNID] => 62909899
[BANKNAME] => WALLET
[CHECKSUMHASH] => y5Tn02QKOQdhyYKK+uHHgNIIZOjC/xPf4jSPQRBNSrcP6DR3ejFuQ4+kQi0a8KX2txJCnQkTnUxtJhM6jImU8FU+E1GlSSK5VjMLsSm/R6w=

Note: All the response codes of the transaction are available here.

The parameters are briefly described below.

Response Attributes

ATTRIBUTE DESCRIPTION
ORDERID OrderId passed in the request
Example:OREDRID_98765
MID Merchant ID passed in the request
Example: INTEGR7769XXXXXX9383
TXNID Unique reference number generated at paytm side for each transaction
Example: 202005081112128XXXXXX68470101509706
TXNAMOUNT Payment transaction Amount
Example: 1.00
CURRENCY Payment currency type
Example:INR
PAYMENTMODE Payment Mode used in payment
Example: PPI
TXNDATE Transaction Date
Example: 7/24/2020 15:13:02
STATUS This parameter indicates the status of API call.
Example: TXN_SUCCESS
RESPCODE This is the resultCode corresponding to a particular message and is returned to the merchant. It's maximum length is 64. For list of different RESPCODE and RESPMSG please refer to the PDF.
Example: 01
RESPMSG This parameter is the result message which contains information about the result.
Example: Txn Success
GATEWAYNAME Gateway Name used in payment
Example: WALLET
BANKTXNID Unique reference number generated at bank side for each transaction
Example: 62909899
BANKNAME Bank Name used in payment
Example: WALLET
CHECKSUMHASH Paytm validates the parameter values by verifying the signature comes in the request. It ensures that parameter values are not tempered. Signature string can be created by using Paytm checksum library.
Example:
y5Tn02QKOQdhyYKK+uHHgNIIZOjC/XXXXjSPQRBNSrcP6DR3ejFuQ4+kQi0a8KX2txJCnQkTnUxtJhM6jImU8FU+E1GlSSK5VjMLsSm/R6w=

Success

[ORDERID] => ORDERID_98765
[MID] => INTEGR7769XXXXXX9383
[TXNID] => 202005081112128XXXXXX68470101509706
[TXNAMOUNT] => 1.00
[PAYMENTMODE] => Paytm Postpaid
[CURRENCY] => INR
[TXNDATE] => 2020-08-19 11:41:18.0
[STATUS] => TXN_SUCCESS
[RESPCODE] => 01
[RESPMSG] => Txn Success
[GATEWAYNAME] => PAYTMCC
[BANKTXNID] => 14120200819119258216
[BANKNAME] => PAYTMCC
[CHECKSUMHASH] => AeYn/Pfqt9xLBCsoTpOmpB0jM7Rx6kXS217D+3kAJR2DG9Ay/abk6qoQLJoH3dAyvMUEEDxqQquYGHmgkjCLZ86TX40Bv1QH7dvLdgjBzbE=

Failure

[ORDERID] => ORDERID_98765
[MID] => INTEGR7769XXXXXX9383
[TXNID] => 202005081112128XXXXXX68470101509706
[TXNAMOUNT] => 1.00
[PAYMENTMODE] => Paytm Postpaid
[CURRENCY] => INR
[TXNDATE] => 2020-08-19 11:41:18.0
[STATUS] => TXN_FAILURE
[RESPCODE] => 810
[RESPMSG] => Payment failed due to a technical error. Please try after some time.
[GATEWAYNAME] => PAYTMCC
[BANKTXNID] => 14120200819119258216
[BANKNAME] => PAYTMCC
[CHECKSUMHASH] => AeYn/Pfqt9xLBCsoTpOmpB0jM7Rx6kXS217D+3kAJR2DG9Ay/abk6qoQLJoH3dAyvMUEEDxqQquYGHmgkjCLZ86TX40Bv1QH7dvLdgjBzbE=

Note: All the response codes of the transaction are available here.

The parameters are briefly described below:

Response Attributes

ATTRIBUTE DESCRIPTION
ORDERID OrderId passed in the request
Example:OREDRID_98765
MID Merchant ID passed in the request
Example: INTEGR7769XXXXXX9383
TXNID Unique reference number generated at paytm side for each transaction
Example: 202005081112128XXXXXX68470101509706
TXNAMOUNT Payment transaction Amount
Example: 1.00
CURRENCY Payment currency type
Example: INR
PAYMENTMODE Payment Mode used in payment
Example: Paytm Postpaid
TXNDATE Transaction Date
Example: 7/24/2020 15:13:02
STATUS This parameter indicates the status of API call.
Example: TXN_SUCCESS
RESPCODE This is the resultCode corresponding to a particular message and is returned to the merchant. It's maximum length is 64. For list of different RESPCODE and RESPMSG please refer to the PDF.
Example: 01
RESPMSG This parameter is the result message which contains information about the result.
Example: Txn Success
GATEWAYNAME Gateway Name used in payment
Example: PAYTMCC
BANKTXNID Unique reference number generated at bank side for each transaction
Example: 14120200819119258216
BANKNAME Bank Name used in payment
Example: PAYTMCC
CHECKSUMHASH Paytm validates the parameter values by verifying the signature comes in the request. It ensures that parameter values are not tempered. Signature string can be created by using Paytm checksum library.
Example:
y5Tn02QKOQdhyYKK+uHHgNIIZOjC/XXXXjSPQRBNSrcP6DR3ejFuQ4+kQi0a8KX2txJCnQkTnUxtJhM6jImU8FU+E1GlSSK5VjMLsSm/R6w=

Success

[ORDERID] => ORDERID_98765
[MID] => INTEGR7769XXXXXX9383
[TXNID] => 202005081112128XXXXXX68470101509706
[TXNAMOUNT] => 1.00
[PAYMENTMODE] => CC
[CURRENCY] => INR
[TXNDATE] => 2020-07-24 15:35:33.0
[STATUS] => TXN_SUCCESS
[RESPCODE] => 01
[RESPMSG] => Txn Success
[GATEWAYNAME] => HDFC
[BANKTXNID] => 777001087423130
[BANKNAME] => JPMorgan Chase Bank
[CHECKSUMHASH] => wHY+0+UVBpJBJeKw1TdPM7QwK1VLnGLKoMJA+lPn2pLxpEnMJt4CJuQETpKB/j49h8FG+1CMGRy1ozqemcN46Q2c/W0lPBPUSFCMApckKfU=

Failure

[ORDERID] => ORDERID_98765
[MID] => INTEGR7769XXXXXX9383
[TXNID] => 202005081112128XXXXXX68470101509706
[TXNAMOUNT] => 1.00
[PAYMENTMODE] => CC
[CURRENCY] => INR
[TXNDATE] => 2020-09-02 16:37:17.0
[STATUS] => TXN_FAILURE
[RESPCODE] => 227
[RESPMSG] => Your payment has been declined by your bank. Please try again or use a different method to complete the payment.
[GATEWAYNAME] => HDFC
[BANKTXNID] => 777001233456842
[BANKNAME] => JPMorgan Chase Bank
[CHECKSUMHASH] => WGq1tMZeeGSh8OqjMcbcjOmMg53riM6k9Via1iXdRApc6zYCabjB62l9LHOs4v+OKwDCHdHQX/8MqEdM0ajfISevjSTJA2SXc8/D+XXPN5U=

Note: All the response codes of the transaction are available here.

The parameters are briefly described below:

Response Attributes

ATTRIBUTE DESCRIPTION
ORDERID OrderId passed in the request
Example: OREDRID_98765
MID Merchant ID passed in the request
Example: INTEGR7769XXXXXX9383
TXNID Unique reference number generated at paytm side for each transaction
Example: 202005081112128XXXXXX68470101509706
TXNAMOUNT Payment transaction Amount
Example: 1.00
CURRENCY Payment currency type
Example:INR
PAYMENTMODE Payment Mode used in payment
Example: CC
TXNDATE Transaction Date
Example: 7/24/2020 15:13:02
STATUS This parameter indicates the status of API call.
Example: TXN_SUCCESS
RESPCODE This is the resultCode corresponding to a particular message and is returned to the merchant. It's maximum length is 64. For list of different RESPCODE and RESPMSG please refer to the PDF.
Example: 01
RESPMSG This parameter is the result message which contains information about the result.
Example: Txn Success
GATEWAYNAME Gateway Name used in payment
Example: HDFC
BANKTXNID Unique reference number generated at bank side for each transaction
Example: 777001087423130
BANKNAME Bank Name used in payment
Example: JPMorgan Chase Bank
CHECKSUMHASH Paytm validates the parameter values by verifying the signature comes in the request. It ensures that parameter values are not tempered. Signature string can be created by using Paytm checksum library.
Example:
y5Tn02QKOQdhyYKK+uHHgNIIZOjC/XXXXjSPQRBNSrcP6DR3ejFuQ4+kQi0a8KX2txJCnQkTnUxtJhM6jImU8FU+E1GlSSK5VjMLsSm/R6w=

Success

[ORDERID] => ORDERID_98765
[MID] => INTEGR7769XXXXXX9383
[TXNID] => 202005081112128XXXXXX68470101509706
[TXNAMOUNT] => 1.00
[PAYMENTMODE] => DC
[CURRENCY] => INR
[TXNDATE] => 2020-07-24 15:23:07.0
[STATUS] => TXN_SUCCESS
[RESPCODE] => 01
[RESPMSG] => Txn Success
[GATEWAYNAME] => HDFC
[BANKTXNID] => 777001420411401
[BANKNAME] => HDFC Bank
[CHECKSUMHASH] => BHL7pZKMchCFxadVbPWvpw9+fLaG8sBfU8ivakR7vKmWq6QYlzxL5N3JeVYY5GHiJo1UCJ8zpE6FiX5G+aaA0AdWjbsR0j4xyXGOjpqO4qY=

Failure

[ORDERID] => ORDERID_98765
[MID] => INTEGR7769XXXXXX9383
[TXNID] => 202005081112128XXXXXX68470101509706
[TXNAMOUNT] => 1.00
[PAYMENTMODE] => DC
[CURRENCY] => INR
[TXNDATE] => 2020-07-24 15:23:07.0
[STATUS] => TXN_FAILURE
[RESPCODE] => 227
[RESPMSG] => Your payment has been declined by your bank. Please try again or use a different method to complete the payment.
[GATEWAYNAME] => HDFC
[BANKTXNID] => 777001420411401
[BANKNAME] => HDFC Bank
[CHECKSUMHASH] => BHL7pZKMchCFxadVbPWvpw9+fLaG8sBfU8ivakR7vKmWq6QYlzxL5N3JeVYY5GHiJo1UCJ8zpE6FiX5G+aaA0AdWjbsR0j4xyXGOjpqO4qY=

Note: All the response codes of the transaction are available here.

The parameters are briefly described below:

Response Attributes

ATTRIBUTE DESCRIPTION
ORDERID OrderId passed in the request
Example: OREDRID_98765
MID Merchant ID passed in the request
Example: INTEGR7769XXXXXX9383
TXNID Unique reference number generated at paytm side for each transaction
Example: 202005081112128XXXXXX68470101509706
TXNAMOUNT Payment transaction Amount
Example: 1.00
CURRENCY Payment currency type
Example: INR
PAYMENTMODE Payment Mode used in payment
Example: DC
TXNDATE Transaction Date
Example: 7/24/2020 15:13:02
STATUS This parameter indicates the status of API call.
Example: TXN_SUCCESS
RESPCODE This is the resultCode corresponding to a particular message and is returned to the merchant. It's maximum length is 64. For list of different RESPCODE and RESPMSG please refer to the PDF.
Example: 01
RESPMSG This parameter is the result message which contains information about the result.
Example: Txn Success
GATEWAYNAME Gateway Name used in payment
Example: HDFC
BANKTXNID Unique reference number generated at bank side for each transaction
Example: 777001087423130
BANKNAME Bank Name used in payment
Example: MASTER
CHECKSUMHASH Paytm validates the parameter values by verifying the signature comes in the request. It ensures that parameter values are not tempered. Signature string can be created by using Paytm checksum library.
Example:
y5Tn02QKOQdhyYKK+uHHgNIIZOjC/XXXXjSPQRBNSrcP6DR3ejFuQ4+kQi0a8KX2txJCnQkTnUxtJhM6jImU8FU+E1GlSSK5VjMLsSm/R6w=

Success

[ORDERID] => ORDERID_98765 
[MID] => INTEGR7769XXXXXX9383 
[TXNID] => 202005081112128XXXXXX68470101509706 
[TXNAMOUNT] => 1.00 
[PAYMENTMODE] => NB 
[CURRENCY] => INR 
[TXNDATE] => 2020-07-24 14:53:34.0 
[STATUS] => TXN_SUCCESS 
[RESPCODE] => 01 
[RESPMSG] => Txn Success 
[GATEWAYNAME] => SBI 
[BANKTXNID] => 19180340015 
[BANKNAME] => SBI 
[CHECKSUMHASH] => cVA9PDcQuRh0IuuERsyaAwC86aV8f4FMnxLuRUckimptc84+30Ropf2Cj3iEp31TyLJQ3RsOqliBtUVTZzROwg07P3RuVM3ul/2nMxrs92c= 

Failure

[ORDERID] => ORDERID_98765
[MID] => INTEGR7769XXXXXX9383
[TXNID] => 202005081112128XXXXXX68470101509706
[TXNAMOUNT] => 1.00
[PAYMENTMODE] => NB
[CURRENCY] => INR
[TXNDATE] => 2020-09-02 16:36:31.0
[STATUS] => TXN_FAILURE
[RESPCODE] => 227
[RESPMSG] => Your payment has been declined by your bank. Please try again or use a different method to complete the payment.
[GATEWAYNAME] => SBI
[BANKTXNID] => 19222179724
[BANKNAME] => SBI
[CHECKSUMHASH] => cMSijptLGunvTiRy3W0nJCMBzGpMLHhtnR1BXZYdB0Y5wz/BY1q5MyliyIXma+7YehEFBNqZH9qVHGMqacadQzAq7Vn4yADIZNNBJYe/6Rg=

Note: All the response codes of the transaction are available here.

The parameters are briefly described below:

Response Attributes

  DESCRIPTION
ORDERID OrderId passed in the request
Example: OREDRID_98765
MID Merchant ID passed in the request
Example: INTEGR7769XXXXXX9383
TXNID Unique reference number generated at paytm side for each transaction
Example: 202005081112128XXXXXX68470101509706
TXNAMOUNT Payment transaction Amount
Example: 1.00
CURRENCY Payment currency type
Example: INR
PAYMENTMODE Payment Mode used in payment
Example: NB
TXNDATE Transaction Date
Example: 7/24/2020 15:13:02
STATUS This parameter indicates the status of API call.
Example: TXN_SUCCESS
RESPCODE This is the resultCode corresponding to a particular message and is returned to the merchant. It's maximum length is 64. For list of different RESPCODE and RESPMSG please refer to the PDF.
Example: 01
RESPMSG This parameter is the result message which contains information about the result.
Example: Txn Success
GATEWAYNAME Gateway Name used in payment
Example: SBI
BANKTXNID Unique reference number generated at bank side for each transaction
Example: 19180340015
BANKNAME Bank Name used in payment
Example: SBI
CHECKSUMHASH Paytm validates the parameter values by verifying the signature comes in the request. It ensures that parameter values are not tempered. Signature string can be created by using Paytm checksum library.
Example:
y5Tn02QKOQdhyYKK+uHHgNIIZOjC/XXXXjSPQRBNSrcP6DR3ejFuQ4+kQi0a8KX2txJCnQkTnUxtJhM6jImU8FU+E1GlSSK5VjMLsSm/R6w=

Success

[ORDERID] => ORDERID_98765
[MID] => INTEGR7769XXXXXX9383
[TXNID] => 202005081112128XXXXXX68470101509706
[TXNAMOUNT] => 2000.00
[PAYMENTMODE] => EMI
[CURRENCY] => INR
[TXNDATE] => 2020-07-27 19:43:11.0
[STATUS] => TXN_SUCCESS
[RESPCODE] => 01
[RESPMSG] => Txn Success
[GATEWAYNAME] => HDFC
[BANKTXNID] => 777001131568358
[BANKNAME] => ICICI Bank
[CHECKSUMHASH] => Goz5cR5ms8yNFRiybuQvUYsp9WcdWqR5MYcjG+qZcBwLPqF2zANfA+5rNDQqcVeYzR1B2dlWdqw63/BxMmn6HpGH2ymqWv5M0Gi0w+JRkkY=

Failure

[ORDERID] => ORDERID_98765
[MID] => INTEGR7769XXXXXX9383
[TXNID] => 202005081112128XXXXXX68470101509706
[TXNAMOUNT] => 2000.00
[PAYMENTMODE] => EMI
[CURRENCY] => INR
[TXNDATE] => 2020-07-27 19:43:11.0
[STATUS] => TXN_FAILURE
[RESPCODE] => 810
[RESPMSG] => Payment failed due to a technical error. Please try after some time.
[GATEWAYNAME] => HDFC
[BANKTXNID] => 777001131568358
[BANKNAME] => ICICI Bank
[CHECKSUMHASH] => Goz5cR5ms8yNFRiybuQvUYsp9WcdWqR5MYcjG+qZcBwLPqF2zANfA+5rNDQqcVeYzR1B2dlWdqw63/BxMmn6HpGH2ymqWv5M0Gi0w+JRkkY=

Note: All the response codes of the transaction are available here.

The parameters are briefly described below:

Response Attributes


ATTRIBUTE DESCRIPTION
ORDERID OrderId pased in the request
Example: OREDRID_98765
MID Merchant ID passed in the request
Example: INTEGR7769XXXXXX9383
TXNID Unique reference number generated at paytm side for each transaction
Example: 202005081112128XXXXXX68470101509706
TXNAMOUNT Payment transaction Amount
Example: 1.00
CURRENCY Payment currency type
Example: INR
PAYMENTMODE Payment Mode used in payment
Example: EMI
TXNDATE Transaction Date
Example: 7/24/2020 15:13:02
STATUS This parameter indicates the status of API call.
Example: TXN_SUCCESS
RESPCODE This is the resultCode corresponding to a particular message and is returned to the merchant. It's maximum length is 64. For list of different RESPCODE and RESPMSG please refer to the PDF.
Example: 01
RESPMSG This parameter is the result message which contains information about the result.
Example: Txn Success
GATEWAYNAME Gateway Name used in payment
Example: HDFC
BANKTXNID Unique reference number generated at bank side for each transaction
Example: 777001131568358
BANKNAME Bank Name used in payment
Example: ICICI Bank
CHECKSUMHASH Paytm validates the parameter values by verifying the signature comes in the request. It ensures that parameter values are not tempered. Signature string can be created by using Paytm checksum library.
Example:
y5Tn02QKOQdhyYKK+uHHgNIIZOjC/XXXXjSPQRBNSrcP6DR3ejFuQ4+kQi0a8KX2txJCnQkTnUxtJhM6jImU8FU+E1GlSSK5VjMLsSm/R6w=

Success

[ORDERID] => ORDERID_98765
[MID] => INTEGR7769XXXXXX9383
[TXNID] => 202005081112128XXXXXX68470101509706
[TXNAMOUNT] => 1.00
[PAYMENTMODE] => UPI
[CURRENCY] => INR
[TXNDATE] => 2020-07-28 10:14:55.0
[STATUS] => TXN_SUCCESS
[RESPCODE] => 01
[RESPMSG] => Txn Success
[GATEWAYNAME] => PPBLC
[BANKTXNID] => 6877266
[CHECKSUMHASH] => glEBpHd9yJ5g9ReTNkpjfFsvBEb1aYIdQN1mSCbMVNcn6CGDr3UUf3psseqKGPswoU0Xdl6g9P9Jc6U9Q9Ol/JuwcudfMLRgaUjj2rsAl/8=

Failure

[ORDERID] => ORDERID_98765
[MID] => INTEGR7769XXXXXX9383
[TXNID] => 202005081112128XXXXXX68470101509706
[TXNAMOUNT] => 1.00
[PAYMENTMODE] => UPI
[CURRENCY] => INR
[TXNDATE] => 2020-07-28 10:14:55.0
[STATUS] => TXN_FAILURE
[RESPCODE] => 810
[RESPMSG] => Payment failed due to a technical error. Please try after some time.
[GATEWAYNAME] => PPBLC
[BANKTXNID] => 6877266
[CHECKSUMHASH] => glEBpHd9yJ5g9ReTNkpjfFsvBEb1aYIdQN1mSCbMVNcn6CGDr3UUf3psseqKGPswoU0Xdl6g9P9Jc6U9Q9Ol/JuwcudfMLRgaUjj2rsAl/8=

Note: All the response codes of the transaction are available here.

The parameters are briefly described below:

Response Attributes

ATTRIBUTE DESCRIPTION
ORDERID OrderId pased in the request
Example: OREDRID_98765
MID Merchant ID passed in the request
Example: INTEGR7769XXXXXX9383
TXNID Unique reference number generated at paytm side for each transaction
Example: 202005081112128XXXXXX68470101509706
TXNAMOUNT Payment transaction Amount
Example: 1.00
CURRENCY Payment currency type
Example: INR
PAYMENTMODE Payment Mode used in payment
Example: UPI
TXNDATE Transaction Date
Example: 7/24/2020 15:13:02
STATUS This parameter indicates the status of API call.
Example:TXN_SUCCESS
RESPCODE This is the resultCode corresponding to a particular message and is returned to the merchant. It's maximum length is 64. For list of different RESPCODE and RESPMSG please refer to the PDF.
Example: 01
RESPMSG This parameter is the result message which contains information about the result.
Example: Txn Success
GATEWAYNAME Gateway Name used in payment
Example: PPBLC
BANKTXNID Unique reference number generated at bank side for each transaction
Example: 6877266
CHECKSUMHASH Paytm validates the parameter values by verifying the signature comes in the request. It ensures that parameter values are not tempered. Signature string can be created by using Paytm checksum library.
Example:
y5Tn02QKOQdhyYKK+uHHgNIIZOjC/XXXXjSPQRBNSrcP6DR3ejFuQ4+kQi0a8KX2txJCnQkTnUxtJhM6jImU8FU+E1GlSSK5VjMLsSm/R6w=
 

Success

[GATEWAYNAME] => PPBL
[cardScheme] => MAESTRO
[PAYMENTMODE] => BANK_TRANSFER
[CUSTID] =>
[LASTFOURDIGITS] => 1111
[ORDERID] => PPBL_98765
[STATUS] => TXN_SUCCESS
[BANKTXNID] => 153579
[transferMode] => RTGS
[TXNDATE] => 2021-04-16
[bankTransactionDate] => 20210416
[CHECKSUMHASH] => UZq9+hDHVCC/s+tjJyw+3oDSMCeQki4nxqraIHsP/bP23wh6/X+FRXxz2+tC88+2yVPfpuoybKMkJxbRD7GedqY3e2pLI1t/aBEFXsTNAfw=
[CURRENCY] => INR
[clientId] => VC01
[RESPMSG] => Txn Success
[BANKNAME] =>
[BIN] => 411111
[vanInfo] => {"van":"PYI38XXXXXX62339","beneficiaryName":"One97 Communications Limited","ifscCode":"PYTM0123456","purpose":"Testing only","userDefinedFields":{"udf1":"test1","udf2":"test2","udf3":"test3","udf4":"test4","udf5":"test5"},"customerDetails":[{"customerName":"test user","customerEmail":"testuser@gmail.com","customerMobile":"7777777777"}]}
[MID] => INTEGR7769XXXXXX9383
[MERC_UNQ_REF] =>
[RESPCODE] => 01
[TXNID] => 202005081112128XXXXXX68470101509706
[TXNAMOUNT] => 1.00
[utr] => 313687707152
[TXNDATETIME] => 2021-04-16 14:11:58.0
[accountDetails] => {"maskedAccountNumber":"9181****1266","accountHolderName":"loknath","bankName":"Paytm Payments Bank","ifscCode":"PYTM0123456"}

Failure

[CURRENCY] => INR
[GATEWAYNAME] => PPBL
[cardScheme] => MAESTRO
[RESPMSG] => Your payment has been declined by your bank. Please try again or use a different method to complete the payment.
[BANKNAME] =>
[BIN] => 411111
[PAYMENTMODE] => BANK_TRANSFER
[CUSTID] =>
[LASTFOURDIGITS] => 1111
[MID] => INTEGR7769XXXXXX9383
[MERC_UNQ_REF] =>
[RESPCODE] => 227
[TXNID] => 202005081112128XXXXXX68470101509706
[TXNAMOUNT] => 1.00
[ORDERID] => PPBL_98765
[STATUS] => TXN_FAILURE
[BANKTXNID] => 690762
[TXNDATETIME] => 2021-04-16 14:11:32.0
[TXNDATE] => 2021-04-16
[CHECKSUMHASH] => oP3K9RmfFxNI7+vhTmtRxNHMQc7bx5RMn9SZGZ0HzxFeIXU/9K7qZNXBRRNe06w9W3qVoNaUFQxrfjI9kjoGCLVqr88gERQs366q/R8Oi9M=

Note: All the response codes of the transaction are available here.

The parameters are briefly described below.

Response Attributes

ATTRIBUTE DESCRIPTION

GATEWAYNAME

Gateway Name used in payment
Example: PPBLC

cardScheme

Payment network linked to the card.

ExampleMAESTRO

PAYMENTMODE

Payment Mode used in payment
Example: UPI

CUSTID

Unique reference ID for every customer which is generated by merchant. Special characters allowed in CustId are @,! ,_,$.

LASTFOURDIGITS

Last four digits of the account

ORDERID

OrderId passed in the request
Example: OREDRID_98765

STATUS

This parameter indicates the status of the API call.
Example:TXN_SUCCESS

BANKTXNID

Unique reference number generated at bank side for each transaction
Example: 6877266

transferMode

Mode of bank transfer

Example: NEFT/RTGS/IMPS

TXNDATE

Transaction Date
Example: 7/24/2020 15:13:02

bankTransactionDate

Bank transaction date

Example: 2020-09-25 11:35:07.0

CHECKSUMHASH

 

Paytm validates the parameter values by verifying the signature comes in the request. It ensures that parameter values are not tempered. Signature string can be created by using Paytm checksum library.
Example:

y5Tn02QKOQdhyYKK+uHHgNIIZOjC/XXXXjSPQRBNSrcP6DR3ejFuQ4+kQi0a8KX2txJCnQkTnUxtJhM6jImU8FU+E1GlSSK5VjMLsSm/R6w=

CURRENCY

Payment currency type
Example: INR

clientId

Paytm use the merchant key on the basis of clientId parameter value. It requires only if the merchant has more than one key.

RESPMSG

This parameter is the result message which contains information about the result.
Example: Txn Success

BANKNAME

Bank Name used in payment

Example: Paytm Payments Bank, ICICI Bank

BIN

BIN details like issuing bank name

vanInfo

VanInfo

van details

MID

Merchant ID passed in the request
Example: INTEGR7769XXXXXX9383

MERC_UNQ_REF

Merchant's reference text which comes in final response of Process Transaction API from Paytm

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

TXNID

Unique reference number generated at Paytm side for each transaction
Example: 202005081112128XXXXXX68470101509706

TXNAMOUNT

Payment transaction Amount
Example: 1.00

utr

Unique transaction reference number from the bank

Example: 5R01IY000V27

TXNDATETIME

Transaction Date and Time
Example: 7/24/2020 15:13:02

accountDetails

AccountDetails

Customer/Remitter source account details

 

AccountDetails

Attributes Description

maskedAccountNumber

This contains the masked bank account from where the transfer is being made

accountHolderName

Name of the customer's bank account

bankName

Name of the bank used for the transfer

ifscCode

Ifsc code of the bank

Example: BACB0000003

 

VanInfo

Attributes Description

van

Virtual Account Number. This is the 16 alphanumeric account number which will be given to the end customer to initiate a bank transfer.

beneficiaryName

Beneficiary name of the VAN. Along with the VAN, this needs to give to the customer.

ifscCode

IFSC code of the VAN. Along with the VAN, this needs to give to the customer.

purpose

The purpose for which VAN is getting created. This is a free string that can be passed by the merchant. The value passed in these fields will be available in order APIs, webhooks, VAN APIs, transaction and settlement report against the payment received for a particular VAN.

userDefinedFields

UserDefinedFields

User-defined fields

customerDetails

CustomerDetails

Contact details of the customer, refer the Customer Contact

For now, we are supporting l 1 customer detail.

There is a validation of customer Email but no validation on mobile number.

Also, there is the validation of not more than 1 customerdetails to be passed.

 

userDefinedFields

Attributes Description

udf1-udf5

UDF stands for user-defined fields. These fields can be used by merchants for reconciliation purpose. The value passed in these fields will be available in order APIs, webhooks, VAN APIs, transaction and settlement report against the payment received for a particular VAN.

 

CustomerDetails

Attributes Description

customerName

Name of the entity to which the VAN is being given to. It can be the name of the customer, name of area etc. The value passed in these fields will be available in order APIs, webhooks, VAN APIs, transaction and settlement report against the payment received for a particular VAN.
Going forward this will be used in email and SMS communication in VAN disbursals amongst customers.

customerEmail

Email ID of the customer. The value passed in these fields will be available in order APIs, webhooks, VAN APIs, transaction and settlement report against the payment received for a particular VAN.
Going forward this will be used in email and SMS communication in VAN disbursals amongst customers.

customerMobile

Mobile Number of the customer. The value passed in these fields will be available in order APIs, webhooks, VAN APIs, transaction and settlement report against the payment received for a particular VAN.
Going forward this will be used in email and SMS communication in VAN disbursals amongst customers.

Success

[CURRENCY] => INR,
[GATEWAYNAME] => IICP,
[RESPMSG] => Txn Success,
[BANKNAME] => State Bank of India,
[feeRateFactors] => {"internationalCardPayment":"TRUE","dcc":"TRUE"},
[PAYMENTMODE] => DC,
[CUSTID] => Test101,
[MID] => INTEGR7769XXXXXX9383,
[MERC_UNQ_REF] => ,
[RESPCODE] => 01,
[TXNID] => 202005081112128XXXXXX68470101509706,
[TXNAMOUNT] => 1.00,
[baseCurrency] => INR,
[dccPaymentDetail] => {"dccId":"41XXXX72","amountPerUnitForeignAmount":"0.01","foreignCurrencyCode":"USD","foreignCurrencySymbol":"$","foreignPayableAmount":"0.01","foreignPaymentAmount":"0.01","foreignMarkupAmount":"0.46","foreignMarkupRatePercentage":"0.5","expirationTimestamp":"2021-02-12T18:48:03.733 05:30","exchangeRateSourceName":"MOCK","isoForeignCurrencyCode":"840","dccOffered":"true","foreignCurrencyName":"Dollar"},
[internationalCardPayment] => true,
[ORDERID] => ORDERID_98765,
[STATUS] => TXN_SUCCESS,
[BANKTXNID] => 77700XXXXX71013,
[TXNDATETIME] => 2021-02-12 18:44:39.0,
[TXNDATE] => 2021-02-12

Failure

[CURRENCY] => INR
[GATEWAYNAME] => IICP
[cardScheme] => MASTER
[RESPMSG] => Payment declined by your bank as the OTP/Password verification falied. Please try again by entering the correct values.
[BANKNAME] => State Bank of India
[BIN] => 555554
[PAYMENTMODE] => DC
[CUSTID] => Test101
[LASTFOURDIGITS] => 1397
[MID] => INTEGR7769XXXXXX9383
[MERC_UNQ_REF] =>
[RESPCODE] => 227
[TXNID] => 202005081112128XXXXXX68470101509706
[TXNAMOUNT] => 1.00
[ORDERID] => ORDERID_98765
[STATUS] => TXN_FAILURE
[dccPaymentDetail] => {"dccId":"41XXXX72","amountPerUnitForeignAmount":"0.01","foreignCurrencyCode":"USD","foreignCurrencySymbol":"$","foreignPayableAmount":"0.01","foreignPaymentAmount":"0.01","foreignMarkupAmount":"0.46","foreignMarkupRatePercentage":"0.5","expirationTimestamp":"2021-02-12T18:48:03.733 05:30","exchangeRateSourceName":"MOCK","isoForeignCurrencyCode":"840","dccOffered":"true","foreignCurrencyName":"Dollar"},
[BANKTXNID] => 16135626799
[TXNDATETIME] => 2021-02-17 17:21:07.0
[TXNDATE] => 2021-02-17
[CHECKSUMHASH] => 6HhhdsTiFjx+jN7FM5ERP5V0aJFMh3vk+q46q1wqsmSs2JslxXaOcXBwbpMXK9YA2XmqWO/Dho0IDQmYCT3haZCh0xeAvDi69Nc8BS817Pk=

Note: All the response codes of the transaction are available here.

The parameters are briefly described below:

Response Attributes

ATTRIBUTE DESCRIPTION
ORDERID OrderId pased in the request
Example: OREDRID_98765
MID Merchant ID passed in the request
Example: INTEGR7769XXXXXX9383
TXNID Unique reference number generated at paytm side for each transaction
Example: 202005081112128XXXXXX68470101509706
TXNAMOUNT Payment transaction Amount
Example: 1.00
CURRENCY Payment currency type
Example: INR
PAYMENTMODE Payment Mode used in payment
Example: DC
TXNDATE Transaction Date
Example: 7/24/2020
STATUS This parameter indicates the status of API call.
Example:TXN_SUCCESS
RESPCODE This is the resultCode corresponding to a particular message and is returned to the merchant. It's maximum length is 64. For list of different RESPCODE and RESPMSG please refer to the PDF.
Example: 01
RESPMSG This parameter is the result message which contains information about the result.
Example: Txn Success
GATEWAYNAME Gateway Name used in payment
Example: IICP
BANKTXNID Unique reference number generated at bank side for each transaction
Example: 77700XXXXX71013
BANKNAME Bank Name used in payment
Example: State Bank of India

feeRateFactors

FeeRateFactors

The fee factor DCC indicates that DCC fee/commission is applicable for the given international card transaction.

Note: For currency conversion flow only

CUSTID Unique reference ID for every customer which is generated by merchant. Special characters allowed in CustId are @, ! ,_ ,$, .
Example: Test101
MERC_UNQ_REF Merchant's reference text which is sent in the order's request
baseCurrency

Base currency used for currency conversion and is always INR.

Note: For currency conversion flow only

Example: INR

internationalCardPayment

Indicates if the transaction was completed using an international card (issued by a non-indian bank)

Note: For currency conversion flow only

Possible Values: true

TXNDATETIME Transaction Date and Time
Example: 7/24/2020 15:13:02

dccPaymentDetail

DccPaymentDetail

Details of the payment done through dcc

Note: For currency conversion flow only

 

DccPaymentDetail

ATTRIBUTE DESCRIPTION

dccId

There is an ID generated corresponding to each request by the bank.

Example: 41XXXX72

amountPerUnitForeignAmount

Exchange Rate = FC/INR

Example: 0.01

foreignCurrencyCode 3 letter currency code corresponding to a currency
Example: USD
foreignCurrencySymbol Currency symbol corresponding to the selected currency
Example: $
foreignPayableAmount

Total Amount paid in Foreign Currency (including markup)

Example: 0.01
foreignPaymentAmount Total Amount paid in Foreign Currency(excluding markup)
Example:0.01
foreignMarkupAmount Markup amount charged by a gateway from the user calculated by PG
Example: 0.46
foreignMarkupRatePercentage Markup % charged by a gateway from the user
Example: 0.5
expirationTimestamp Standard format timestamp for foreign exchange rate validity.
Example: 2021-02-12T18:48:03.733 05:30
isoForeignCurrencyCode 3 digit ISO Currency code corresponding to the selected currency
Example: 840
dccOffered

The flag indicates if the currency conversion option was selected by the customer

Possible Values: true, false

foreignCurrencyName

Currency name corresponding to the selected currency

Example: Dollar

 

FeeRateFactors

ATTRIBUTE DESCRIPTION
internationalCardPayment

Indicates if the transaction was completed using an international card (issued by a non-indian bank)

Possible Values: TRUE

dcc

Indicates if the transaction was completed using the dcc flow

Possible Values: TRUE, FALSE