BitPay PHP SDK

PayoutRecipient
in package

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

Methods

__construct()

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()

Gets email.

public getEmail() : string|null
Return values
string|null

getGuid()

Gets guid.

public getGuid() : string|null
Return values
string|null

getId()

Gets id.

public getId() : string|null
Return values
string|null

getLabel()

Gets label.

public getLabel() : string|null
Return values
string|null

getNotificationURL()

Gets notification url.

public getNotificationURL() : string|null
Return values
string|null

getShopperId()

Gets Shopper ID.

public getShopperId() : string|null
Return values
string|null

getStatus()

Gets status.

public getStatus() : string|null
Return values
string|null

getToken()

Gets token.

public getToken() : string|null
Return values
string|null

setEmail()

Sets email.

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

setGuid()

Sets guid.

public setGuid(string $guid) : void
Parameters
$guid : string

setId()

Sets id.

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

setLabel()

Sets label.

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

setNotificationURL()

Sets notification url.

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

setShopperId()

Sets Shopper ID.

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

setStatus()

Sets status.

public setStatus(string $status) : void
Parameters
$status : string

setToken()

Sets token.

public setToken(string $token) : void
Parameters
$token : string

toArray()

Return an array with values of all fields.

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

        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results