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 status of a transaction.

Process Parameters

Request

Response

                      requestId
                      *
                      

String

Mandatory

Unique uuid-v4 string

Example: abcd-12345-abcd-12345

                      service
                      *
                      

String

Mandatory

Value: in.juspay.hyperapi

                      payload
                      *
                      

JSON

Mandatory

Parameters required to call Hyper SDK API

                      action
                      *
                      

String

Mandatory

Operation to be performed in the SDK

Example:- upiTxnStatus

                      upiRequestId
                      *
                      

String

Mandatory

Unique identifier (uuid) for the request sent to NPCI

                      transactionType
                      *
                      

String

Mandatory

Example:- CUSTOMER_DEBITED_VIA_PAY

vpa

String

Optional

Payer Vpa

Example: abc@xyz

                      merchantKeyId
                      *
                      

String

Mandatory

Key ID to identify the public-private key pair used for signature generation.

                      signature
                      *
                      

String

Mandatory

Base 64 encoding of signaturePayload and Protected .

                      protected
                      *
                      

String

Mandatory

Base 64 encoding of the below parameters.

                      kid
                      *
                      

String

Mandatory

Key ID to identify the public-private key pair used for signature generation.It will be provided to you by the Juspay team.

Example: uat833359804655bb748702e324111

                      Alg
                      *
                      

String

Mandatory

Asymmetric algorithm used. Will be RS256 in this case..

Example:- RS256

                      signaturePayload
                      *
                      

String

Mandatory

Signature payload is a stringified JSON of the details mentioned in the below table.

                      merchantCustomerId
                      *
                      

String

Mandatory

Merchant generated unique profile id for the customer.

                      merchantId
                      *
                      

String

Mandatory

Unique identifier associated with an account created by juspay.Ex: stock

                      merchantChannelId
                      *
                      

String

Mandatory

As provided by Juspay.

                      timestamp
                      *
                      

String

Mandatory

Time when request is created in milliseconds.

                      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