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

Add UPI Beneficiary

Testing
POST
/Payout/Action/addBeneficiary

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 for the current request
beneficiary_name
string 
required
Name of the Beneficiary
beneficiary_type
string 
required
UPI
vpa
string 
required
VPA of the Beneficiary. e.g. "8750400900@airtel"
Example
{
  "username": "f68db941819657a1434b9bce0cd9811e",
  "password": "cabfc6c85d2c1ec57905d6f230784ca8",
  "requestid": "gLcirmfYKZB6y0HfTnJM",
  "beneficiary_name": "Test API Bene",
  "beneficiary_type": "UPI",
  "vpa": "8750400900@airtel"
}

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/addBeneficiary' \
--header 'Content-Type: application/json' \
--data-raw '{
    "username": "f68db941819657a1434b9bce0cd9811e",
    "password": "cabfc6c85d2c1ec57905d6f230784ca8",
    "requestid": "gLcirmfYKZB6y0HfTnJM",
    "beneficiary_name": "Test API Bene",
    "beneficiary_type": "UPI",
    "vpa": "8750400900@airtel"
}'

Responses

🟢200Add UPI Beneficiary
application/json
Body
Resp_code
string 
required
Resp_desc
string 
required
requestid
string 
required
data
object 
required
agent_id
string 
required
beneficiary_id
integer 
required
beneficiary_name
string 
required
beneficiary_account_number
string 
required
beneficiary_bank_name
string 
required
beneficiary_bank_ifsc
string 
required
beneficiary_account_type
string 
required
status
string 
required
added_on
string 
required
Example
{
  "Resp_code": "RCS",
  "Resp_desc": "Beneficiary Added Successfully",
  "requestid": "gLcirmfYKZB6y0HfTnJM",
  "data": {
    "agent_id": "US000001",
    "beneficiary_id": 15,
    "beneficiary_name": "Test API Bene",
    "beneficiary_account_number": "success",
    "beneficiary_bank_name": "BHIM (android & iOS)",
    "beneficiary_bank_ifsc": "@upi",
    "beneficiary_account_type": "VPA",
    "status": "ACTIVE",
    "added_on": "2023-10-05 13:01:31"
  }
}
🟢200Add UPI Beneficiary
Modified at 2025-04-10 11:26:13
Previous
Add NEFT/IMPS Beneficiary
Next
Delete Beneficiary
Built with