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

Models

 

AsyncRefundResponse

Response object of refund API.

 

Properties

ATTRIBUTE DESCRIPTION

head

SecureResponseHeader

 Header information of secure response

body

AsyncRefundResponseBody

 Body information of refund response
 

AsyncRefundResponseBody

Object contains information related to specific refund.

 

Extends

BaseResponseBody

 

Properties

ATTRIBUTE DESCRIPTION

refundId

String

 Refund Id of the refund

mid

String

 Merchant Id

txnId

String

 Transaction Id

orderId

String

 Order Id of the payment

txnAmount

String

 Transaction Amount of the payment

refundAmount

String

 Amount to be refund

refId

String

 Reference id
 

BaseResponseBody

Object contains information common to all the API responses.

 

Extends

ExtraParameterMap

 

Properties

ATTRIBUTE DESCRIPTION

resultInfo

ResultInfo

 Object contains result information of the API call
 

ChildTransaction

Object contains information for child transactions in response of payment status call.

 

Properties

ATTRIBUTE DESCRIPTION

txnId

String

 Transaction id of the child transaction

paymentMode

String

 Payment Mode of the child transaction

txnAmount

String

 Transaction Amount of the child transaction

gateway

String

 Gateway used in child transaction

bankTxnId

String

 Bank transaction Id of the child transaction

bankName

String

 Bank Name of the child transaction

status

String

 Status of the child transaction

cardIndexNo

String

 Card Index No

maskedCardNo

String

 Masked Card No
 

ExtraParameterMap

Object contains extra information in API responses.

 

Properties

ATTRIBUTE DESCRIPTION

extraParamsMap

Map<String, Object>

 Map contains a key, value pairs to hold extra information
 

InitiateTransactionResponse

Response object of create transaction token API.

 

Properties

ATTRIBUTE DESCRIPTION

head

SecureResponseHeader

 Header information of secure response

body

InitiateTransactionResponseBody

 Body information of create transaction token response
 

InitiateTransactionResponseBody

Object containing token in the response of Create Transaction Token API.

 

Extends

BaseResponseBody

 

Properties

ATTRIBUTE DESCRIPTION

txnToken

String

 Transaction Token (Paytm security token) for a transaction. Valid for the 15 minutes

isPromoCodeValid

Boolean

 True if PromoCode is Valid

subscriptionId

String

 If this is a native_subscription request then subscription Id is returned

isAuthenticated

Boolean

 True if Authenticated

callbackUrl

String

 Callback Url where Paytm will send the async response
 

NativePaymentStatusResponse

Response object of payment status API.

 

Properties

ATTRIBUTE DESCRIPTION

head

SecureResponseHeader

 Header information of secure response

body

NativePaymentStatusResponseBody

 Body information on payment status response
 

NativePaymentStatusResponseBody

Object contains information related to specific Payment.

 

Extends

BaseResponseBody

 

Properties

ATTRIBUTE DESCRIPTION

txnId

String

 Transaction id of the payment

bankTxnId

String

 Bank transaction id from the bank

orderId

String

 Order Id of the payment

txnAmount

String

 Payment transaction Amount

txnType

String

 Transaction Type of the payment

gatewayName

String

 Gateway Name used in payment
bankNameString Bank Name used in payment
midString Merchant Id

paymentMode

String

 Payment Mode used in payment

refundAmt

String

 Refund Amount of the payment

txnDate

String

 Transaction Date
 

NativeRefundStatusResponse

Response object of refund status API.

 

Properties

ATTRIBUTE DESCRIPTION

head

SecureResponseHeader

 Header information of secure response

body

NativeRefundStatusResponseBody

 Body information on refund status response
 

NativeRefundStatusResponseBody

Object contains status information related to specific refund.

 

Extends

BaseResponseBody

 

Properties

ATTRIBUTE DESCRIPTION

txnId

String

 This is a unique Paytm transaction Id that is issued by Paytm for each valid transaction request received from the merchant

orderId

String

 This is the application transaction Id that was sent by merchant to Paytm at the time of transaction request

txnAmount

String

 The amount of the transaction
midString This is a unique merchant Id provided to merchant by Paytm at the time of merchant creation refundAmount - Refund amount as received in the request

refundAmount

String

 Refund Amount

txnDate

String

 Date of transaction

totalRefundedAmount

String

 Total amount refunded till now if merchant has raised any requests

refundDate

String

 Date of refund

refId

String

 This is reference ID shared while raising Refund

bankTxnId

tring

 The transaction Id sent by the bank (NULL or empty string if the transaction doesn't reaches to the bank)

txnType

String

 Transaction Type of Payment

gatewayName

String

 The gateway used by Paytm (ICICI/CITI/WALLET etc)

bankName

String

 The bank used by Paytm

paymentMode

String

 Mode of Payment

refundId

String

 Unique refund id generated at Paytm end

refundType

String

 Type of Refund Issued

ssoId

String

 Paytm User Id
 

PaymentDetail

Request object of create transaction token SDK function.

 

Properties

ATTRIBUTE DESCRIPTION MANDATORY  

channelId

EChannelId

 Channel through which call initiated Yes  

orderId

String

 Unique order for each order request Yes  

txnAmount

Money

 Transaction amount and the currency value Yes  

userInfo

UserInfo

 User information contains user details Yes  

paytmSsoToken

String

 Paytm Token for a user Optional  

enablePaymentMode

List<PaymentMode>

 List of the payment modes which needs to enable Optional  

disablePaymentMode

List<PaymentMode>

 List of the payment modes which needs to disable Optional  
goodsList<GoodsInfo> List of the Goods information for an order Optional  

shippingInfo

List<ShippingInfo>

 List of the shipping information for an order Optional  

promoCode

String

 Promo code value that needs to apply during a transaction Optional  

extendInfo

ExtendInfo

 This contains the set of parameters for some additional information Optional  

emiOption

String

 Merchant can send Emi Option like 0CostEMI:<BankId>_<Id>, for e.g: 0CostEMI:8565563_764 Optional  

cardTokenRequired

String

 If true then Card Index number will be provided to the merchant for the card through which payment has been done Optional  

readTimeout

Time

 Read TimeOut for Payment API Optional  
 

PaymentStatusDetail

Request object of payment status SDK function.

 

Properties

ATTRIBUTE DESCRIPTION MANDATORY

orderId

String

 Unique order for each order request Yes

readTimeout

Time

 Read TimeOut for Payment API Optional
 

RefundDetail

Request object of initiate refund SDK function.

 

Properties

ATTRIBUTE DESCRIPTION MANDATORY  

orderId

String

 Unique order for each order request Yes  

refId

String

 REF ID returned in Payment call Yes  

txnId

String

 Transaction ID returned in Payment API Yes  

txnType

String

 Transaction Type returned in Payment API Yes  

refundAmount

String

 Refund Amount to be refunded Yes  

comments

String

 Comments merchant want to add in a refund Optional  

subwalletAmount

Map<UserSubWalletType, BigDecimal>

 Used when merchant want refund hybrid transaction in which some amount will be refunded in sub-wallet such as FOOD, GIFT etc Optional  

extraParamsMap

Map<String, Object>

 Map contains a key, value pairs to hold extra information Optional  

readTimeout

Time

 Read TimeOut for Payment API Optional  
 

RefundStatusDetail

Request object of get refund status SDK function.

 

Properties

ATTRIBUTE DESCRIPTION MANDATORY

orderId

String

 Unique order for each order request Yes

refId

String

 Unique refId for each refund request Yes

readTimeout

Time

 Read TimeOut for Payment API Yes
 

ResponseHeader

Header information common to all response.

 

Properties

ATTRIBUTE DESCRIPTION

responseTimestamp

String

 Response Time stamp value

version

String

 Version value
 

ResultInfo

Object contains information related to API result.

 

Properties

ATTRIBUTE DESCRIPTION Mandatory

resultCode

String

 Result code returned to the merchant. Max length of result code can be 64 Yes

resultStatus

String

 Status of API call
(S:Success, F:Failure, U:Unknown)		 Yes

resultMsg

String

 Result Message contains information about the result. Yes

isRedirect

Boolean

 True, if Redirected No
 

SDKResponse

Object returned from all SDK function calls.

 

Properties

ATTRIBUTE DESCRIPTION MANDATORY

responseObject

String

 Generic object for API Responses (NativeRefundStatusResponse, AsyncRefundResponse, NativePaymentStatusResponse, InitiateTransactionResponse) Yes

jsonResponse

String

 Response returned from paytm as json string Yes
 

SecureResponseHeader

Object containing information of secure response.

 

Extends

ResponseHeader

 

Properties

ATTRIBUTE DESCRIPTION  

clientId

String

 clientId by which key checksum is created, required to validate the checksum  

signature

String

 Checksum string created by Paytm from response parameters
 

Time

Object containing information of time out.

 

Properties

ATTRIBUTE DESCRIPTION MANDATORY

value

long

 Value of time Yes

unit

TimeUnit

 Unit of Time Yes
 

UserInfo

Object contains information related to the customer to be given in the request to create transaction token API.

 

Properties

ATTRIBUTE DESCRIPTION MANDATORY

custId

String

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

mobile

String

 10-digit mobile number of the user. No

email

String

 Valid email of the user No

firstName

String

 First name of the user. No

lastName

String

 Last name of the user. No

address

String

 Address of the user. No

pincode

String

 Pincode of the user. No

displayName

String

 Display name of the user. No

 

 

Money

Object contains information of transaction amount to be given in the request to create transaction token API.

 

Properties

ATTRIBUTE DESCRIPTION MANDATORY

currency

EnumCurrency(INR)

 The currency of transaction amount. Yes

value

String (regexp = [0-9]+([.][0-9]{1, 2})?, length less than 16 characters)

 Transaction value up to two decimal Yes
 

ShippingInfo

Object contains shipping info for an order which is used in create transaction token API.

 

ATTRIBUTE DESCRIPTION MANDATORY

merchantShippingId

String

 Merchant shipping id Yes

trackingNo

String

 Tracking no of shipment No

carrier

String

 Shipping carrier name No

chargeAmount

Money

 Shipping amount No

countryName

String

 Shipping country name Yes

stateName

String

 Shipping state Yes

cityName

String

 Shipping city Yes

address1

String

 Shipping address 1 Yes

address2

String

 Shipping address 2 No

firstName

String

 Receiver first name Yes

lastName

String

 Receiver last name Yes

mobileNo

String

 Receiver mobile no No

zipCode

String

 Receiver zip code Yes

email

String

 Receiver email No
 

GoodsInfo

ATTRIBUTE DESCRIPTION MANDATORY

merchantGoodsId

String

 Unique id for the goods item (item no) Yes

merchantShippingId

String

 Shipping Id No

snapshotUrl

String

 Product Image URL No

description

String

 Description of product Yes

category

String

 Category of Product Yes

quantity

String

 Quantity ordered Yes

unit

String

 Unit of quantity (KG/Litre) No

price

Money

 Price of product Yes

extendInfo

ExtendInfo

 Extended info of goods No
 

PaymentMode

Object contains payment mode and its asociated channel which is used in create transaction token API.

 

ATTRIBUTE DESCRIPTION MANDATORY

mode

String

 Mode of Payment:
  1. PAYTM_DIGITAL_CREDIT: Paytm postpaid
  2. CREDIT_CARD: credit card
  3. DEBIT_CARD: debit card
  4. NET_BANKING: net banking
  5. UPI: BHIM UPI
  6. PPBL: Paytm payments bank
  7. BALANCE: Paytm wallet
  8. EMI: EMI options
 No

channels

array

 Channel associated with mode like:
  1. CREDIT_CARD/ DEBIT_CARD: VISA MASTER
  2. NET_BANKING: SBI,PNB,HDFC,ICICI
 No
 

ExtendInfo

Object contains any order specific information which is used in create transaction token API.

 

ATTRIBUTE DESCRIPTION MANDATORY

udf1

String

 User define parameter 1 No

udf2

String

 User define parameter 2 No

udf3

String

 User define parameter 3 No

mercUnqRef

String

 User define parameter 4 No

comments

String

 Comments No