Buyer
in package
Allows merchant to pass buyer related information in the invoice object
Tags
Table of Contents
Properties
- $address1 : string|null
- $address2 : string|null
- $country : string|null
- $email : string|null
- $locality : string|null
- $name : string|null
- $notify : bool|null
- $phone : string|null
- $postalCode : string|null
- $region : string|null
Methods
- __construct() : mixed
- getAddress1() : string|null
- Gets Buyer's address
- getAddress2() : string|null
- Gets Buyer's appartment or suite number
- getCountry() : string|null
- Gets Buyer's Country code
- getEmail() : string|null
- Gets Buyer's email address.
- getLocality() : string|null
- Gets Buyer's city or locality
- getName() : string|null
- Gets Buyer's name
- getNotify() : bool|null
- Gets Buyer's notify
- getPhone() : string|null
- Gets Buyer's phone number
- getPostalCode() : string|null
- Gets Buyer's Zip or Postal Code
- getRegion() : string|null
- Buyer's state or province
- setAddress1() : void
- Sets Buyer's address
- setAddress2() : void
- Sets Buyer's appartment or suite number
- setCountry() : void
- Sets Buyer's Country code
- setEmail() : void
- Sets Buyer's email address
- setLocality() : void
- Sets Buyer's city or locality
- setName() : void
- Sets Buyer's name
- setNotify() : void
- Sets Buyer's notify
- setPhone() : void
- Sets Buyer's phone number
- setPostalCode() : void
- Sets Buyer's Zip or Postal Code
- setRegion() : void
- Sets Buyer's state or province
- toArray() : array<string|int, mixed>
- Gets Buyer as array
Properties
$address1
protected
string|null
$address1
= null
$address2
protected
string|null
$address2
= null
$country
protected
string|null
$country
= null
protected
string|null
$email
= null
$locality
protected
string|null
$locality
= null
$name
protected
string|null
$name
= null
$notify
protected
bool|null
$notify
= null
$phone
protected
string|null
$phone
= null
$postalCode
protected
string|null
$postalCode
= null
$region
protected
string|null
$region
= null
Methods
__construct()
public
__construct() : mixed
getAddress1()
Gets Buyer's address
public
getAddress1() : string|null
Return values
string|null —Buyer's address
getAddress2()
Gets Buyer's appartment or suite number
public
getAddress2() : string|null
Return values
string|null —Buyer's appartment or suite number
getCountry()
Gets Buyer's Country code
public
getCountry() : string|null
Format ISO 3166-1 alpha-2
Return values
string|null —Buyer's Country code
getEmail()
Gets Buyer's email address.
public
getEmail() : string|null
If provided during invoice creation, this will bypass the email prompt for the consumer when opening the invoice.
Return values
string|null —Buyer's email address
getLocality()
Gets Buyer's city or locality
public
getLocality() : string|null
Return values
string|null —Buyer's city or locality
getName()
Gets Buyer's name
public
getName() : string|null
Return values
string|null —Buyer's name
getNotify()
Gets Buyer's notify
public
getNotify() : bool|null
Indicates whether a BitPay email confirmation should be sent to the buyer once he has paid the invoice
Return values
bool|null —Buyer's notify
getPhone()
Gets Buyer's phone number
public
getPhone() : string|null
Return values
string|null —Buyer's phone number
getPostalCode()
Gets Buyer's Zip or Postal Code
public
getPostalCode() : string|null
Return values
string|null —Buyer's Zip or Postal Code
getRegion()
Buyer's state or province
public
getRegion() : string|null
Return values
string|null —Buyer's state or province
setAddress1()
Sets Buyer's address
public
setAddress1(string $address1) : void
Parameters
- $address1 : string
-
Buyer's address
setAddress2()
Sets Buyer's appartment or suite number
public
setAddress2(string $address2) : void
Parameters
- $address2 : string
-
Buyer's appartment or suite number
setCountry()
Sets Buyer's Country code
public
setCountry(string $country) : void
Parameters
- $country : string
-
Buyer's Country code
setEmail()
Sets Buyer's email address
public
setEmail(string $email) : void
If provided during invoice creation, this will bypass the email prompt for the consumer when opening the invoice.
Parameters
- $email : string
-
Buyer's email address
setLocality()
Sets Buyer's city or locality
public
setLocality(string $locality) : void
Parameters
- $locality : string
-
Buyer's city or locality
setName()
Sets Buyer's name
public
setName(string $name) : void
Parameters
- $name : string
-
Buyer's name
setNotify()
Sets Buyer's notify
public
setNotify(bool $notify) : void
Indicates whether a BitPay email confirmation should be sent to the buyer once he has paid the invoice
Parameters
- $notify : bool
-
Buyer's notify
setPhone()
Sets Buyer's phone number
public
setPhone(string $phone) : void
Parameters
- $phone : string
-
Buyer's phone number
setPostalCode()
Sets Buyer's Zip or Postal Code
public
setPostalCode(string $postalCode) : void
Parameters
- $postalCode : string
-
Buyer's Zip or Postal Code
setRegion()
Sets Buyer's state or province
public
setRegion(string $region) : void
Parameters
- $region : string
-
Buyer's state or province
toArray()
Gets Buyer as array
public
toArray() : array<string|int, mixed>
Return values
array<string|int, mixed> —Buyer as array