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

UPI Collect Mandate transactions

Verify VPA

UPI Txn - Collect

UPI Collect mandate transactions happen through the webcollect flow, wherein the user enters his VPA and receives a collect mandate register request notification from the corresponding UPI PSP app. On approving the request, mandate will be registered and auto debit occurs every cycle.

Payload Parameters

                      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

Must be upiTxn for UPI Process calls.

                      orderId
                      *
                      

String

Mandatory

order id pertaining to the order for which the payment is started.

                      custVpa
                      *
                      

String

Mandatory

Customer VPA to which the collect request must be sent.

                      clientAuthToken
                      *
                      

String

Mandatory

Required for client side authentication

                      shouldCreateMandate
                      *
                      

Boolean

Mandatory

This is a customer’s consent flag. This should be always TRUE in case of a mandate transaction.

                      offers
                      
                      

Array of Strings

The key offers should be passed only when juspay offers are being used. The value for this key can set as the offerID which is received from /v1/offers/list api