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

Request Money

This operation will enable customers to request money from other UPI users

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

                      customerVpa
                      *
                      

String

Mandatory

Customer Vpa

                      payerVpa
                      *
                      

String

Mandatory

Payer Vpa. In case of UPI Number, you can get the VPA using valid VPA process

                      payerName
                      *
                      

String

Mandatory

Payer Name

                      collectRequestExpiryMinutes
                      
                      

String

Optional

Duration after which collect request will become invalid. Default: 30

Example:- eg : 15

                      amount
                      *
                      

String

Mandatory

Amount to be transfered. Numeric String with two decimals

                      accountReferenceId
                      *
                      

String

Mandatory

reference id for selected accounts

                      remarks
                      *
                      

String

Mandatory

Remarks of transaction

                      upiRequestId
                      *
                      

String

Mandatory

Request id for upi transaction

                      timestamp
                      *
                      

String

Mandatory

Time when request is created in milliseconds

                      upiNumber
                      
                      

String

Optional

If request is to be sent to UPI Number

                      merchantKeyId
                      *
                      

String

Mandatory

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

                      signature
                      *
                      

String

Mandatory

Signature generated for the signaturePayload

Example:-

                      signaturePayload
                      *
                      

String

Mandatory

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

                      merchant_id
                      *
                      

String

Mandatory

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

                      customer_id
                      *
                      

String

Mandatory

Any unique reference associated with your customer.

                      timestamp
                      *
                      

String

Mandatory

Time when request is created in milliseconds.

                      amount
                      *
                      

String

Mandatory

Amount to be paid. Numeric String with two decimals

Example:- eg: 2.00

                      currency
                      
                      

String

Optional

Example:- eg: INR

                      customer_phone
                      
                      

String

Optional

Mobile number

                      customer_email
                      
                      

String

Optional