\Heidelpay\PhpApi\ParameterGroupsFrontendParameterGroup

This class provides every api parameter used for frontend settings like language etc.

Summary

Methods
Properties
Constants
getClassName()
set()
jsonSerialize()
toJson()
getEnabled()
getLanguage()
getMode()
getRedirectUrl()
getResponseUrl()
getPaymentFrameOrigin()
getPaymentFrameUrl()
getCssPath()
getPreventAsyncRedirect()
setCssPath()
setEnabled()
setLanguage()
setMode()
setPaymentFrameOrigin()
setPreventAsyncRedirect()
setResponseUrl()
$css_path
$enabled
$language
$mode
$payment_frame_origin
$payment_frame_url
$prevent_async_redirect
$redirect_url
$response_url
No constants found
No protected methods found
No protected properties found
N/A
No private methods found
No private properties found
N/A

Properties

$css_path

$css_path : string

FrontendCssPath

Type

string — url for a custom css to style the hpf. Only required for hpf

$enabled

$enabled : boolean

FrontendEnabled

Type

boolean — enable for async from submit or disable for sync (mandatory)

$language

$language : string

FrontendLanguage

Type

string — language code ISO 639-1 (mandatory)

$mode

$mode : string

FrontendMode

Type

string — always set to withelabel on ngw (mandatory)

$payment_frame_origin

$payment_frame_origin : string

FrontendPaymentFrameOrigin

Type

string — origin of your website (like "http://dev.heidelpay.de/"). Only required for hpf

$payment_frame_url

$payment_frame_url : string

FrontendPaymentFrameUrl

Type

string — url of the payment iframe, only for credit card and debit card because of pci restrictions

$prevent_async_redirect

$prevent_async_redirect : boolean

FrontendPreventAsyncRedirect

Change the behavior of the hpf weather to redirect to the given url or just give you the response of the payment back to your javascript. Note: Browser side data can not be trusted, so you should check the response send to your FrontendResponseUrl as well.

Type

boolean — weather redirect is active or not

$redirect_url

$redirect_url : string

FrontendRedirectUrl

Type

string — url for whitelabel payment from

$response_url

$response_url : string

FrontendResponseUrl

Type

string — url of your system for async payment response (mandatory)

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

getEnabled()

getEnabled() : string

FrontendEnabled getter

Returns

string —

enabled

getLanguage()

getLanguage() : string

FrontendLanguage getter

Returns

string —

language

getMode()

getMode() : string

Getter for frontend mode

Returns

string

getRedirectUrl()

getRedirectUrl() : string

FrontendRedirectUrl getter

Returns

string —

redirect url

getResponseUrl()

getResponseUrl() : string

FrontendResponseUrl getter

Returns

string —

response url

getPaymentFrameOrigin()

getPaymentFrameOrigin() : string

FrontendPaymentFrameOrigin getter

Returns

string —

payment frame origin

getPaymentFrameUrl()

getPaymentFrameUrl() : string

FrontendPaymentFrameUrl getter

Returns

string —

payment frame url

getCssPath()

getCssPath() : string

FrontendCssPath getter

Returns

string —

css path

getPreventAsyncRedirect()

getPreventAsyncRedirect() : boolean

FrontendReventAsyncRedirect

Returns

boolean —

weather is enabled or not

setEnabled()

setEnabled(string  $enabled) : \Heidelpay\PhpApi\ParameterGroups\FrontendParameterGroup

Setter to disable the frontend

This setting will force the payment to act in syn mode. This is only possible for transaction that do not need user input. F. e. prepayment, invoice or transactions like debitOnRegistration (only not 3DSecure).

Parameters

string $enabled

Returns

\Heidelpay\PhpApi\ParameterGroups\FrontendParameterGroup

setLanguage()

setLanguage(string  $language) : \Heidelpay\PhpApi\ParameterGroups\FrontendParameterGroup

Setter for the frontend language

This setting only influence error messages and the heidelpay payment frame for credit and debit card..

Parameters

string $language

iso language code 2 letters

Returns

\Heidelpay\PhpApi\ParameterGroups\FrontendParameterGroup

setPreventAsyncRedirect()

setPreventAsyncRedirect(string  $prevent_async_redirect) : \Heidelpay\PhpApi\ParameterGroups\FrontendParameterGroup

Setter to prevent the iframe to redirect to a give url

With this setter you can prevent the payment frame to redirect to an given url. The Frame will give you javascript listen the result of the transaction. This can be used for one step checkout or checkouts like the magento once.

Parameters

string $prevent_async_redirect

Returns

\Heidelpay\PhpApi\ParameterGroups\FrontendParameterGroup

setResponseUrl()

setResponseUrl(string  $response_url) : \Heidelpay\PhpApi\ParameterGroups\FrontendParameterGroup

Setter for the response url of your application

The payment server will send the result of the transaction directly to this url in http post notation. Please make sure that this url is reachable form the internet. The response will be send server to server, if you see this url inside your browser, something went wrong. PLease check your php log first, if there is nothing you can identify please write to support@heidelpay.de this the shortid of the transaction or the email address used for the request-

Parameters

string $response_url

f.e https://dev.heidelpay.de/reponse.php

Returns

\Heidelpay\PhpApi\ParameterGroups\FrontendParameterGroup