Initiate Transfer API

The payment API is used to initiate/schedule a single transfer to the beneficiary account, UPI address, or credit card.

Environment

Sample request

IMPS, NEFT or RTGS Payment Request

[
 {
 "beneficiaryAccountNumber": "51234567890",
 "beneficiaryIfscCode": "HDFC0001234",
 "beneficiaryName": "Payu",
 "beneficiaryEmail": "[email protected]",
 "beneficiaryMobile": "9876473627",
 "purpose": "Payment from Company",
 "amount": 1234.12,
 "batchId": "1",
 "merchantRefId": "123asdfad3",
 "paymentType": "IMPS",
 "retry" : false
 }
]

UPI Payment Request

[
 {
 "beneficiaryName": "Payu",
 "beneficiaryEmail": "[email protected]",
 "beneficiaryMobile": "9876473627",
 "purpose": "Payment from Company",
 "amount": 1234.12,
 "batchId": "1",
 "merchantRefId": "123",
 "paymentType": "UPI",
 "vpa" : "ankush.pokarana@ybl"
  "retry" : false
 }
]
Sample response

Success response

{
 "status": 0,
 "msg": "Requests are in process. Will send response of individual request on webhooks set by you",
 "code": null,
 "data": []
 }

Failure response

{
 "status": 1,
 "msg": null,
 "code": null,
 "data": [
           {
            "batchId": "1",
            "merchantRefId": "111",
            "error": "beneficiary account number can not be empty. ",
            "code": [1004]
           }
         ]
 }

Header and request parameters

📘

Note:

The payoutMerchantId is different from PayU Merchant Id. Check the Payouts Dashboard or call the PayU Customer Support if you don’t know your payoutMerchantId.

Additional information for Request parameters
ParametersDescriptionExample
merchantRefId optionalStringIndicates a unique reference ID at the merchant side to distinguish between multiple transfers.
Max char length: 40.
Notes :

- Same value will be used by the merchant in the status check of transfer.
- In case if the merchant reference ID is not passed, an auto generated ID will be used.
 
paymentType
mandatory
String Specify the any of the following mode of payment in this field:

- IMPS
- UPI
- NEFT
- RTGS
- PHONE
- MASTERCARD
- VISA
UPI
Language
Authorization
Bearer
Click Try It! to start a request and see the response here!