\Heidelpay\PhpApi\ParameterGroupsIdentificationParameterGroup

This class provides every api parameter used to identify a transaction.

Summary

Methods
Properties
Constants
getClassName()
set()
jsonSerialize()
toJson()
getCreditorId()
getShopperId()
getShortId()
getTransactionId()
getReferenceId()
getUniqueId()
setShopperid()
setTransactionid()
setReferenceid()
$creditor_id
$shopperid
$shortid
$transactionid
$referenceid
$uniqueid
No constants found
No protected methods found
No protected properties found
N/A
No private methods found
No private properties found
N/A

Properties

$creditor_id

$creditor_id : string

Creditor id

Type

string — creditor id

$shopperid

$shopperid : string

IdentificationShopperId

Identification number of your customer, should be given by your application. You can use this for example in the HIP backend for search operations or for reporting as well.

Type

string — customer identification number (optional)

$shortid

$shortid : string

IdentificationShortId

This is a human readable version of the IdentificationUniqeId. It can be used for example if you have to ask for a transaction via phone.

Type

string — heidelpay short identifier

$transactionid

$transactionid : string

IdentificatonTransactionId

This is an identifier given by your application. It can be a basket or order number.

Type

string — order identification number (optional)

$referenceid

$referenceid : string

IdentificationrefernceId

In some cases like refund or capture, you have to tell the payment api that this transaction is related to an other. In this case, set IdentificationReferenceId to the IndetificationUniqeId of the related transaction.

Type

string — payment reference Id, for example the uniqe Id of the invoice autorisation

$uniqueid

$uniqueid : string

IdentificationUniqeId

This is the transaction identifier given by the payment api. This id can be used for related transactions like refund or capture.

Type

string — payment long identifier also know as uniqeId

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

getCreditorId()

getCreditorId() : string

IdentificationCreditorId getter

Returns

string —

creditor id

getShopperId()

getShopperId() : string

IdentificationShopperid getter

Returns

string —

shopperid

getShortId()

getShortId() : string

IdentificationShortid getter

Returns

string —

shortid

getTransactionId()

getTransactionId() : string

IdentificationTransactionId getter

Returns

string —

transaction id

getReferenceId()

getReferenceId() : string

IdentificationReferenceId getter

Returns

string —

reference id

getUniqueId()

getUniqueId() : string

IdentificationUniqueId getter

Returns

string —

unique id

setTransactionid()

setTransactionid(string  $transactionid) : \Heidelpay\PhpApi\ParameterGroups\IdentificationParameterGroup

Setter for the transaction id

The transaction id is an identifier given by your application to allow matching between your system and the payment system. This can be f.e. an order id or invoice id.

Parameters

string $transactionid

f.e. order-1109

Returns

\Heidelpay\PhpApi\ParameterGroups\IdentificationParameterGroup

setReferenceid()

setReferenceid(string  $referenceid) : \Heidelpay\PhpApi\ParameterGroups\IdentificationParameterGroup

Setter for the payment reference id or unique id

Some kinds of transactions needs to reference to another transaction. This can be done by setting this parameter with the unique id of the reference transaction. F.e. if you use debitOnRegistration you have to set the id of the registration.

Parameters

string $referenceid

f.e. 31HA07BC8142C5A171745D00AD63D182

Returns

\Heidelpay\PhpApi\ParameterGroups\IdentificationParameterGroup