PayoutRecipientsClient
in package
Handles interactions with the recipients endpoints.
Tags
Table of Contents
Properties
- $instance : self|null
- $restCli : RESTcli
- $tokenCache : Tokens
Methods
- delete() : bool
- Delete a Payout Recipient.
- get() : PayoutRecipient
- Retrieve a BitPay payout recipient by batch id using. The client must have been previously authorized for the payout facade.
- getInstance() : static
- Factory method for Payout Recipients Client.
- getPayoutRecipients() : array<string|int, PayoutRecipient>
- Retrieve a collection of BitPay Payout Recipients.
- requestNotification() : bool
- Notify BitPay Payout Recipient.
- submit() : array<string|int, PayoutRecipients>
- Submit BitPay Payout Recipients.
- update() : PayoutRecipient
- Update a Payout Recipient.
- __construct() : mixed
Properties
$instance
private
static self|null
$instance
= null
$restCli
private
RESTcli
$restCli
$tokenCache
private
Tokens
$tokenCache
Methods
delete()
Delete a Payout Recipient.
public
delete(string $recipientId) : bool
Parameters
- $recipientId : string
-
The recipient id for the recipient to be deleted.
Tags
Return values
bool —True if the recipient was successfully deleted, false otherwise.
get()
Retrieve a BitPay payout recipient by batch id using. The client must have been previously authorized for the payout facade.
public
get(string $recipientId) : PayoutRecipient
Parameters
- $recipientId : string
-
The id of the recipient to retrieve.
Tags
Return values
PayoutRecipientgetInstance()
Factory method for Payout Recipients Client.
public
static getInstance(Tokens $tokenCache, RESTcli $restCli) : static
Parameters
Return values
staticgetPayoutRecipients()
Retrieve a collection of BitPay Payout Recipients.
public
getPayoutRecipients([string|null $status = null ][, int|null $limit = null ][, int|null $offset = null ]) : array<string|int, PayoutRecipient>
Parameters
- $status : string|null = null
-
The recipient status you want to query on.
- $limit : int|null = null
-
Maximum results that the query will return (useful for paging results).
- $offset : int|null = null
-
Number of results to offset (ex. skip 10 will give you results starting with the 11th result).
Tags
Return values
array<string|int, PayoutRecipient>requestNotification()
Notify BitPay Payout Recipient.
public
requestNotification(string $recipientId) : bool
Parameters
- $recipientId : string
-
The id of the recipient to notify.
Tags
Return values
bool —True if the notification was successfully sent, false otherwise.
submit()
Submit BitPay Payout Recipients.
public
submit(PayoutRecipients $recipients) : array<string|int, PayoutRecipients>
Parameters
- $recipients : PayoutRecipients
-
A PayoutRecipients object with request parameters defined.
Tags
Return values
array<string|int, PayoutRecipients> —A list of BitPay PayoutRecipients objects.
update()
Update a Payout Recipient.
public
update(string $recipientId, PayoutRecipient $recipient) : PayoutRecipient
Parameters
- $recipientId : string
-
The recipient id for the recipient to be updated.
- $recipient : PayoutRecipient
-
A PayoutRecipient object with updated parameters defined.
Tags
Return values
PayoutRecipient__construct()
private
__construct(Tokens $tokenCache, RESTcli $restCli) : mixed