\Heidelpay\PhpApi\ParameterGroupsAccountParameterGroup

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

The Account group holds all information regarding a credit card or bank account. Many parameters depend on the chosen payment method.

Summary

Methods
Properties
Constants
getClassName()
set()
jsonSerialize()
toJson()
getBank()
setBank()
getBankName()
setBankName()
getBrand()
setBrand()
getBic()
setBic()
getCountry()
setCountry()
getExpiryMonth()
getExpiryYear()
getHolder()
setHolder()
getIban()
setIban()
getIdentification()
getNumber()
setNumber()
getVerification()
$bank
$bankname
$brand
$bic
$country
$expiry_month
$expiry_year
$holder
$iban
$identification
$number
$verification
No constants found
No protected methods found
No protected properties found
N/A
No private methods found
No private properties found
N/A

Properties

$bank

$bank : string

Bank - The domestic code of the bank which holds the direct debit or credit transfer account.

Type

string — bank of the given account

$bankname

$bankname : string

Bankname - Especially of interest for OnlineTransfer methods to determine which bank was chosen.

Type

string — bankname of the given account

$brand

$brand : string

Brand name of the given account data (for example iDeal)

Type

string — brand of the given account

$bic

$bic : string

Bic - Business identifier code used for non sepa direct debit

Type

string — bic of the given accout

$country

$country : string

Country - Bank or Account Country

Type

string — country of the given account

$expiry_month

$expiry_month : string

Expiry month used for credit and debit cards

Type

string — expiry month of the given account

$expiry_year

$expiry_year : string

Expiry year used for credit and debit cards

Type

string — expiry year of the given account

$holder

$holder : string

Owner of the given account data

Type

string — holder of the given account

$iban

$iban : string

International bank account number

Type

string — iban of the given account

$identification

$identification : string

Identification - Used for SEPA mandate ID

Type

string — sepa mandate id from the payment response

$number

$number : string

Account number can be used for non sepa direct debit transactions

Type

string — number of the given account

$verification

$verification : string

Type

string — verification of the given account

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

getBank()

getBank() : string

AccountBank getter

Returns

string —

bank

getBankName()

getBankName() : string

AccountBankname getter

Returns

string —

bankname

getBrand()

getBrand() : string

AccountBrand getter

Returns

string —

brand

getBic()

getBic() : string

AccountBic getter

Returns

string —

bic

getCountry()

getCountry() : string

AccountCountry getter

Returns

string —

country

getExpiryMonth()

getExpiryMonth() : string

AccountExpiryMonth getter

Returns

string —

expiry month

getExpiryYear()

getExpiryYear() : string

AccountExpiryYear getter

Returns

string —

expiry year

getHolder()

getHolder() : string

AccountHolder getter

Returns

string —

holder

getIban()

getIban() : string

AccountIban getter

Returns

string —

iban

getIdentification()

getIdentification() : string

AccountIdentification getter

Returns

string —

identification

getNumber()

getNumber() : string

AccountNumber getter

Returns

string —

number

setNumber()

setNumber(  $number) : \Heidelpay\PhpApi\ParameterGroups\AccountParameterGroup

Setter for the number of a given account

Note: due to pci restrictions you are not allowed to use this setter for credit or debit card information.

Parameters

$number

string number of the use account

Returns

\Heidelpay\PhpApi\ParameterGroups\AccountParameterGroup

getVerification()

getVerification() : string

AccountVerification getter

Returns

string —

verification