Beneficiary

You can manage beneficiaries with the set of API provided below. You can make a transfer request only against an added beneficiary.

Create Beneficiary

POST https://public_key:secret_key@api.ippopay.com/v1/payout/beneficiary/create

Use this api to create a beneficiary on your account to use it for initiating transfer. You can get your keys from the payout api dashboard.

Request Body

{
    "success": true,
    "message": "Beneficiary created Successfully"
}
 {
	"acc_number":"50100012345678",
	"ifsc":"HDFC0000001",
	"name":"Account Holder Name",
	"beneficiary_ref":"reference_id"
}

Beneficiary List

GET https://public_key:secret_key@api.ippopay.com/v1/payout/beneficiary/list

Use this api to fetch list of beneficiaries on your account. You can get your keys from the payout api dashboard.

Query Parameters

{
    "success": true,
    "message": "Beneficiary list",
    "data": {
        "beneficiaries": [
            {
            "account": {
                    "number": "501000000012345678",
                    "ifsc": "HDFC0000001"
                }
                "name": {
                    "first": "",
                    "last": "",
                    "full": "Jaikumar R"
                }
                "status": "active",
                "merchant_id": "XXXXXX",
                "beneficiary_id": "bene_XXXX",
                "beneficiary_ref": "unique_beneficiary_ref",
                "tags": [],
                "updatedAt": "2021-05-11T14:23:05.112Z",
                "createdAt": "2021-05-11T14:23:04.668Z"
            }
        ],
        "total": 1
    }
}

Get Beneficiary Details

GET https://public_key:secret_key@api.ippopay.com/v1/payout/beneficiary/getdetails/{beneficiary_ref}

Use this api to get a particular beneficiary on your account. You can get your keys from the payout api dashboard.

Path Parameters

{
    "success": true,
    "message": "Beneficiary Detail",
    "data": {
        "beneficiary": 
            {
            "account": {
                    "number": "501000000012345678",
                    "ifsc": "HDFC0000001"
                }
                "name": {
                    "first": "",
                    "last": "",
                    "full": "Jaikumar R"
                }
                "status": "active",
                "merchant_id": "XXXXXX",
                "beneficiary_id": "bene_XXXX",
                "beneficiary_ref": "unique_beneficiary_ref",
                "tags": [],
                "updatedAt": "2021-05-11T14:23:05.112Z",
                "createdAt": "2021-05-11T14:23:04.668Z"
            }
    }
}

Last updated