JavaScript is disabled. Some features may not work. You can also read the static version: View text version

Transaction Status

This api will be used for getting the status for both P2P and 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

For hitting the request only one param is mandatory out of upiRequestId or merchantRequestId.

Scroll inside to view more

transactionType	Callback Type
CUSTOMER_CREDITED_VIA_PAY	Incoming Money to Customer - Pay
CUSTOMER_CREDITED_VIA_COLLECT	Incoming Money to Customer - Collect Status
CUSTOMER_DEBITED_FOR_MERCHANT_VIA_PAY	Outgoing Money from a Customer
CUSTOMER_DEBITED_VIA_PAY	Outgoing Money from a Customer
CUSTOMER_DEBITED_FOR_MERCHANT_VIA_COLLECT	Outgoing Money from a Customer
CUSTOMER_DEBITED_FOR_VIA_COLLECT	Outgoing Money from a Customer
COLLECT_REQUEST_SENT	Outgoing Collect Request from Customer

Request

Response

API Endpoints

Production Link

POST

http://{{host}}/api/{uri}/merchants/transactions/status360

                      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.

                      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.

Body

                      upiRequestId
                      
                      

String

Conditional

Request id of the transaction whose status is to be checked.

Constraints : 35 character alphanumeric unique id.

                      merchantRequestId
                      
                      

String

Conditional

Merchant generated id for the transaction.

                      transactionType
                      *
                      

String

Mandatory

Type of transaction

                      transactionTimestamp
                      
                      

String

optional

Timestamp of the upiRequestId as returned by PSP

Constraints : (YYYY-MM-DDTHH:MM:SS+05:30)

                      checkWithUdir
                      
                      

String

optional

Boolean flag for UDIR status check

                      udfParameters
                      
                      

Json String

optional

Stringified JSON for udf parameters

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.

                      amount
                      *
                      

String

Mandatory

Amount for the payment
As passed in the request

                      bankAccountUniqueId
                      *
                      

String

Mandatory

Unique id for the selected bank account
As passed in the request

                      bankCode
                      *
                      

String

Mandatory

Bank code of the account which was used
Valid bank IIN

                      customResponse
                      *
                      

String

Mandatory

Stringified JSON parameter for future use.

                      gatewayPayerResponseCode
                      *
                      

String

Mandatory

Response code returned by gateway

                      gatewayPayeeResponseCode
                      *
                      

String

Mandatory

Response code returned by gateway

                      gatewayPayerReversalResponseCode
                      *
                      

String

Mandatory

Response code returned by gateway

                      gatewayPayeeReversalResponseCode
                      *
                      

String

Mandatory

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

Mandatory

Response status returned by gateway

                      gatewayTransactionId
                      *
                      

String

Mandatory

Transaction id returned by gateway

                      maskedAccountNumber
                      *
                      

String

Mandatory

Masked account number of the account which was used
XXXX123456

                      merchantCustomerId
                      *
                      

String

Mandatory

Merchant generated unique profile id for customer as passed in the request

                      merchantId
                      *
                      

String

Mandatory

Unique id for the merchant as passed in request headers

                      orgMandateId
                      *
                      

String

Mandatory

Refers to upiRequestId used during creation of mandate
As passed for upiRequestId in the request.

                      payeeMcc
                      *
                      

Numeric

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.

                      payeeMobileNumber
                      *
                      

String

Mandatory

Mobile number of the customer who received the payment.

                      payeeVpa
                      *
                      

String

Mandatory

Vpa of the upi user who received the payment.

                      payerMerchantCustomerId
                      *
                      

String

Mandatory

                      payerName
                      *
                      

String

Mandatory

Merchant generated unique id for customer who received the collect request. Only if it is an onus transaction.

                      payerVpa
                      *
                      

String

Mandatory

Vpa of the customer who sent the payment.

                      refUrl
                      *
                      

String

Mandatory

Invoice as sent by merchant or reference to the transaction in the form of url.

                      riskScore
                      *
                      

String

Mandatory

RiskScore shared by NPCI or Bank

                      seqNumber
                      *
                      

String

Mandatory

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. (YYYY-MM-DDTHH:MM:SS+05:30)

                      transactionType
                      *
                      

String

Mandatory

P2M_PAY, P2P_PAY, SCAN_PAY, INTENT_PAY, P2PM_PAY, SELF_PAY, LITE_PAY, INTERNATIONAL_PAY

                      type
                      *
                      

String

Mandatory

Event type of the transaction.

                      umn
                      *
                      

String

Mandatory

Vpa used for execution of mandate.

                      udfParameters
                      
                      

json String

optional

Udf parameters as passed in the request.