Transfers

Transfer Request

POST https://public_key:[e-mail]/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 Body

Name	Type	Description
amount	number	10.00
trans_ref	string	Unique Transfer Reference id for the Transfer. Accepts only alpha numeric.
beneficiary_ref	string	Reference id of the created beneficiary.
remarks	string	Transaction remarks.
pay_mode	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

200

{
    "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": "bene_0sWxgFdY@",
                "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"
}

Transfer Details

GET https://public_key:[e-mail]/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.

Query Parameters

Name	Type	Description
trans_ref	string	Unique transfer id used to initiate the transaction.

200

{
    "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": "bene_0sWxgFdY@",
                "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"
            
        }
    }
}