Validate UPI VPA [v3]

This API can be used to validate the UPI ID or VPA (Virtual Payment Address). This should be validated before placing a collect UPI request as invalid UPI IDs will fail. The API will return the validity of the UPI ID shared and also provide the Account Holder Name of the valid UPI ID.

application/json

Request Body required

upi_id string required

Possible values: Value must match regular expression [a-zA-Z0-9.\-_]{2,256}@[a-zA-Z]{2,64}

This is the UPI ID of the customer that needs to be validated

Responses

• 200
• 4XX
• 5XX

---

When the UPI ID has been validated, the response will be as below

application/json

Schema

Example (from schema)

---

Schema

oneOf

success-validate-vpa-response

failed-validate-vpa-response

---

status string

Possible values: [SUCCESS]

This value will be returned as SUCCESS

vpa string

This is the UPI ID shared in the request

isVPAValid integer

Possible values: [1]

The valid UPI ID will return a value of 1

payerAccountName string

The name of the account holder who has this UPI ID

isVPAValid integer

Possible values: [0]

The invalid UPI ID will return a value of 0

{}

When the UPI ID cannot be validated, the response will be as below

application/json

Schema

Example (from schema)

---

Schema

error object

nimbbl_error_code string

This is the error_code generated by Nimbbl

nimbbl_consumer_message string

This is a customer friendly message that can be displayed to your consumer

nimbbl_merchant_message string

This explains to your team how to recover from the error

{
  "error": {
    "nimbbl_error_code": "INVALID_REQUEST_PARAMETER",
    "nimbbl_consumer_message": "Sorry, your payment cannot be processed due to a technical error. Please try again after some time.",
    "nimbbl_merchant_message": "There is an input validation error, please check the payload of your request."
  }
}

When there is a problem on the server, the response will be as below

application/json

Schema

Example (from schema)

---

Schema

error object

nimbbl_error_code string

This is the error_code generated by Nimbbl

nimbbl_consumer_message string

This is a customer friendly message that can be displayed to your consumer

nimbbl_merchant_message string

This explains to your team how to recover from the error

{
  "error": {
    "nimbbl_error_code": "INVALID_REQUEST_PARAMETER",
    "nimbbl_consumer_message": "Sorry, your payment cannot be processed due to a technical error. Please try again after some time.",
    "nimbbl_merchant_message": "There is an input validation error, please check the payload of your request."
  }
}

Loading...