Body
Transaction Status 360
This api will be used for getting the status for P2M transaction and the response will be similar to callback response for the transactionType passed in the request.
Below are the possible values for transactionType
Scroll inside to view more
|
transactionType
|
Callback Type
|
|---|---|
MERCHANT_CREDITED_VIA_PAY
| Pay Callback (Incoming Money to Merchant)
|
MERCHANT_CREDITED_VIA_COLLECT
| Collect Callback (Incoming Money to Merchant)
|
2 columns 3 rows
Transaction Status responseCode
Scroll inside to view more
|
responseCode
|
HTTP
|
Meaning
|
|---|---|---|
REQUEST_NOT_FOUND
| 200
| This error will be given in case transaction was not created using any such merchantRequestId or upiRequestId
|
REQUEST_EXPIRED
| 200
| This error will be returned for user dropout based on sent expiry time during Register Intent.
|
DROPOUT
| 200
| Only given for UPI Plugin flow based on InApp SDK response [errorCode-errorMessage]
|
3 columns 4 rows
Request
Response
API Endpoints
Production Link
POST
{{host}}/api/{{uri}}/merchants/transactions/status360
Headers
jpupi-routing-id
*
String
Mandatory
For mandate execution related transactions, the Header value should be same as of originalMerchantRequestId sent in request body.
For any other transactions, the Header value should be same as of merchantRequestId sent in request body
Request Schema: application/json
Parameters
merchantRequestId
*
String
mandatory
merchantRequestId of the transaction whose status is to be checked.
transactionType
*
String
Mandatory
Type of transaction.
transactionTimestamp
String
Optional
Timestamp of the transaction. Passing this parameter will help PSP to optimize the status retrieval for the transaction.
Format: YYYY-MM-DDTHH:MM:SS+05:30
iat
*
String
Mandatory
Current Epoch Unix timestamp string. Has to be of 13 digit in Milliseconds.
Example: 1496918882000.
originalMerchantRequestId
String
Conditional
Merchant request of the original create mandate request.
udfParameters
Stringified JSON
Optional
Merchant Defined Parameters
Example: "{\"udf1\":\"value1\",\"udf2\":\"value2\",…}"
Note: Few special characters are not allowed. Regex for the characters which are not allowed : ^[^/#-()*!%~`]+$
For Dynamic VPA
upiRequestId
*
String
Mandatory
In case of dynamic Vpa resolution, pass this field.
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 Codes Guide in Resource Section.
responseMessage
*
String
Mandatory
PSP response message for the API.
Values: Refer Codes Guide in Resource Section.
Payload
*
Json String
Mandatory
amount
*
String
Mandatory
Amount for the payment.
Values: Amount in two decimals. Decimals are mandatory.
bankAccountUniqueId
*
String
Mandatory
Unique id for the selected bank account.
Values: As passed in the request.
bankCode
*
String
Mandatory
Bank code of the account which was used.
Value: Valid bank IIN.
customResponse
*
String
Mandatory
Stringified JSON parameter for future use.
gatewayPayerResponseCode
String
Optional
Response code returned by gateway.
gatewayPayeeResponseCode
String
Optional
Response code returned by gateway.
gatewayPayerReversalResponseCode
String
Optional
Response code returned by gateway.
gatewayPayeeReversalResponseCode
String
Optional
Response code returned by gateway.
gatewayReferenceId
*
String
Mandatory
Reference id returned by the gateway.
gatewayResponseCode
*
String
Mandatory
Response code returned by gateway.
gatewayResponseMessage
*
String
Mandatory
Response message for code returned by gateway.
gatewayResponseStatus
String
Optional
Response status returned by gateway.
gatewayTransactionId
*
String
Mandatory
Transaction id returned by gateway.
merchantId
*
String
Mandatory
Unique id for the merchant as passed in request headers.
orgMandateId
String
Optional
Refers to upiRequestId used during creation of mandate.
As passed for upiRequestId in the request.
payeeMcc
*
String
Mandatory
MCC code of the merchant.
payeeMerchantCustomerId
*
String
Mandatory
Merchant generated unique id for customer who received the payment. Only if it is an onus P2P transaction.
payeeVpa
*
String
Mandatory
Vpa of the upi user who received the payment.
payerName
String
Optional
Name of the payer to whom collect request was sent.
refUrl
*
String
Mandatory
Invoice as sent by merchant or reference to the transaction in the form of url.
riskScore
String
Optional
RiskScore shared by NPCI or Bank.
seqNumber
String
Optional
Denotes the recurring cycle of mandate execution. Will be received only during mandate executions. It will only be present in case of mandate request.
transactionTimestamp
*
String
Mandatory
Timestamp of when the payment was received.
Format: (YYYY-MM-DDTHH:MM:SS+05:30).
type
*
String
Mandatory
Event type of the transaction.
umn
String
Optional
Vpa used for execution of mandate.
merchantChannelId
*
String
Mandatory
Unique id for the merchant channel as passed in request headers.
merchantRequestId
*
String
Mandatory
Merchant generated unique id for collect request.
Constraint: Max 35 characters & Alphanumeric.
payerAccountHash
Array Of String
Conditional
As passed in the request body.
udfParameters
stringified JSON
Optional
Merchant Defined Parameters
Example: "{\"udf1\":\"value1\",\"udf2\":\"value2\",…}"