Menu

## PayoutRecipients
in package

PayoutRecipients.php : 25

##### Tags

author

  BitPay Integrations integrations@bitpay.com

license

  http://www.opensource.org/licenses/mit-license.php MIT

see
  https://bitpay.readme.io/reference/payouts

  REST API Payouts

### Table of Contents

#### Properties

$guid : string|null
$recipients : array<string|int, mixed>
$token : string|null

#### Methods

__construct() : mixed
  Constructor, create an recipient-full request PayoutBatch object.
getGuid() : string|null
  Gets guid.
getRecipients() : array<string|int, PayoutRecipient>
  Gets an array with all recipients.
getToken() : string|null
  Gets token.
setGuid() : void
  Sets guid.
setRecipients() : void
  Sets array with all recipients.
setToken() : void
  Sets token.
toArray() : array<string|int, mixed>
  Return an array with paid and unpaid value.

### Properties

#### $guid

PayoutRecipients.php : 28
`protected string|null $guid = null`

#### $recipients

PayoutRecipients.php : 27
`protected array<string|int, mixed> $recipients = []`

#### $token

PayoutRecipients.php : 29
`protected string|null $token = null`

### Methods

#### __construct()

PayoutRecipients.php : 36

Constructor, create an recipient-full request PayoutBatch object.

`public __construct([mixed $recipients = [] ]) : mixed`

##### Parameters

$recipients : mixed = []

  array array of JSON objects, with containing the following parameters.

#### getGuid()

PayoutRecipients.php : 49

Gets guid.

`public getGuid() : string|null`

##### Return values

string|null

#### getRecipients()

PayoutRecipients.php : 92

Gets an array with all recipients.

`public getRecipients() : array<string|int, PayoutRecipient>`

##### Return values

array<string|int, PayoutRecipient>

#### getToken()

PayoutRecipients.php : 69

Gets token.

`public getToken() : string|null`

##### Return values

string|null

#### setGuid()

PayoutRecipients.php : 59

Sets guid.

`public setGuid(string $guid) : void`

##### Parameters

$guid : string

#### setRecipients()

PayoutRecipients.php : 103

Sets array with all recipients.

`public setRecipients(array<string|int, PayoutRecipient> $recipients) : void`

##### Parameters

$recipients : array<string|int, PayoutRecipient>

##### Tags

throws
  BitPayValidationException

#### setToken()

PayoutRecipients.php : 79

Sets token.

`public setToken(string $token) : void`

##### Parameters

$token : string

#### toArray()

PayoutRecipients.php : 119

Return an array with paid and unpaid value.

`public toArray() : array<string|int, mixed>`

##### Return values

array<string|int, mixed>

## Search results