To create payouts, merchants will first need to issue email invites using this resource. This is a mandatory step to onboard customers asking for cryptocurrency payouts.
The recipients of the email invites will be invited to create a BitPay personal account, submit a photo of a proof of ID document (Passport, driver's license, Identity card) and provide the home address in order to be able to submit a cryptocurrency withdrawal address to be used for the payouts.
Notice: If you would like to receive webhook notifications about the status of each recipient, you must submit a Recipient IPN within the merchant dashboard. This can be completed by the following flow: Settings > General > Payout Settings > Recipient IPN
The BitPay personal account is NOT a cryptocurrency wallet, it is a personal account which allows customers to receive cryptocurrency payouts from merchants, make a larger purchase or request a refund, but also apply for additional services like the BitPay Prepaid Mastercard card.
Resource
| Name | Type |
|---|---|
facade
When the
payout facade is used, the BitPay server returns the recipient data as seen from the payout facade, that is "payout/recipient". |
string
|
data
Recipient data object.
|
array
|
email
Recipient email address
|
string
|
label
For merchant use, pass through - could be customer name or unique reference.
|
string
|
status
Recipient status, can have the following values:
|
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 resource id created.
|
string
|