\Heidelpay\PhpApi\ParameterGroupsNameParameterGroup

This class provides every api parameter of the "name" namespace

It will be used for parameters like given name, but also for salutation etc.

Summary

Methods
Properties
Constants
getClassName()
set()
jsonSerialize()
toJson()
getBirthdate()
getCompany()
getGiven()
getFamily()
getSalutation()
getTitle()
setBirthdate()
setCompany()
setGiven()
setFamily()
setSalutation()
setTitle()
$birthdate
$company
$given
$family
$salutation
$title
No constants found
No protected methods found
No protected properties found
N/A
No private methods found
No private properties found
N/A

Properties

$birthdate

$birthdate : string

NameBirthdate

Date in the format YYYY-MM-DD e.g. 1970-09-12

Type

string — company name (optional)

$company

$company : string

NameCompany

Used to set the company name of your customer.

Type

string — company name (optional)

$given

$given : string

NameGiven

First name of your customer.

Type

string — given name of the customer (mandatory)

$family

$family : string

NameFamily

Family name of your customer

Type

string — family name of the customer (mandatory)

$salutation

$salutation : string

NameSalutation

Salutation of the customer, may be used as value for place holders (e.g. in dunning mail templates)

Type

string — salutation of the customer (MR/MRS) (conditional mandatory)

$title

$title : string

NameTitle

Title of the customer

Type

string — tile of the customer (optional)

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

getBirthdate()

getBirthdate() : string

NameBirthdate getter

Returns

string —

title

getCompany()

getCompany() : string

NameCompany getter

Returns

string —

company

getGiven()

getGiven() : string

NameGiven getter

Returns

string —

given

getFamily()

getFamily() : string

NameFamily getter

Returns

string —

family

getSalutation()

getSalutation() : string

NameSalutation getter

Returns

string —

salutation

getTitle()

getTitle() : string

NameTitle getter

Returns

string —

title