API & SDK Documentation

Invite Recipients

post
https://test.bitpay.com/recipients

Facades: payout

📘

Note

  • 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.
Body Params
recipients
array of objects
required

Array of JSON objects made of the following parameters. Merchants can invite several recipients in one batch call.

recipients*
string
required

Approved payout facade token.

Headers
string
required
Defaults to 2.0.0

Must be set to 2.0.0 for requests to the BitPay API

string
required

The hexadecimal public key generated from the client private key. This header is optional for this endpoint when using the public facade, and required when using a merchant facade token.

string
required

The ECDSA signature of the full request URL concatenated with the request body, signed with your private key. This header is optional for this endpoint when using the public facade, and required when using a merchant facade token.

Response

Updated 10 months ago

Language
LoadingLoading…
Response
Choose an example:
application/json

Updated 10 months ago