Create or Register Beneficiary API

The Create Beneficiary API command is used to register a beneficiary under the merchant. After registering, the merchant can use the beneficiary id to make the payout.



Request header

Authorization mandatoryString Specify the access token generated earlier in this parameter.Bearer {access_token}
String Specify the payout merchant id provided while onboarding or creating Payout account.1111126
String Indicates the format in which the request is sent.application/json



The pid is payoutMerchantId, however it is different from the PayU merchant id. Check the Payouts Dashboard or call the PayU Customer Support if you don’t know your payoutsMerchantID.

Request parameters

accountNo conditionalStringIndicates Account number of customer
StringIndicates IFSC code of the bank account
StringIndicates UPI ID of customer
Note: Same value will be used by the merchant in the status check of transfer.
name optionalStringIndicates of the customer
StringIndicates Email Address of customer
mobile conditionalStringIndicates Mobile Number of customer

Sample request

 curl --location '' \
--header 'Content-Type: application/json' \
--header 'payoutMerchantId: 1111157' \
--header 'Authorization: Bearer 1d7e2db3cce25cb3a0a8753f18663cceb4e060538c118498f3f18cf6cb7c7f9b' \
--data \
-raw '{ 
        "name": "test", 
        "email": "[email protected]", 
        "mobile": "1234567890", 
        "ifsc": "ABCD0123456", 
        "vpa": "test@upi", 
        "cardNo": "1234567890123456", 
        "beneCode": "BENECODE123" 

Response parameters

statusThis parameter returns the status of web service call. The status can be any of the following:
- 0 - If web service call succeeded
1 - If web service call failed
msgThis parameter returns the success or failure message.
codeThis parameter returns the error code if the API failed to verify or invalid details.
dataThis parameter returns the saved card details in a JSON format. For more information, refer to the next table.

Description of data JSON Fields

beneficiaryIdThis field returns PayU beneficiary ID for the beneficiary added.
nameThis field returns the beneficiary name.
emailThis field returns the email ID of the beneficiary.
mobileThis field returns the mobile number of the beneficiary.
accountNoThis fields returns the account number of the beneficiary.
ifscThis field returns the IFSC code of the bank brach with which the beneficiary holds the account.
vpaThis field returns the VPA ID of the beneficiary if they have registered for UPI.
merchantIdThis field returns the PayU merchant ID of the beneficiary.
isValidThis field returns any of the following values to indicate whether the account is valid or not:
addedOnThis field returns any of the date and time stamp when the beneficiary was added with PayU.
updatedOnThis field returns any of the date and time stamp when the beneficiary details were updated with PayU.
isVerifiedThis field returns any of the following values to indicate account was verified by PayU. The value null is returned if the account is yet to be verified.
nameWithBankThis field returns the beneficiary name as in the bank records.
cardNoThis field returns the card number if the beneficiary holds a card with bank.

Sample response

  • Success scenario

    "status": 0, 
    "msg": "Beneficiary Created with Id :16", 
    "code": null, 
    "data": { 
        "beneficiaryId": 16, 
        "name": "Deepak", 
        "email": "[email protected]", 
        "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 scenario
  "status": 0,
  "msg": null,
  "code": null,
  "data": {
    "error": "card beneficiary creation is not supported",
    "errorCodes": [