Body
List Pending Collect Requests
This api returns list of all the pending collect requests for the customer.
Request
Response
API Endpoints
Production Link
POST
http://{{host}}/api/{{uri}}/merchants/transactions/listPending
Headers
Content-Type
*
string
Required
application/json
x-merchant-signature
*
string
Required
This is a signature over combination of headers, payload. Refer Signature Calculation section for more details.
Value: bypass
x-merchant-id
*
string
Required
Will be shared while onboarding.
x-merchant-channel-id
*
string
Required
Will be shared while onboarding.
Accept
*
string
Required
application/json
x-timestamp
*
string
Required
This is an epoch unix timestamp string. For example, 1496918882000. It can be used by us to invalidate older requests.
Parameters
merchantCustomerId
*
String
Mandatory
Merchant generated unique profile id for customer
Constraints : Alphanumeric string with dot(.). Maximum length is 256.
upiRequestId
String
Optional
Unique id sent to UPI switch for the transaction
Constraints : 35 character alphanumeric
upiResponseId
String
Optional
RRN of the transaction on which query is raised
Constraints : 12 digit numeric string
queryComment
String
optional
A comment specifying the query regarding the issue
Constraints : 0-255 characters alphanumeric
udfParameters
Json string
optional
Stringified JSON for udf parameters
200 : Success
Response Body
status
*
String
Mandatory
PSP status of the API
Values : SUCCESS, FAILURE
responseCode
*
String
Mandatory
PSP response code for the API
Values : Refer error code section
responseMessage
*
String
Mandatory
PSP response message for the API
Values : Refer error code section
payload
*
JSON
Mandatory
Callback data in appropriate format for the transactionType passed in the request. Refer Transaction API Callbacks section for more details.
merchantId
*
String
Mandatory
Unique id for the merchant as passed in request headers
merchantChannelId
*
String
Mandatory
Unique id for the merchant channel as passed in request headers
merchantCustomerId
*
String
Mandatory
Merchant generated unique profile id for customer as passed in the request
customerMobileNumber
*
String
Mandatory
Customer mobile number
Values : 12 digits mobile number string
pendingTransactions
Array of Json
payerVpa
*
String
Mandatory
VPA of payer.
Constraints: Valid VPA
payeeVpa
*
String
Mandatory
Vpa of the payee.
payeeName
String
Optional
Name of the Payee involved in mandate.
isVerifiedPayee
String
Optional
Flag if the payeeVpa is a verified vpa. It will be present if and only if gatewayResponseStatus is PENDING and mandateType is CREATE.
Values: true, false
isMarkedSpam
Optional
Flag if the payeeVpa is a verified vpa. It will be present if and only if gatewayResponseStatus is PENDING and mandateType is CREATE.
Values: true, false
amount
*
String
Mandatory
Amount for mandate
Values: Amount in two decimals. Decimals are mandatory
payeeMcc
*
String
Mandatory
Merchant Category Code of the payee merchant.
transactionTimestamp
*
String
Mandatory
Timestamp of when the transaction was attempted
Values: YYYY-MM-DDTHH:MM:SS+05:30
gatewayTransactionId
*
String
Mandatory
upiRequestId as passed in request
gatewayReferenceId
*
String
Mandatory
upiResponseId as passed in request
remarks
*
String
Mandatory
Any transaction summary
Constraints: 62 characters alphanumeric with hyphen
expiry
*
String
Mandatory
Expiry of the debit card
Constraints: String in format MMYY (pass 0149 for Maestro cards)
refUrl
String
optional
Reference url for the intent transaction
refCategory
String
optional
Details for refUrl, whether it is 01 (Advertisement), 02(Invoice)
collectType
String
optional
Differentiates between a transaction collect request (TRANSACTION) or a mandate execution collect request (MANDATE).
Constraints: TRANSACTION or MANDATE
seqNumber
String
optional
Denotes the recurring cycle of mandate execution. Will be received only during mandate executions.
udfParameters
JSON String
optional
Udf parameters as passed in the request