Request Parameters

Parameter NameTypeDescriptionMandatory
sizeintegerNo. of txn to be shownYes
qrCodeIdstringQrCodeId to be passed against which payment was madeYes
amountlongAmount in paisaYes
last4DigitsstringLast 4 digits of PhonePe txnid. If payment was made by the external apps then last 4 digits of utr no./reference idNo
startTimestamplongTime in millisecondsNo

Response Paramters

Parameter NameTypeDescription
successBooleanSuccess status of the request
codeEnumStatus Codes of request
messageStringShort message about code
dataJSON ObjectData JSON Object

Data JSON Object

Parameter NameTypeDescription
resultCountIntegercount of the transactions found in the list
startTimestamplongtimestamp from which the transactions are fetched
endTimestamplongtimestamp till which the transactions are fetched
qrCodeIdStringQR code Id passed in the transaction request
transactionsArray objectTransaction array object

Transaction Array Object

Parameter NameTypeDescription
transactionIdStringUnique TransactionID generated by the merchant to track request to PhonePe
transactionId length should be less than 38 characters
providerReferenceIdStringPhonePe ReferenceId
amountLongTransaction amount in paise
paymentStateStringPlease ignore this. Use "code" parameter to get latest status of transaction
transactionDatelongTransaction timestamp
payResponseCodeStringPhonePe internal status code. Please note this is a string value and new codes are likely to be added in the future. (Please don't do the marshalling/unmarshalling into an enum for this at your side). This is an informative value
mobileNumberStringMasked mobile number of the user
phoneNumberStringMasked phone number of the user
nameStringName of the customer
paymentModesJSON ObjectPaymentModes JSON Object
transactionContextJSON ObjectTransactionContext JSON Object

PaymentModes JSON Object

Parameter NameTypeDescription
typeStringPayment instrument used for transaction
amountLongAmount in paisa

TransactionContext JSON Object

Parameter NameTypeDescription
qrCodeIdStringQR code Id against which payment is made
posDeviceIdStringpos Device Id against which payment is made
storeIdStringStore Id against which payment is made
terminalIdStringTerminal Id against which payment is made
Click Try It! to start a request and see the response here!