View Beneficiary Detail

Get all the beneficiary available under merchant account.

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
beneficiaryId	Beneficiary If returned while creation	Long	Mandatory	​

Examples

Sample Request/Response for a single transfer initiation:

Content-Type : application/json

Method : GET

Test Environment Request Body:

curl --location --request GET \
'https://https://test.payumoney.com/payout/beneficiary?beneficiaryId=14' \ 
--header 'payoutMerchantId: 1111167' \ 
--header 'Authorization: 1d7e2db3cce25cb3a0a8753f18663cceb4e060538c118498f3f18cf6cb7c7f9b' 

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

​