Get Payout Recipients

Facades: payout

Get payout recipients

Gets multiple payout recipients filtered by query parameters.

Parameters

ParameterDescription
status *The recipient status you want to query on
limitMaximum results that the query will return, useful for paging results (default: 100)
offsetOffset for paging (default: 0)

Example

📘

Note

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

bitpay.get_payout_recipients('invited')