Beneficiary Creation / Registration

Using this Api merchant can register a beneficiary under him and use the beneficiary id to do the payout.

Production

​ https://payout.payumoney.com/payout/beneficiary

Test

​ https://test.payumoney.com/payout/beneficiary

Request Header Params

Key	Description	Data type	Mandatory	possible Values
Authorization	Access token generated earlier.	String	Yes	Bearer {access_token}
payoutMerchantId	This is the merchant id provided while onboarding	String	Yes

payoutMerchantId is different from payuMoneyMerchant Id, please use the correct one for seamless experience

Request Params

Key	Description	Data type	Mandatory	possible Values
accountNo	Account number of customer	String	Conditional
ifsc	Bank Ifsc code	String	Conditional
vpa	UPI Id of customer	String	Conditional
name	Name of the customer	String	Conditional
email	Email of customer	String	Optional
mobile	Mobile of customer	String	Optional

Examples

Sample Request/Response for a single transfer initiation:

Content-Type : application/json

Method : POST

Test Environment Request Body:

{ 
"name": "Ankush", 
"email": "[e-mail]", 
"mobile": "1234567890", 
"accountNo": "123456789012", 
"ifsc": "ICIC1234567", 
} 

{
"name": "Deepak", 
"email": "[e-mail]", 
"mobile": "1234567890", 
"vpa":"deepak@vpa” 
} 

Response:

Success

{ 

    "status": 0, 
    "msg": "Beneficiary Created with Id :16", 
    "code": null, 
    "data": { 
        "beneficiaryId": 16, 
        "name": "Deepak", 
        "email": "[e-mail]", 
        "mobile": "1234567890", 
        "accountNo": "12", 
        "ifsc": "ICIC1234567", 
        "vpa": null, 
        "merchantId": 1111167, 
        "isValid": true, 
        "addedOn": "2020-06-22T08:13:37.000+0000", 
        "updatedOn": "2020-06-22T08:13:37.000+0000", 
        "isVerified": null, 
        "nameWithBank": null, 
        "cardNo": null 
} 

Failure

{
 "status": 1,
 "msg": "Error while onboarding",
 "code": null,
 "data": null
 }