\FAA\Handler\PaymentMethodBsPayOne

Summary

Methods

Properties

Constants

__construct()
GetFormPreset()
GetDefaultSettings()
GetSettings()
StoreSettings()
BasketProcessable()
RequireRedirect()
StatusAfterDone()
RegisterOrder()
ThreeDIframe()
SettingsValid()
CheckRequestPayload()
CancelSubscription()
UpdateUser()
PayPalGet()
Capture()
PlaceOrder()
CalculatePrice()

No public properties found

No constants found

No protected methods found

No protected properties found

N/A

detectClearingType()
addCustomerInfo()
addArticles()
buildPreAuthoriseRequest()
request()
sendWarning()
defaultRequestParams()
Config()
addHash()
parse()
mapInterval()

$settings
$debug
$gateway
$api_version
$config_file
$preset_file
$default_config_file
$map

N/A

Properties

$settings

$settings :\stdClass

Type

\stdClass—A setup object

$debug

$debug :

Type

$gateway

$gateway :

Type

$api_version

$api_version :

Type

$config_file

$config_file :

Type

$preset_file

$preset_file :

Type

$default_config_file

$default_config_file :

Type

$map

$map :

Type

Methods

__construct()

__construct()

GetFormPreset()

GetFormPreset(): \FAA\obj\Result

Get the form preset

Returns

\FAA\obj\Result —

A system result object

GetDefaultSettings()

GetDefaultSettings(): \FAA\obj\Result

Load default settings

Returns

\FAA\obj\Result —

A system result object

GetSettings()

GetSettings(): \FAA\obj\Result

Load the settings

Returns

\FAA\obj\Result —

A system result object

StoreSettings()

StoreSettings(\stdClass  $values): \FAA\obj\Result

Save settings

Parameters

\stdClass

$values

The configuration values

Returns

\FAA\obj\Result —

A system result object

BasketProcessable()

BasketProcessable(\FAA\Obj\Generic\Basket  $basket): \FAA\obj\Result

Check if the basket can be processed using this method

This method supports all known delivery methods and recurring payments

Parameters

\FAA\Obj\Generic\Basket

$basket

A system basket object

Returns

\FAA\obj\Result —

A system result object

RequireRedirect()

RequireRedirect(): boolean

Has redirect clause Return true when this payment method requires a redirect on place order

Returns

boolean —

Does require a redirect

StatusAfterDone()

StatusAfterDone(): string

The status after done The basket status after this method was processed successfully

Returns

string —

The status when successfully

RegisterOrder()

RegisterOrder(\FAA\Obj\Generic\Basket  $basket,\FAA\Obj\Request  $request): \FAA\Obj\Result

register order callback called on register order of related basket

Parameters

\FAA\Obj\Generic\Basket	$basket	A system basket object
\FAA\Obj\Request	$request	The related http request

Returns

\FAA\Obj\Result —

A system result object

ThreeDIframe()

ThreeDIframe(): boolean

Expose 3d secure config

Show the upstream caller whether the 3d secure iframe mode is enabled or, not

Returns

boolean

SettingsValid()

SettingsValid(): boolean

Check configuration

Make sure that either a shop or an account portal is completely configured

Returns

boolean

CheckRequestPayload()

CheckRequestPayload(boolean  $shop = true): array|null

Get payload for client

Get the payload for client lib to check for validity of credit cards

Parameters

boolean

$shop

Returns

array|null

CancelSubscription()

CancelSubscription(string  $id): \FAA\obj\Result

Cancel a subscription

Parameters

string

$id

The remote access id

Returns

\FAA\obj\Result —

The result object

UpdateUser()

UpdateUser(\FAA\Obj\Generic\User  $owner,\FAA\obj\Result  $result)

Called on after save of customer

Parameters

\FAA\Obj\Generic\User	$owner	A system user
\FAA\obj\Result	$result	A hook result object

PayPalGet()

PayPalGet(\FAA\Obj\Generic\Basket  $basket): \FAA\obj\Result

Called when returning successful from paypal page

Will trigger the second call to paypal to get the payment details and then it will call the pre authorise endpoint using the paypal mode

Parameters

\FAA\Obj\Generic\Basket

$basket

The fetched basket object

Returns

\FAA\obj\Result —

A system result object

Capture()

Capture(\FAA\Obj\Generic\Basket  $basket,array  $data,string  $mode): \FAA\obj\Result

Capture callback

Used in the transaction handler to capture the payment that has been pre authorised first. May be called multiple times when several payments wehere given or, it is linked to an recurring payment.

Parameters

\FAA\Obj\Generic\Basket	$basket	The basket object to handle
array	$data	The post request data sequencenumber string Sequence number for this transaction within the payment process (1..n) txid string The pay one transaction id
string	$mode	The mode, either shop or account

Returns

\FAA\obj\Result —

A system result object

PlaceOrder()

PlaceOrder(\FAA\Obj\Generic\Basket  $basket,\FAA\Obj\Request  $request): \FAA\obj\Result

Place the order using credit card data

This method uses similar information than paypal but requires the cc.pseudo_card_pan to be present in the request body as well as the cc.truncated_card_pan. It support recurring payments for single article baskets and full feature for regular baskets

Parameters

\FAA\Obj\Generic\Basket	$basket	A system basket object
\FAA\Obj\Request	$request	The related http request

Returns

\FAA\obj\Result

CalculatePrice()

CalculatePrice(): \FAA\obj\Result

Calculate the price including the fee for this method

Returns

\FAA\obj\Result —

A system result object

detectClearingType()

detectClearingType(array  $prepared_data,array  $params,\FAA\Obj\Generic\Basket  $basket,\FAA\obj\Result  $result)

Detect and register clearing type information

Parameters

array	$prepared_data	The request body
array	$params	The payone request data
\FAA\Obj\Generic\Basket	$basket	The current basket object
\FAA\obj\Result	$result	A system result type

addCustomerInfo()

addCustomerInfo(array  $params,array  $bill,array  $delivery)

Add information about the customer

Parameters

array	$params	The request to payone
array	$bill	The billing data
array	$delivery	The delivery address or, null

addArticles()

addArticles(  $params,  $articles,  $l,string  $prefix = '')

Parameters

	$params
	$articles	Article[]
	$l
string	$prefix	When given the goods type wont be included

buildPreAuthoriseRequest()

buildPreAuthoriseRequest(  $shop,\FAA\Obj\Generic\Basket  $basket,  $params,  $owner,  $l,  $list)

Parameters

	$shop	bool
\FAA\Obj\Generic\Basket	$basket	The currently processed basket
	$params	array
	$owner	User
	$l	string
	$list	Article[]

request()

request(  $params)

Parameters

$params

sendWarning()

sendWarning(\FAA\obj\Result  $result)

Parameters

\FAA\obj\Result

$result

defaultRequestParams()

defaultRequestParams()

Config()

Config(): \FAA\Handler\PaymentMethod\BsPayOne\Settings|null

connect load settings object from local storage

Returns

\FAA\Handler\PaymentMethod\BsPayOne\Settings|null

addHash()

addHash(  $data,  $md5 = false,  $shop = true)

Parameters

	$data
	$md5
	$shop

parse()

parse(  $str)

Parameters

$str

mapInterval()

mapInterval(  $key)

Parameters

$key