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

Collect Approve

This operation will enable customers to approve collect request

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

                      customerVpa
                      *
                      

String

Mandatory

If collectType is null or TRANSACTION, Vpa of the customer to be used for payment and if collectType is MANDATE, umn of the mandate.

                      payeeVpa
                      *
                      

String

Mandatory

Payee Vpa

                      payeeName
                      
                      

String

Optional

Payee Name

                      amount
                      *
                      

String

Mandatory

Amount to be transfered. Numeric String with two decimals

                      upiRequestId
                      *
                      

String

Mandatory

Request id for upi transaction which will be same as the gatewayTransactionId received in the upiListPendingTransactions response

                      accountReferenceId
                      *
                      

String

Mandatory

Reference id for selected accounts.For MandateCollect should be the same one which was used during Approving Mandate.

                      timestamp
                      *
                      

String

Mandatory

Current timestamp

                      merchantKeyId
                      *
                      

String

Mandatory

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

                      signature
                      *
                      

String

Mandatory

Signature generated for the signaturePayload

                      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

Currency to use

Example:- eg: INR

                      customer_phone
                      
                      

String

Optional

Mobile number

                      customer_email
                      
                      

String

Optional

                      collectType
                      
                      

String

Optional

Required for Mandate Collect Request. Values :- "MANDATE" or "TRANSACTION" (default)

Example:- MANDATE/TRANSACTION

                      udfParameters
                      
                      

String

Optional

Stringified json for udf parameters