Body
Block And Spam a Vpa
The api can be used to block or mark a collect request as spam.
Request
Response
API Endpoints
Production Link
POST
http://{{host}}/api/{uri}/merchants/vpas/blockAndSpam
Headers
Content-Type
*
string
Required
application/json
x-merchant-signature
*
string
Required
This is a signature over combination of headers, payload. Refer Signature Calculation section for more details.
x-merchant-id
*
string
Required
Will be shared while onboarding.
x-merchant-channel-id
*
string
Required
Will be shared while onboarding.
Accept
*
string
Required
application/json
x-timestamp
*
string
Required
This is an epoch unix timestamp string. For example, 1496918882000. It can be used by us to invalidate older requests.
Parameters
merchantCustomerId
*
String
Mandatory
Merchant generated unique profile id for customer
Constraint: Alphanumeric string with dot(.). Maximum length is 256.
upiRequestId
*
String
Mandatory
UPI request id of the collect request if requestType is TRANSACTION or mandateRequestId of the approve mandate request if requestType is MANDATE.
Constraint: 35 character alphanumeric
payeeVpa
*
String
Mandatory
Vpa that has to be blocked/spammed
requestType
*
String
Mandatory
Denotes the request type for which block and spam vpa is triggered
Values: TRANSACTION | MANDATE
shouldBlock
*
String
Mandatory
Boolean flag if the payee VPA has to be blocked
shouldSpam
*
String
Mandatory
Boolean flag if the payee VPA has to be marked as spam
udfParameters
Json String
Optional
Stringified JSON for udf parameters
200 : Success
Response Body
status
*
String
Mandatory
PSP status of the API
Values: SUCCESS | FAILURE
responseCode
*
String
Mandatory
PSP response code for the API
responseMessage
*
String
Mandatory
PSP response message for the API
payload
*
Json
Mandatory
merchantId
*
String
Mandatory
Unique id for the merchant as passed in request headers
merchantChannelId
*
String
Mandatory
Unique id for the merchant channel as passed in request headers
merchantCustomerId
*
String
Mandatory
Merchant generated unique profile id for customer as passed in the request
customerMobileNumber
*
String
Mandatory
Customer mobile number
Constraint: 12 digits mobile number string
payeeVpa
*
String
Mandatory
Vpa that is blocked/spammed for the customer
gatewayResponseStatus
*
String
Mandatory
Response status returned by gateway
Values: SUCCESS | FAILURE
gatewayResponseCode
*
String
Mandatory
Response code returned by the gateway for blocking/spamming the VPA
gatewayResponseMessage
*
String
Mandatory
Response message returned by the gateway for blocking/spamming the VPA
udfParameters
Json String
Optional
Udf parameters as passed in the request