Transaction List API

UAT Endpoints:
POST https://mercury-uat.phonepe.com/enterprise-sandbox/v3/qr/transaction/list

Prod Endpoints:
POST https://mercury-t2.phonepe.com/v3/qr/transaction/list

Sample Payload for Base64

{
"size": 10,
"merchantId": "MERCHANTSQRUAT",
"storeId": "teststore1",
"amount": 200
}

Request Headers

Header Name	Header Value
Content-Type	application/json
`X-VERIFY`	SHA256(base64 encoded payload + “/v3/qr/transaction/list” + salt key) + ### + salt index
`X-PROVIDER-ID`	Used for the cases where the merchant has multiple merchant IDs

Request Parameters

Parameter Name	Type	Description	Mandatory
size	integer	No. of txn to be shown	Yes
merchantId	string	Unique Merchant ID assigned to the merchant by PhonePe	Yes
storeId	string	Unique Store ID assigned to the merchant by PhonePe	Yes
amount	long	Amount in paisa	No
last4Digits	string	Last 4 digits of PhonePe txnid. If payment was made by the external apps then last 4 digits of utr no./reference id	No
qrCodeId	string	QR code Id against which payment is made	No
terminalId	string	Terminal Id against which payment is made	No
startTimestamp	long	Time in milliseconds	No

Sample Response

{
  "success": true,
  "code": "SUCCESS",
  "message": "Yourrequest has been successfully completed.",
  "data": {
    "resultCount": 1,
    "startTimestamp": 1614079349293,
    "endTimestamp": 1614079349293,
    "transactions": [
      {
        "transactionId": "TXSCAN2102231651587876998585",
        "providerReferenceId": "T2102231652258076998155",
        "amount": 100,
        "paymentState": "PAYMENT_SUCCESS",
        "transactionDate": "2021-02-23 16:52:27.611",
        "payResponseCode": "SUCCESS",
        "paymentModes": [
          {
            "type": "WALLET",
            "amount": 100
          }
        ],
        "transactionContext": {
          "qrCodeId": "Q06417857",
          "posDeviceId": null,
          "storeId": "MS1906251249399153698572",
          "terminalId": "MST1906251250336133698174"
        },
        "mobileNumber": "94XXXXX987",
        "phoneNumber": "94XXXXX987",
        "name": "Shankhajyoti"
      }
    ]
  }
}

Response Parameters

Parameter Name	Type	Description	Sample Value
success	Boolean	Success status of the request	TRUE
code	Enum	Status Codes of request	SUCCESS
message	String	Short message about code	Your request has been successfully completed.
data	JSON Object	Data JSON Object	Data JSON Object

Data JSON Object

Parameter Name	Type	Description	Sample Value
resultCount	Integer	count of the transactions found in the list	1
startTimestamp	long	timestamp from which the transactions are fetched	1614079349293
endTimestamp	long	timestamp till which the transactions are fetched	1614079349293
qrCodeId	String	QR code Id passed in the transaction request	Q06417857
transactions	Array object	Transaction array object	Transaction array object

Transaction Array Object

Parameter Name	Type	Description	Sample Value
transactionId	String	Unique TransactionID generated by the merchant to track request to PhonePe transactionId length should be less than 38 characters	TXSCAN2102231651587876998585
providerReferenceId	String	PhonePe ReferenceId	T2102231652258076998155
amount	Long	Transaction amount in paise	100
paymentState	String	Please ignore this. Use “code” parameter to get latest status of transaction	PAYMENT_SUCCESS
transactionDate	long	Transaction timestamp	52:27.6
payResponseCode	String	PhonePe 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	SUCCESS
mobileNumber	String	Masked mobile number of the user	Shankhajyoti
phoneNumber	String	Masked phone number of the user	94XXXXX987
name	String	Name of the customer	Shankhajyoti
paymentModes	JSON Object	PaymentModes JSON Object	PaymentModes JSON Object
transactionContext	JSON Object	TransactionContext JSON Object	TransactionContext JSON Object

PaymentModes JSON Object

Parameter Name	Type	Description	Sample Value
type	String	Payment instrument used for transaction	WALLET
amount	Long	Amount in paisa	100

TransactionContext JSON Object

Parameter Name	Type	Description	Sample Value
qrCodeId	String	QR code Id against which payment is made	Q06417857
posDeviceId	String	pos Device Id against which payment is made	null
storeId	String	Store Id against which payment is made	MS1906251249399153698572
terminalId	String	Terminal Id against which payment is made	MST1906251250336133698174