\Heidelpay\PhpApi\ParameterGroupsAddressParameterGroup

This class provides every api parameter related to the customers billingaddress data

Depending on the used payment method billing and shipping address should be equal.

Summary

Methods
Properties
Constants
getClassName()
set()
jsonSerialize()
toJson()
getCity()
getCountry()
getState()
getStreet()
getZip()
setCity()
setCountry()
setState()
setStreet()
setZip()
$city
$country
$state
$street
$zip
No constants found
No protected methods found
No protected properties found
N/A
No private methods found
No private properties found
N/A

Properties

$city

$city : string

Type

string — city of the customers billingaddress (mandatory)

$country

$country : string

Type

string — county of the customers billingaddress in ISO 3166-1 2 digits (mandatory)

$state

$state : string

Type

string — state of the customers billingaddress in ISO 3166-2 (optinal)

$street

$street : string

Type

string — street of the customers billingaddress (mandatory)

$zip

$zip : string

Type

string — zip code of the customers billingaddress (mandatory)

Methods

getClassName()

getClassName() : string

Return the name of the used class

Returns

string —

class name

jsonSerialize()

jsonSerialize() : array

Returns an array for a json representation.

Returns

array

toJson()

toJson(integer  $options) : string

Returns a Json representation of itself.

Parameters

integer $options

Returns

string

getCity()

getCity() : string

AddressCity getter

Returns

string —

city

getCountry()

getCountry() : string

AddressCountry getter

Returns

string —

country

getState()

getState() : string

AddressState getter

Returns

string —

state

getStreet()

getStreet() : string

AddressStreet getter

Returns

string —

street

getZip()

getZip() : string

AddressZip getter

Returns

string —

zip

setStreet()

setStreet(string  $street) : \Heidelpay\PhpApi\ParameterGroups\AddressParameterGroup

Setter for the address street including house number

Parameters

string $street

address street including house number

Returns

\Heidelpay\PhpApi\ParameterGroups\AddressParameterGroup