Create Payout Recipients

Create payout recipients

Allows a merchant to invite clients to sign up for a BitPay personal account.

POST /recipients

Facades PAYOUT

HTTP Request

An example code of the create recipients request

let recipients = [];
let recipientsList = [];
let recipientsObj;

recipientsList.push(new PayoutRecipient("[email protected]","recipient1","https://hookb.in/wNDlQMV7WMFz88VDyGnJ"));
recipientsList.push(new PayoutRecipient("[email protected]","recipient2","https://hookb.in/QJOPBdMgRkukpp2WO60o"));
recipientsList.push(new PayoutRecipient("[email protected]","recipient3","https://hookb.in/QJOPBdMgRkukpp2WO60o"));

recipientsObj = new PayoutRecipients(recipientsList);

recipients = await client.SubmitPayoutRecipients(recipientsObj);

The BitPay server returns a 200 OK response to a properly formatted request. The body of the
response is the following.

Response Body Fields

Name	Description	Type
`facade`	Set to `"payout/recipient"`.	`string`
`data`	Array of JSON objects.	`array`
→ `email`	Recipient email address to which the invite shall be sent.	`string`
→ `notificationURL`	URL to which BitPay sends webhook notifications to inform the merchant about the status of a given recipient. HTTPS is mandatory.	`string`
→ `label`	For merchant use, pass through - could be customer name or unique reference ID.	`string`
→ `status`	Recipient status, can have the following values: `"invited"`, `"unverified"`, `"verified"`, `"active"`, `"paused"`, `"removed"`	`string`
→ `id`	Unique recipient `id` assigned by BitPay for a given customer `email`	`string`
→ `shopperId`	This is the unique id assigned by BitPay if the shopper used his personal BitPay account to authenticate and pay an invoice. For customers signing up for a brand new BitPay personal account, this id will only be created as part of the payout onboarding. The same field would also be available on paid invoices if the customer signed in with his BitPay personal account before completing the payment. This can allow merchants to monitor the activity of a customer deposits & payouts).	`string`
→ `token`	Resource token. This token is derived from the API token initially used to create the recipient and is tied to the specific recipient id created.	`string`

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"
        }
   ]
}