Get Payout Recipients

Get payout recipients

GET /recipients

Facades PAYOUT

HTTP Request

The BitPay server shall return a 200 OK response, and the body of the response shall be an array of recipients objects previously described. The only difference is that the data parameter is an array instead of an object.

An example code to fetch the list of payout recipients

var retrieveRecipients = bitpay.GetPayoutRecipients();

HTTP Response

{
    "facade":"payout/recipient",
    "data":[
        {
            "email":"[email protected]",
            "label":"recipient1",
            "notificationURL":"https://yournotiticationURL.com/b3sarz5bg0wx01eq1bv9785amx",
            "status":"invited",
            "id":"JA4cEtmBxCp5cybtnh1rds",
            "shopperId":null,
            "token":"2LVBntm7z92rnuVjVX5ZVaDoUEaoY4LxhZMMzPAMGyXcejgPXVmZ4Ae3oGaCGBFKQf"
        },
        {
            "email":"[email protected]",
            "label":"recipient2",
            "notificationURL":"https://yournotiticationURL.com/01eq1bv9783sarb0wxz5bg5amx",
            "status":"invited",
            "id":"X3icwc4tE8KJ5hEPNPpDXW",
            "shopperId":null,
            "token":"2LVBntm7z92rnuVjVX5ZVaDoUEaoY4LxhZMMzPAMGyXrrBAB9vRY3BVxGLbAa6uEx7"
        }
    ]
}