Initiate/Schedule Transfer API
Initiate / schedule single/multiple transfers to beneficiary account, UPI address or credit card.
Last updated
Initiate / schedule single/multiple transfers to beneficiary account, UPI address or credit card.
Last updated
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
Key
Description
Data type
Mandatory
possible Values
batchId
It can be any string value. Merchant can use this value if they want process the request in batch and also what status of transfer in batch. This can be unique for a batch or across multiple request.
String
yes
amount
Amount to transfer in beneficiary account
Double(20,2)
Yes
merchantRefId
Unique reference id generated at merchant side to distinguish between multiple transfers. Same value will be used by merchant in status check of transfer.
String
Yes
beneficiaryAccountNumber
Mandatory in case of IMPS and NEFT, RTGS transactions. It will have beneficiary account number
String
Conditional
beneficiaryIfscCode
Mandatory in case of IMPS and NEFT, RTGS transactions. It will have beneficiary bank ifsc code
String
Conditional
beneficiaryName
Mandatory in case of NEFT transactions. It will have beneficiary name as per his bank account record
String
Conditional
beneficiaryMobile
Beneficiary mobile number
String
No
beneficiaryEmail
Beneficiary Email
String
No
purpose
Purpose of doing this transfer
String
Yes
paymentType
Mode of the payment
String
Yes
IMPS, UPI, NEFT,
RTGS, MASTERCARD, VISA, CC_PAYMENT
vpa
Mandatory in case of UPI transactions. It will be vpa(upi) address of beneficiary
String
Conditional
retry
Default value for this will be True. We provide option to retry the transaction in some particular case.Like Beneficiary bank server down, request timeout while initiating transaction at bank. We will do 3 retries. 1st Retry happens after 30 min , 2nd after 1 hours of 1st Retry and 3rd after 1 hours of 2nd retry. The maximum TAT for pending transactions will be 3-4 hours in case of imps. In case of NEFT it will based on bank timing. Max it can go to next working day of bank.
Boolean
No
scheduledTime
Date and time on which payout has to be scheduled
Ex- 2020-10-20 15:02:11
Date
No
Ex- 2020-10-20 15:02:11
recipientCardNo
Credit Card Number
String
Conditional
Mandatory in case of paymentType cc_payment
beneficiaryId
Id of beneficiary to which the payout needs to be done. This value can be passed instead of other beneficiary details.
Long
Conditional
Mandatory if beneficiary details are not passed.
vpaToken
vpa token corresponding to vpa(upi) address of beneficiary
String
No
disableApprovalFlow
This flag disables approval flow for a particular payout transaction (valid if approval flow is set to OPTIONAL)Boolean
No
No
false/true
Sample Request/Response for a single transfer initiation:
Content-Type : application/json
Method : Get
Test Environment Request Body For IMPS/NEFT/RTGS:
Test Environment Request Body For UPI
Test Environment Request Body For Master card payment
Test Environment Request Body For VISA card payment
Test Environment Request Body For Credit card payment
Response:
Sample Request/Response for multiple transfer initiation:
Content-Type : application/json
Method : Get
Test Environment Request Body:
Response Body :
In case all values are correctly request will get accepted and status of the transfer will be shared on webhooks set by merchant or merchant can call status api by merchant ref id to check the status at any time
Error Code
Description
1001
INVALID MERCHNAT REF ID
1002
DUPLICATE MERCHNAT REF ID
1003
INVALID BATCH ID
1004
INVALID ACCOUNT NUMBER
1005
INVALID IFSC CODE
1006
INVALID AMOUNT
1007
INVALID NAME
1008
INVALID MOBILE
1009
INVALID EMAIL
1010
INVALID PURPOSE
1011
INVALID_TRANSFER_TYPE
1012
INVALID_UPI_REQUEST
1013
INVALID_UPI_LENGTH
1014
INVALID_UPI_ID
1015
BENEFICIARY_NAME_INVALID
1016
INVALID_CARD_NUMBER
1017
INVALID_BENEFICIARY_ID
1018
INVALID_SCHEDULE_DATE_FORMAT
1019
INVALID_SCHEDULE_DATE
1020
CARD_PROVIDER_DETAILS_NOT_FOUND
1021
INVALID_CARD_PROVIDER_DETAILS
1022
INVALID_IFSC_CODE_PATTERN