Properties

$post

$post : \Heidelpay\PhpApi\ParameterGroups\PostParameterGroup

Post

Type

\Heidelpay\PhpApi\ParameterGroups\PostParameterGroup

$shop

$shop : \Heidelpay\PhpApi\ParameterGroups\ShopParameterGroup

ShopParameterGroup

Type

\Heidelpay\PhpApi\ParameterGroups\ShopParameterGroup

$shopmodule

$shopmodule : \Heidelpay\PhpApi\ParameterGroups\ShopmoduleParameterGroup

ShopmoduleParameterGroup

Type

\Heidelpay\PhpApi\ParameterGroups\ShopmoduleParameterGroup

Methods

toJson()

toJson(integer  $options) : string

Returns a json representation of itself.

Parameters

integer $options

Returns

string

jsonSerialize()

jsonSerialize() 

__construct()

__construct() 

Constructor will generate all necessary sub objects

authentification()

authentification(string  $securitySender = null, string  $userLogin = null, string  $userPassword = null, string  $transactionChannel = null, boolean  $sandboxRequest = false) : \Heidelpay\PhpApi\Request

Set all necessary authentication parameters for this request

Parameters

string $securitySender

security sender parameter f.e 31HA07BC8142C5A171745D00AD63D182

string $userLogin

user login parameter f.e. 31ha07bc8142c5a171744e5aef11ffd3

string $userPassword

user password f.e. 93167DE7

string $transactionChannel

channel id of the payment method f.e. 31HA07BC8142C5A171744F3D6D155865

boolean $sandboxRequest

choose between sandbox and productive payment system

Returns

\Heidelpay\PhpApi\Request

async()

async(string  $languageCode = "EN", string  $responseUrl = null) : \Heidelpay\PhpApi\Request

Set all necessary parameter for a asynchronous request

Parameters

string $languageCode

language code 2 letters for error messages and iframe f.e EN

string $responseUrl

response url of your application f.e https://www.url.com/response.php

Returns

\Heidelpay\PhpApi\Request

customerAddress()

customerAddress(string  $nameGiven = null, string  $nameFamily = null, string  $nameCompany = null, string  $shopperId = null, string  $addressStreet = null, string  $addressState = null, string  $addressZip = null, string  $addressCity = null, string  $addressCountry = null, string  $contactMail = null) : \Heidelpay\PhpApi\Request

Set all necessary customer parameter for a request

Parameters

string $nameGiven

customer given name f.e. John

string $nameFamily

customer family name f.e. Doe

string $nameCompany

company name f.e. Heidelpay

string $shopperId

customer id in your application f.e. 1249

string $addressStreet

address street of the customer f.e. Vagerowstr.

string $addressState

address state ot the customer f.e Bayern

string $addressZip

address zip code f.e. 69115

string $addressCity

address city f.e. Heidelberg

string $addressCountry

address country code 2 letters f.e. DE

string $contactMail

email adress of the customer f.e. ab@mail.de

Returns

\Heidelpay\PhpApi\Request

basketData()

basketData(string  $shopIdentifier = null, string  $amount = null, string  $currency = null, string  $secret = null) : \Heidelpay\PhpApi\Request

Set all basket or order information

Parameters

string $shopIdentifier

id of your application f.e. order-125454

string $amount

amount of the current basket f.e. 20.12

string $currency

currency code 3 letters f.e. USD

string $secret

a secret to prevent your application against fake responses

Returns

\Heidelpay\PhpApi\Request

convertToArray()

convertToArray() : array

Convert request object to post key value format

Returns

array —

request

send()

send(string  $uri = null, array  $post = null, \Heidelpay\PhpApi\Adapter\CurlAdapter  $adapter = null) : array

Send request to payment api

Parameters

string $uri

payment api url

array $post

heidelpay request parameter

\Heidelpay\PhpApi\Adapter\CurlAdapter $adapter

Returns

array —

response|\Heidelpay\PhpApi\Response

b2cSecured()

b2cSecured(null  $salutation = null, null  $birthdate = null, null  $basketId = null) : $this

Parameter used in case of b2c secured invoice or direct debit

Parameters

null $salutation

customer salutation MR/MRS (Mandatory)

null $birthdate

customer birth date YYYY-MM-DD (Mandatory)

null $basketId

id of a given basket using heidelpay basket api (Optional)

Returns

$this —

\Heidelpay\PhpApi\Request