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

Send Money

This operation will enable customers to pay to other customers / VPAs by entering customer's upi id

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:- upiSendMoney

                      payType
                      *
                      

String

Mandatory

P2P_PAY / SCAN_PAY / INTENT_PAY / SELF_PAY

                      baseAmount
                      
                      

String

Conditional

This needs to be passed in respect to UPI-International. Amount in base currency (mandatory for static QR)

                      baseCurr
                      
                      

String

Conditional

This needs to be passed in respect to UPI-International. Base Currency (mandatory for static QR)

                      originalTransactionUpiRequestId
                      
                      

String

Optional

This needs to be passed in respect to UPI-International. upiRequestId as passed in upiInternationalValidateQr

Example:- Possible values: abcnndneienjkfnenkfnenk

                      customerVpa
                      *
                      

String

Mandatory

payer vpa - vpa of the person sending the money .

                      payeeVpa
                      *
                      

String

Mandatory

Payee Vpa. In case of transaction using bank account number and IFSC code it should be in the format - 009010100000132@axis0000029.ifsc.npci .

009010100000132 - account number

axis0000029 - ifsc

Example:- abc@axisbiz/009010100000132@axis0000029.ifsc.npci

                      payeeName
                      *
                      

String

Mandatory

Payee Name

                      upiNumber
                      
                      

String

Conditional

UpiNumber of payee. To be mandatorily sent if transaction is done to a UPI Number.

Example: 7200337777

                      amount
                      *
                      

String

Mandatory

Amount to be transfered. Numeric String with two decimals

                      upiRequestId
                      *
                      

String

Mandatory

request id for upi transaction

                      accountReferenceId
                      *
                      

String

Mandatory

Reference id of the selected account. Incase of lite account, reference id of the same as returned in getsessiontoken response

                      payeeAccountReferenceId
                      
                      

String

Conditional

Only required in SELF_PAY (Account reference Id for destination account of payee)

                      transactionReference
                      
                      

String

Conditional

Not required - in the case of P2P_PAY. In the case of SCAN_PAY (As received in the QR in tr parameter). INTENT_PAY - As received in the intent in tr parameter .

                      remarks
                      *
                      

String

Mandatory

Remarks sent for transaction

                      timestamp
                      *
                      

String

Mandatory

timestamp

                      refCategory
                      
                      

String

Optional

Not Required - P2P_PAY. For SCAN_PAY (As received in the QR in category parameter.) INTENT_PAY (As received in the intent in category parameter)

Example:- 00/01/02

                      refUrl
                      
                      

String

Optional

Not required - P2P_PAY. For SCAN_PAY (As received in the QR in url parameter.) INTENT_PAY (As received in the intent in url parameter)

                      currency
                      
                      

String

Optional

Not required - P2P_PAY. For SCAN_PAY (As received in the QR in cu parameter.) INTENT_PAY (As received in the intent in cu parameter).

Example:- INR

                      initiationMode
                      *
                      

String

Mandatory

Refer Initiation Mode table from NPCI linking specs document.

                      mcc
                      *
                      

String

Mandatory

Merchant category code as received in valid vpa response. In case not received in valid vpa response, 0000 to be passed.

                      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.

                      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