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

List Blocked Vpa

This api will be used to list all the VPAs that were blocked so far by the customer.

Request

Response

API Endpoints

Production Link

POST

http://{{host}}/api/{uri}/merchants/vpas/block/list

                      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.

Body

                      merchantCustomerId
                      *
                      

String

Mandatory

Merchant generated unique profile id for customer

Constraint: Alphanumeric string with dot(.). Maximum length is 256.

                      limit
                      *
                      

String

Mandatory

Maximum number of rows to be returned. Used for pagination

Constraint: Number > 0

                      offset
                      *
                      

String

Mandatory

Offset for rows to be returned. Used for pagination

Constraint: Number >= 0

                      udfParameters
                      
                      

Json String

Optional

Stringified JSON for udf parameters

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 as per device binding

Constraint: 12 digits mobile number

                      blockedVpas
                      *
                      

Array of json

Mandatory

                      payeeVpa
                      *
                      

String

Mandatory

Vpa that is blocked for the customer

                      name
                      *
                      

String

Mandatory

Name associated with the vpa that is blocked for the customer

                      blockedAt
                      *
                      

String

Mandatory

Timestamp of when the vpa was blocked by the customer.

Constraint: YYYY-MM-DDTHH:MM:SS+05:30

                      udfParameters
                      
                      

json String

optional

Udf parameters as passed in the request

Have questions?
Need help? Contact support
LLM? Read llms.txt