VyomPay
  1. Payout APIs
VyomPay
  • Introduction
  • Process Flow
  • Error Codes
  • Common APIs
    • Wallet Balance Check
      POST
  • Payout APIs
    • Add NEFT/IMPS Beneficiary
      POST
    • Add UPI Beneficiary
      POST
    • Delete Beneficiary
      POST
    • Get Beneficiary List
      POST
    • NEFT/IMPS Validate Beneficiary
      POST
    • Validate UPI Beneficiary
      POST
    • Payout Transaction Request
      POST
    • Direct Payout Transaction Request
      POST
    • Transaction Status
      POST
    • Transaction Status By Request ID
      POST
    • Payout Transaction Complain
      POST
    • Payout Callback
      POST
    • Virtual Account Wallet Credit Callback
      POST
    • Service Bank List
      POST
    • Service List
      POST
  • Payin APIs
    • Generate Merchant Payment Link
      POST
    • Generate Merchant PG Order
      POST
    • Generate Merchant UPI PG QR
      POST
    • Merchant UTR Process
      POST
    • Check Order Status
      POST
    • Payin Callback
      POST
  1. Payout APIs

Validate UPI Beneficiary

Testing
POST
/Payout/Action/validateBeneficiary

Request

Header Params
Content-Type
string 
required
Example:
application/json
Body Params application/json
username
string 
required
api_key
password
string 
required
api_secret
requestid
string 
required
A unique id referencing the current request
beneficiary_type
string 
required
UPI
vpa
string 
required
VPA of the Beneficiary. e.g. "8750400900@airtel"
Example
{
  "username": "********",
  "password": "********",
  "requestid": "R9qoe66WZ9r2vW8hlbOr",
  "beneficiary_type": "UPI",
  "vpa": "success@upi"
}

Request samples

Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request POST 'https://uat.nandishatech.com/WS/v1/Payout/Action/validateBeneficiary' \
--header 'Content-Type: application/json' \
--data-raw '{
    "username": "********",
    "password": "********",
    "requestid": "R9qoe66WZ9r2vW8hlbOr",
    "beneficiary_type": "UPI",
    "vpa": "success@upi"
}'

Responses

🟢200Validate UPI Beneficiary
application/json
Body
Resp_code
string 
required
Resp_desc
string 
required
requestid
string 
required
data
object 
required
benename
string 
required
opid
string 
required
txnid
string 
required
txn_status
string 
required
txn_desc
string 
required
date
string 
required
datetext
string 
required
commission
integer 
required
tds
number 
required
totalcharge
integer 
required
trasamt
integer 
required
chargedamt
integer 
required
Example
{
  "Resp_code": "RCS",
  "Resp_desc": "Transaction Failed, UPI is under Development",
  "requestid": "R9qoe66WZ9r2vW8hlbOr",
  "data": {
    "benename": "Validate Bene",
    "opid": "00",
    "txnid": "W231005145518XZH",
    "txn_status": "FAILED",
    "txn_desc": "Transaction Failed, UPI is under Development",
    "date": "2023-10-05 14:55:18",
    "datetext": "14:55:18 on 2023-10-05",
    "commission": 10,
    "tds": 0.5,
    "totalcharge": 4,
    "trasamt": 1,
    "chargedamt": 1
  }
}
🟢200Validate UPI Beneficiary
Modified at 2025-04-10 11:27:39
Previous
NEFT/IMPS Validate Beneficiary
Next
Payout Transaction Request
Built with