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

Block/Spam Vpa

The merchant can call this API to block a vpa or to mark it as spam.

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

                      upiRequestId
                      *
                      

String

Mandatory

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

                      payeeVpa
                      *
                      

String

Mandatory

Vpa to be blocked or marked as spam

                      shouldBlock
                      
                      

String

Madnatory

Should be true for block request

Example:- true/false

                      shouldSpam
                      *
                      

String

Mandatory

Should be true for spam request

Example:- true/false

                      merchantKeyId
                      *
                      

String

Mandatory

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

                      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.

                      signature
                      *
                      

String

Mandatory

Signature generated for the signaturePayload

                      requestType
                      
                      

String

Optional

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

                      udfParameters
                      
                      

String

Optional

Stringified json for udf parameters