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

Get Beneficiary List

Testing
POST
/Payout/Fetch/getBeneficiaryList

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
Example
{
    "username": "f68db941819657a1434b9bce0cd9811e",
    "password": "cabfc6c85d2c1ec57905d6f230784ca8",
    "requestid": "ki6yoNBVbIgjTZXqB7oF"
}

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/Fetch/getBeneficiaryList' \
--header 'Content-Type: application/json' \
--data-raw '{
    "username": "f68db941819657a1434b9bce0cd9811e",
    "password": "cabfc6c85d2c1ec57905d6f230784ca8",
    "requestid": "ki6yoNBVbIgjTZXqB7oF"
}'

Responses

🟢200Get Beneficiary List
application/json
Body
Resp_code
string 
required
Resp_desc
string 
required
data
object 
required
sender_id
string 
required
sender_name
string 
required
beneficiary_details
array [object {7}] 
required
Example
{
    "Resp_code": "RCS",
    "Resp_desc": "Request Completed Successfully",
    "data": {
        "sender_id": "US000001",
        "sender_name": "Test User",
        "beneficiary_details": [
            {
                "beneficiary_id": "1",
                "beneficiary_name": "Test Name",
                "beneficiary_account_number": "21830100001231",
                "beneficiary_bank_name": "INDIAN OVERSEAS TEST",
                "beneficiary_bank_ifsc": "IOBA0002183",
                "beneficiary_status": "ACTIVE",
                "beneficiary_type": "NEFT/IMPS"
            },
            {
                "beneficiary_id": "6",
                "beneficiary_name": "Test Bene",
                "beneficiary_account_number": "9632587410",
                "beneficiary_bank_name": "Paytm",
                "beneficiary_bank_ifsc": "@paytm",
                "beneficiary_status": "ACTIVE",
                "beneficiary_type": "UPI"
            },
            {
                "beneficiary_id": "8",
                "beneficiary_name": "Test UPI",
                "beneficiary_account_number": "9874563210",
                "beneficiary_bank_name": "BHIM (android & iOS)",
                "beneficiary_bank_ifsc": "@upi",
                "beneficiary_status": "ACTIVE",
                "beneficiary_type": "UPI"
            },
            {
                "beneficiary_id": "9",
                "beneficiary_name": "Test Bank",
                "beneficiary_account_number": "122345678963258741",
                "beneficiary_bank_name": "Test Bank",
                "beneficiary_bank_ifsc": "Test0001234",
                "beneficiary_status": "ACTIVE",
                "beneficiary_type": "NEFT/IMPS"
            },
            {
                "beneficiary_id": "10",
                "beneficiary_name": "Test Bene",
                "beneficiary_account_number": "7894561320yes",
                "beneficiary_bank_name": "Phonepay",
                "beneficiary_bank_ifsc": "@ybl",
                "beneficiary_status": "ACTIVE",
                "beneficiary_type": "UPI"
            },
            {
                "beneficiary_id": "11",
                "beneficiary_name": "Test Beneficiary",
                "beneficiary_account_number": "21301000002159",
                "beneficiary_bank_name": "INDIAN OVERSEAS TEST",
                "beneficiary_bank_ifsc": "IOBA0002183",
                "beneficiary_status": "ACTIVE",
                "beneficiary_type": "NEFT/IMPS"
            },
            {
                "beneficiary_id": "12",
                "beneficiary_name": "Ashutosh Upadhyay",
                "beneficiary_account_number": "109566016496",
                "beneficiary_bank_name": "Test Bank",
                "beneficiary_bank_ifsc": "DNSB0000021",
                "beneficiary_status": "ACTIVE",
                "beneficiary_type": "NEFT/IMPS"
            }
        ]
    }
}
🟢200Get Beneficiary List
Modified at 2025-04-10 11:26:49
Previous
Delete Beneficiary
Next
NEFT/IMPS Validate Beneficiary
Built with