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

Payout Transaction Request

Testing
POST
/Payout/Action/initiatePayoutTransaction

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_id
string 
required
Beneficiary id shared by us when you added the Beneficiary. e.g. 16
payment_mode
string 
required
"IMPS", "NEFT", or "UPI"
amount
string 
required
Amount of the payout
Example
{
  "username": "f68db941819657a1434b9bce0cd9811e",
  "password": "cabfc6c85d2c1ec57905d6f230784ca8",
  "requestid": "xaJ0xvhpmvpo0il8zQkiG5",
  "beneficiary_id": "36",
  "payment_mode": "IMPS",
  "amount": "5"
}

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/initiatePayoutTransaction' \
--header 'Content-Type: application/json' \
--data-raw '{
    "username": "f68db941819657a1434b9bce0cd9811e",
    "password": "cabfc6c85d2c1ec57905d6f230784ca8",
    "requestid": "xaJ0xvhpmvpo0il8zQkiG5",
    "beneficiary_id": "36",
    "payment_mode": "IMPS",
    "amount": "5"
}'

Responses

🟢200Payout Transaction Request
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
string 
required
chargedamt
string 
required
Example
{
  "Resp_code": "RCS",
  "Resp_desc": "Transaction Under Process, request timed out",
  "requestid": "yBzBpK1gL0S02EFagPDy",
  "data": {
    "benename": "",
    "opid": "00",
    "txnid": "W231004154006IQF",
    "txn_status": "PENDING",
    "txn_desc": "Transaction Under Process, request timed out",
    "date": "2023-10-04 15:40:06",
    "datetext": "15:40:06 on 2023-10-04",
    "commission": 2,
    "tds": 0.1,
    "totalcharge": 4,
    "trasamt": "100",
    "chargedamt": "100"
  }
}
🟢200Payout Transaction Request
Modified at 2025-04-10 11:27:54
Previous
Validate UPI Beneficiary
Next
Direct Payout Transaction Request
Built with