Get Payout Recipients

Facades: payout

Overview

Gets multiple payout recipients filtered by query parameters.

Parameters

ParameterDescription
statusThe recipient status you want to query on. See RecipientStatus for possible statuses.
limitMaximum results that the query will return (useful for paging results).
offsetOffset for paging.

Example

List<PayoutRecipient> recipients = bitpay.getPayoutRecipients(RecipientStatus.ACTIVE, null, null);