Menu

## PayoutRecipient
in package

PayoutRecipient.php : 17

##### 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

$email : string|null
$guid : string|null
$id : string|null
$label : string|null
$notificationURL : string|null
$shopperId : string|null
$status : string|null
$token : string|null

#### Methods

__construct() : mixed
  Constructor, create a minimal Recipient object.
getEmail() : string|null
  Gets email.
getGuid() : string|null
  Gets guid.
getId() : string|null
  Gets id.
getLabel() : string|null
  Gets label.
getNotificationURL() : string|null
  Gets notification url.
getShopperId() : string|null
  Gets Shopper ID.
getStatus() : string|null
  Gets status.
getToken() : string|null
  Gets token.
setEmail() : void
  Sets email.
setGuid() : void
  Sets guid.
setId() : void
  Sets id.
setLabel() : void
  Sets label.
setNotificationURL() : void
  Sets notification url.
setShopperId() : void
  Sets Shopper ID.
setStatus() : void
  Sets status.
setToken() : void
  Sets token.
toArray() : array<string|int, mixed>
  Return an array with values of all fields.

### Properties

#### $email

PayoutRecipient.php : 19
`protected string|null $email = null`

#### $guid

PayoutRecipient.php : 20
`protected string|null $guid = null`

#### $id

PayoutRecipient.php : 24
`protected string|null $id = null`

#### $label

PayoutRecipient.php : 21
`protected string|null $label = null`

#### $notificationURL

PayoutRecipient.php : 22
`protected string|null $notificationURL = null`

#### $shopperId

PayoutRecipient.php : 25
`protected string|null $shopperId = null`

#### $status

PayoutRecipient.php : 23
`protected string|null $status = null`

#### $token

PayoutRecipient.php : 26
`protected string|null $token = null`

### Methods

#### __construct()

PayoutRecipient.php : 36

Constructor, create a minimal Recipient object.

`public __construct([string|null $email = null ][, string|null $label = null ][, string|null $notificationURL = null ]) : mixed`

##### Parameters

$email : string|null = null

  string Recipient email address to which the invite shall be sent.

$label : string|null = null

  string Recipient nickname assigned by the merchant (Optional).

$notificationURL : string|null = null

  string URL to which BitPay sends webhook notifications to inform the merchant about the status of a given recipient. HTTPS is mandatory (Optional).

#### getEmail()

PayoutRecipient.php : 51

Gets email.

`public getEmail() : string|null`

##### Return values

string|null

#### getGuid()

PayoutRecipient.php : 74

Gets guid.

`public getGuid() : string|null`

##### Return values

string|null

#### getId()

PayoutRecipient.php : 157

Gets id.

`public getId() : string|null`

##### Return values

string|null

#### getLabel()

PayoutRecipient.php : 94

Gets label.

`public getLabel() : string|null`

##### Return values

string|null

#### getNotificationURL()

PayoutRecipient.php : 114

Gets notification url.

`public getNotificationURL() : string|null`

##### Return values

string|null

#### getShopperId()

PayoutRecipient.php : 177

Gets Shopper ID.

`public getShopperId() : string|null`

##### Return values

string|null

#### getStatus()

PayoutRecipient.php : 137

Gets status.

`public getStatus() : string|null`

##### Return values

string|null

#### getToken()

PayoutRecipient.php : 197

Gets token.

`public getToken() : string|null`

##### Return values

string|null

#### setEmail()

PayoutRecipient.php : 61

Sets email.

`public setEmail(string|null $email) : void`

##### Parameters

$email : string|null

#### setGuid()

PayoutRecipient.php : 84

Sets guid.

`public setGuid(string $guid) : void`

##### Parameters

$guid : string

#### setId()

PayoutRecipient.php : 167

Sets id.

`public setId(string|null $id) : void`

##### Parameters

$id : string|null

#### setLabel()

PayoutRecipient.php : 104

Sets label.

`public setLabel(string|null $label) : void`

##### Parameters

$label : string|null

#### setNotificationURL()

PayoutRecipient.php : 124

Sets notification url.

`public setNotificationURL(string|null $notificationURL) : void`

##### Parameters

$notificationURL : string|null

#### setShopperId()

PayoutRecipient.php : 187

Sets Shopper ID.

`public setShopperId(string|null $shopperId) : void`

##### Parameters

$shopperId : string|null

#### setStatus()

PayoutRecipient.php : 147

Sets status.

`public setStatus(string $status) : void`

##### Parameters

$status : string

#### setToken()

PayoutRecipient.php : 207

Sets token.

`public setToken(string $token) : void`

##### Parameters

$token : string

#### toArray()

PayoutRecipient.php : 217

Return an array with values of all fields.

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

##### Return values

array<string|int, mixed>

## Search results