Transfers

post
Transfer Request

https://public_key:[email protected]/v1/payout/transfer/request
Use this api to initiate a transfer to your added beneficiary. You can get your keys from the payout api dashboard.
Request
Response
Request
Body Parameters
amount
required
number
10.00
trans_ref
required
string
Unique Transfer Reference id for the Transfer. Accepts only alpha numeric.
beneficiary_ref
required
string
Reference id of the created beneficiary.
remarks
optional
string
Transaction remarks.
pay_mode
optional
string
Payment modes to be used for this transaction, Defaults to NEFT. Available modes: "NEFT", "IMPS", "RTGS" IMPS: Transactions value up to INR 200000 RTGS: Transaction value above INR 200000
Response
200: OK
{
"success": true,
"message": "Payout Accepted",
"data": {
"transfer": {
"commission": {
"value": 4,
"total": 4
},
"status": "accepted",
"merchant_id": "TaodSgGa",
"trans_id": "trans_VRm7frCeE",
"trans_ref": "test24",
"beneficiary": {
"account": {
"number": "50100035304529",
"ifsc": "HDFC0000674"
}
"beneficiary_id": "[email protected]",
"beneficiary_ref": "jaikumarr"
},
"pay_mode": "IMPS",
"amount": 1,
"total_deduction": 5,
"product_type": "payout",
"trans_type": "DEBIT",
"init_source": "api",
"remarks": "Testing",
"updatedAt": "2021-05-11T14:59:07.594Z",
"createdAt": "2021-05-11T14:59:07.594Z"
}
}
}
{
"amount":10.00,
"trans_ref":"xxxxx",
"pay_mode":"NEFT",
"remarks":"Testing",
"beneficiary_ref":"xxxxx"
}

get
Transfer Details

https://public_key:[email protected]/v1/payout/transfer/detail?trans_ref=xxxx
Use this api to get the status of a transfer. You can get your keys from the payout api dashboard.
Request
Response
Request
Query Parameters
trans_ref
required
string
Unique transfer id used to initiate the transaction.
Response
200: OK
{
"success": true,
"message": "Payout Accepted",
"data": {
"transfer": {
"commission": {
"value": 4,
"total": 4
},
"status": "accepted",
"merchant_id": "TaodSgGa",
"trans_id": "trans_VRm7frCeE",
"trans_ref": "test24",
"beneficiary": {
"account": {
"number": "50100035304529",
"ifsc": "HDFC0000674"
}
"beneficiary_id": "[email protected]",
"beneficiary_ref": "jaikumarr"
},
"pay_mode": "IMPS",
"amount": 1,
"total_deduction": 5,
"product_type": "payout",
"trans_type": "DEBIT",
"init_source": "api",
"remarks": "Testing",
"updatedAt": "2021-05-11T14:59:07.594Z",
"createdAt": "2021-05-11T14:59:07.594Z"
}
}
}