Create Payout Recipients

Facades: payout

Overview

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

  • For merchants who need to invite multiple recipients in a short period of time, make sure to send batch of invites e.g. use this endpoint to invite an array [] of recipients (up to 1000 in a single API call)
  • By default a merchant can invite a maximum of 1000 distinct recipients via the business account. Reach out to your account manager at BitPay in order to increase this limit.

Parameters

ParameterDescription
recipients *List of PayoutRecipient

Example

📘

Note

In this example, we assume that a Client has already been initialized and assigned to the bitpay variable.

recipient = PayoutRecipient()
recipient.email = '[email protected]'

bitpay.submit_payout_recipients(
    PayoutRecipients(**{"recipients": [recipient]})
)