\Heidelpay\PhpApi\ParameterGroupsPresentationParameterGroup

This class provides the api parameter for amount and currency.

Summary

Methods
Properties
Constants
getClassName()
set()
jsonSerialize()
toJson()
getAmount()
getCurrency()
getUsage()
setAmount()
setCurrency()
setUsage()
$amount
$currency
$usage
No constants found
No protected methods found
No protected properties found
N/A
No private methods found
No private properties found
N/A

Properties

$amount

$amount : float

PresentationAmount

Order or transaction amount.

Type

float — amount (mandatory)

$currency

$currency : string

PresentationCurrency

Currency of the transaction. ISO 4217

Type

string — currency code ISO 4217 (mandatory)

$usage

$usage : string

PresentationUsage

Provides the dynamic part of the descriptor, which appears on the customer’s statement. Enables the end customer to associate the transaction on the statement to the online transaction.

If a dynamic descriptor can be set, depends on the used connector.

Type

string — usage

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

getAmount()

getAmount() : string

PresentationAmount getter

Returns

string —

amount

getCurrency()

getCurrency() : string

PresentationCurrency getter

Returns

string —

currency

getUsage()

getUsage() : string

PresentationUsage getter

Returns

string —

usage

setUsage()

setUsage(string  $usage) : \Heidelpay\PhpApi\ParameterGroups\PresentationParameterGroup

Setter for the usage

The usage text on the customers account can be set for some payment methods

Parameters

string $usage

f.e. "Order 1232. Thank you for choosing Heidelpay"

Returns

\Heidelpay\PhpApi\ParameterGroups\PresentationParameterGroup