ShippingAddress
extends Address
in package
Model containing properties of the shipping address.
Table of Contents
Properties
- $distanceToBillingAddress : int|null
- $distanceToIpLocation : int|null
- $isHighRisk : bool|null
- $isInIpCountry : bool|null
- $isPostalInCity : bool|null
- $latitude : float|null
- $longitude : float|null
Methods
- __construct() : mixed
- jsonSerialize() : array<string, mixed>
Properties
$distanceToBillingAddress read-only
public
int|null
$distanceToBillingAddress
the distance in kilometers from the shipping address to billing address
$distanceToIpLocation read-only
public
int|null
$distanceToIpLocation
the distance in kilometers from the address to the IP location
$isHighRisk read-only
public
bool|null
$isHighRisk
This property is true if the shipping
address is an address associated with fraudulent transactions. The property
is false when the address is not associated with increased risk. The
property will be null when a shipping address is not provided.
$isInIpCountry read-only
public
bool|null
$isInIpCountry
This property is true if the address is in the IP country. The property is false when the address is not in the IP country. If the address could not be parsed or was not provided or if the IP address could not be geolocated, the property will be null.
$isPostalInCity read-only
public
bool|null
$isPostalInCity
This property is true if the postal code provided with the address is in the city for the address. The property is false when the postal code is not in the city. If the address was not provided or could not be parsed, the property will be null.
$latitude read-only
public
float|null
$latitude
the latitude associated with the address
$longitude read-only
public
float|null
$longitude
the longitude associated with the address
Methods
__construct()
public
__construct(array<string, mixed>|null $response) : mixed
Parameters
- $response : array<string, mixed>|null
jsonSerialize()
public
jsonSerialize() : array<string, mixed>