Currency code set for the payout amount (ISO 4217 3-character currency code).

Ledger currency code set for the payout (ISO 4217 3-character currency code), it indicates on which ledger the payout will be recorded. Supported ledger currency codes for payouts are EUR, USD, GBP, CAD, NZD, AUD, ZAR, JPY, BTC, BCH, GUSD, USDC, PAX, XRP, BUSD, DOGE, ETH, WBTC, DAI.

Present only if specified by the merchant in the request. Merchants can pass their own unique identifier in this field for reconciliation purposes or for querying. Maximum string length is 100 characters.

Merchant email address for notification of payout status change.

URL to which BitPay sends webhook notifications. If a notificationURL is not passed, the payout will default to using the merchant account level payout IPN if populated. This can be set by the following flow: Settings > General > Payout Settings > Payout IPN. HTTPS is mandatory.

Email address of a recipient. If the recipient email is not found, the recipient will be invited as well.

Note: In the future, BitPay may allow Recipients to update the email address tied to their personal account. BitPay encourages the use of recipientId or shopperId when programmatically creating payouts.

Bitpay recipient id of an active recipient, assigned by BitPay for a given recipient email during the onboarding process (see Recipients resource).

This is the unique id assigned by BitPay if the shopper used their 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 their BitPay personal account before completing the payment. This can allow merchants to monitor the activity of a customer (deposits & payouts).

For merchant use, pass through - can be the customer name or unique merchant reference assigned by the merchant to to the recipient.

Effective date and time (UTC) for the payout. ISO-8601 date format yyyy-mm-dd. If not provided, defaults to date and time of creation.

Approved payout facade token.

Must be set to application/json for requests to the BitPay API

Must be set to 2.0.0 for requests to the BitPay API

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.

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.