Sign in

v1

latestOpenAPI 3.1.02026-07-2418201.6 MB

VerifyPay (V3)

Validate a UPI VPA via a penny drop

post/v3/banking/verify_pay

Headers

client_idstring required
client_secretstring required
x_on_behalf_ofstring

Optional header that allows parent merchant to consume the API on behalf of sub-merchant.

content-typestring required

Indicates the type of the resource being sent in the body of an HTTP request

Request body

consumer_urnstring required

A unique identifier assigned to client's by Decentro during On-boarding.

is_consent_grantedboolean required

This flag will be used to capture the end-customers consent to proceed with the verification. Possible Values: true, false.

reference_idstring required

A unique ID assigned by you for this transaction

upi_vpastring required

UPI-ID (Virtual Payment Address) to be validated

purpose_messagestring

This parameter allows the platform to share a custom message that will be propagated to the end-customer. Minimum Length: 4 characters; Maximum Length: 50 characters

fetch_branch_detailsboolean

This flag can be used to fetch the details of the bank branch associated with the bank account. Possible Values: true, false.

perform_name_matchboolean

This flag can be used to perform a name match between the provided value and the account holders name received from their bank during the validation. Possible Values: true, false.

customer_namestring

The name of the end-customer as per the merchant records. Mandatory if perform_name_match is true.

Response

200

OR
OR
OR
OR

Example response

{
  "decentro_txn_id": "1FE0327430174A4E8B5780C6B779FA94",
  "api_status": "SUCCESS",
  "message": "Account details retrieved successfully",
  "data": {
    "upi_vpa": "8972241839@upi",
    "name_as_per_bank": "KAPIL DEV",
    "account_number": "XXXXXXX1983",
    "ifsc": "HDFC0000001",
    "account_type": "SAVINGS",
    "payout_status": "SUCCESS",
    "payout_amount": "1.00",
    "bank_reference_number": "0a3487327d724d1eb429393fb9c90c4d"
  },
  "response_key": "success_account_details_retrieved"
}