\Heidelpay\PhpApi\ParameterGroupsTransactionParameterGroup

Transaction parameter group

You can change the transaction channel and mode by using this class

Summary

Methods
Properties
Constants
getClassName()
set()
jsonSerialize()
toJson()
getChannel()
getMode()
getResponse()
setChannel()
setMode()
setResponse()
$channel
$mode
$response
No constants found
No protected methods found
No protected properties found
N/A
No private methods found
No private properties found
N/A

Properties

$channel

$channel : string

TransactionChannel

You can use this parameter to set the channel used for this transaction. Depending on the used payment method, you have to use an other channel.

Type

string — channel (mandatory)

$mode

$mode : string

TransactionMode

Mode tells the payment system weather to make a real transaction or just perform a connector test. Please have a look into Heidelpay documentation for more details.

Type

string — mode (mandatory)

$response

$response : string

Type

string

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

getChannel()

getChannel() : string

TransactionChannel getter

Returns

string —

channel

getMode()

getMode() : string

TransactionMode getter

Returns

string —

mode

getResponse()

getResponse() : string

Returns

string

setChannel()

setChannel(string  $channel) : \Heidelpay\PhpApi\ParameterGroups\TransactionParameterGroup

Setter for the transaction channel

A channel can be used as a separater between to two sales channels like german and uk market. Another reason for a different channel is that some payment methods share one channel.

Parameters

string $channel

transaction channel id f.e. 31HA07BC8142C5A171749A60D979B6E4

Returns

\Heidelpay\PhpApi\ParameterGroups\TransactionParameterGroup