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

Unblock Vpa

This api will be used to unblock a vpa which was blocked earlier by the customer.

Request

Response

API Endpoints

Production Link

POST

http://{{lhost}}/api/{uri}/merchants/vpas/unblock

                      Content-Type
                      *
                      

string

Required

application/json

                      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.

                      x-merchant-signature
                      *
                      

string

Required

This is a signature over combination of headers, payload. Refer Signature Calculation section for more details.

Body

                      merchantCustomerId
                      *
                      

String

Mandatory

Merchant generated unique profile id for customer

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

                      payeeVpa
                      *
                      

String

Mandatory

Vpa that is to be unblockedString

                      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

Constraint: 12 digits mobile number string

                      payeeVpa
                      *
                      

String

Mandatory

Vpa that is unblocked for the customer

                      gatewayResponseStatus
                      *
                      

String

Mandatory

Response status returned by gateway

Values: SUCCESS | FAILURE

                      gatewayResponseCode
                      *
                      

String

Mandatory

Response code returned by the gateway for unblocking the VPA

                      gatewayResponseMessage
                      *
                      

String

Mandatory

Response message returned by the gateway for unblocking the VPA

                      udfParameters
                      
                      

Json String

Optional

Udf parameters as passed in the request