Sign in

v1

latestOpenAPI 3.0.02026-07-2431146358.7 KB
Validate VPA

Validate VPA

This API can be used to verify the VPA (Virtual Payment Address) for the upi payment method.

post/payments/ve1_2/upi/validatevpa

Headers

BD-Traceidstring required
Example:20201203182838

BD-TraceID is a unique identifier passed by the merchant to ensure request idempotency. Requests with identical BD-TraceID within a 24 hour window would fail.

BD-Timestampstring required
Example:20201203182838

Request timestamp to identify date and time of origin of request. Example, a value of BD-Timestamp 20210113180403 identifies the request to have originated on 13th January 2021 at 06:04:03 PM.

Content-Typestring required
Example:application/json

Request Content-Type to take the values application/jose

Acceptstring required
Example:application/jose

Accept Response Content-Type to take the values application/jose

Request body

mercidstring required

Unique identifier as defined by BillDesk for each merchant

orderid string required

Unique ID generated by the merchant for each request

payment_method_type 'upi' required

Represents the method of payment, will be fixed value upi

Example request

{
  "mercid": "BDMERCID",
  "orderid ": "TEST0000009005",
  "upi": {
    "vpa": "abc@okbank"
  }
}

Response

OK

objectid 'transaction' | 'authentication' | 'mandate' | 'invoice' | 'cardaccount' | 'validatevpa' | 'dispute' | 'settlement' | 'altid' | 'mandate_token' | 'accountvalidation'

String representing the object's type. Objects of the same type share the same value.

mercidstring

Unique identifier as defined by BillDesk for each merchant

orderidstring

Unique ID generated by the merchant for each request

payer_namestring

VPA account holder’s name

validation_status'success' | 'failed'

Validation Status

verification_error_codestring

Represents the error code for the response

verification_error_typestring

Represents the error type for the response

verification_error_descstring

Represents the error description for the response

createdonstring date-time

object creation timestamp

Example response

{
  "mercid": "BDMERCID",
  "orderid": "TEST0000009005"
}