PayoutClient
in package
Handles interactions with the payout endpoints.
Tags
Table of Contents
Properties
- $instance : self|null
- $restCli : RESTcli
- $tokenCache : Tokens
Methods
- cancel() : bool
- Cancel a BitPay Payout.
- cancelGroup() : PayoutGroup
- createGroup() : PayoutGroup
- get() : Payout
- Retrieve a BitPay payout by payout id using. The client must have been previously authorized for the payout facade.
- getInstance() : static
- Factory method for Payout Client.
- getPayouts() : array<string|int, Payout>
- Retrieve a collection of BitPay payouts.
- requestNotification() : bool
- Notify BitPay Payout.
- submit() : Payout
- Submit a BitPay Payout.
- __construct() : mixed
- getPayoutGroupResponse() : PayoutGroup
Properties
$instance
private
static self|null
$instance
= null
$restCli
private
RESTcli
$restCli
$tokenCache
private
Tokens
$tokenCache
Methods
cancel()
Cancel a BitPay Payout.
public
cancel(string $payoutId) : bool
Parameters
- $payoutId : string
-
The id of the payout to cancel.
Tags
Return values
boolcancelGroup()
public
cancelGroup(string $groupId) : PayoutGroup
Parameters
- $groupId : string
Tags
Return values
PayoutGroupcreateGroup()
public
createGroup(array<string|int, Payout> $payouts) : PayoutGroup
Parameters
- $payouts : array<string|int, Payout>
Tags
Return values
PayoutGroupget()
Retrieve a BitPay payout by payout id using. The client must have been previously authorized for the payout facade.
public
get(string $payoutId) : Payout
Parameters
- $payoutId : string
-
The id of the payout to retrieve.
Tags
Return values
PayoutgetInstance()
Factory method for Payout Client.
public
static getInstance(Tokens $tokenCache, RESTcli $restCli) : static
Parameters
Return values
staticgetPayouts()
Retrieve a collection of BitPay payouts.
public
getPayouts([string|null $startDate = null ][, string|null $endDate = null ][, string|null $status = null ][, string|null $reference = null ][, int|null $limit = null ][, int|null $offset = null ]) : array<string|int, Payout>
Parameters
- $startDate : string|null = null
-
The start date to filter the Payout Batches.
- $endDate : string|null = null
-
The end date to filter the Payout Batches.
- $status : string|null = null
-
The status to filter the Payout Batches.
- $reference : string|null = null
-
The optional reference specified at payout request creation.
- $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, Payout>requestNotification()
Notify BitPay Payout.
public
requestNotification(string $payoutId) : bool
Parameters
- $payoutId : string
-
The id of the Payout to notify.
Tags
Return values
boolsubmit()
Submit a BitPay Payout.
public
submit(Payout $payout) : Payout
Parameters
- $payout : Payout
-
A Payout object with request parameters defined.
Tags
Return values
Payout__construct()
private
__construct(Tokens $tokenCache, RESTcli $restCli) : mixed
Parameters
getPayoutGroupResponse()
private
getPayoutGroupResponse(string $responseJson, string $responseType) : PayoutGroup
Parameters
- $responseJson : string
- $responseType : string
-
completed/cancelled