Public Member Functions
	__construct ($merchant_id, $access_key, $proxy_host, $proxy_port, $proxy_login, $proxy_password, $environment, $pathLog=null, $logLevel=200, $externalLogger=null, $defaultTimezone="Europe/Paris")

	setSoapOptions ($key, $value=null)

	getSoapOptions ($key=null)

	setFailoverOptions ($key, $value=null)

	getFailoverOptions ($key=null)

	reset ()

	resetFailoverOptions ()

	resetOrderDetails ()

	resetPrivateData ()

	privateDataList ()

	getDefaultWSRequest ($Method)

	usedBy ($toolName)

	getLogger ()

	addOrderDetail (array $newOrderDetail)

	addPrivateData (array $array)

	doAuthorization (array $array)

	doCapture (array $array)

	doReAuthorization (array $array)

	doDebit (array $array)

	doRefund ($array)

	doReset (array $array)

	doCredit (array $array)

	createWallet (array $array)

	updateWallet (array $array)

	getWallet (array $array)

	getCards (array $array)

	disableWallet (array $array)

	enableWallet (array $array)

	doImmediateWalletPayment (array $array)

	doScheduledWalletPayment (array $array)

	doRecurrentWalletPayment (array $array)

	getPaymentRecord (array $array)

	disablePaymentRecord (array $array)

	verifyEnrollment (array $array)

	verifyAuthentication (array $array)

	doScoringCheque (array $array)

	getEncryptionKey (array $array)

	getMerchantSettings (array $array)

	getBalance (array $array)

	getToken (array $array)

	unBlock (array $array)

	updatePaymentRecord (array $array)

	getBillingRecord (array $array)

	updateBillingRecord (array $array)

	doBankTransfer (array $array)

	isRegistered (array $array)

	prepareSession (array $array)

	doWebPayment (array $array)

	doAuthorizationRedirect (array $array)

	getWebPaymentDetails (array $array)

	manageWebWallet (array $array)

	createWebWallet (array $array)

	updateWebWallet (array $array)

	getWebWallet (array $array)

	getTransactionDetails (array $array)

	transactionsSearch (array $array)

	getAlertDetails (array $array)

	base64_url_encode ($input)

	base64_url_decode ($input)

	getEncrypt ($message, $accessKey)

	getDecrypt ($message, $accessKey)

	gzdecode ($data, &$filename='', &$error='', $maxlength=null)

	getSoapLastContent ($key='', $beautifuler=true)

Public Attributes
const	SDK_RELEASE = 'PHP SDK 25.9'

const	ENV_DEV = "DEV"

const	ENV_INT = "INT"

const	ENV_HOMO = "HOMO"

const	ENV_HOMO_CC = "HOMO_CC"

const	ENV_PROD = "PROD"

const	ENV_PROD_CC = "PROD_CC"

const	DIRECT_API = 'DirectPaymentAPI'

const	EXTENDED_API = 'ExtendedAPI'

const	WEB_API = 'WebPaymentAPI'

const	SOAP_AUTHORIZATION = 'authorization'

const	SOAP_CARD = 'card'

const	SOAP_ORDERDETAIL = 'orderDetail'

const	SOAP_PAYMENT_DATA = 'paymentData'

const	SOAP_PRIVATE_DATA = 'privateData'

const	SOAP_ADDRESS = 'address'

const	SOAP_CHEQUE = 'cheque'

const	SOAP_CREDITOR = 'creditor'

const	SOAP_BILLING_RECORD_FOR_UPDATE = 'billingRecordForUpdate'

const	SOAP_RECURRING = 'recurring'

const	SOAP_MERCHANT_AUTHENTICATION = 'merchantAuthentication'

const	SOAP_WALLET = 'wallet'

const	HOMO_SERVICES_ENDPOINT = 'https://homologation-payment.payline.com/services/servicesendpoints/SOAP'

const	PROD_SERVICES_ENDPOINT = 'https://payment.payline.com/services/servicesendpoints/SOAP'

const	DEV_ENDPOINT = 'https://ws.dev.payline.com/V4/services/'

const	INT_ENDPOINT = 'https://ws.int.payline.com/V4/services/'

const	HOMO_ENDPOINT = 'https://homologation.payline.com/V4/services/'

const	HOMO_CC_ENDPOINT = 'https://homologation-cc.payline.com/V4/services/'

const	PROD_ENDPOINT = 'https://services.payline.com/V4/services/'

const	PROD_CC_ENDPOINT = 'https://services-cc.payline.com/V4/services/'

const	DEV_GET_TOKEN_SERVLET = "https://webpayment.dev.payline.com/webpayment/getToken"

const	INT_GET_TOKEN_SERVLET = "https://webpayment.int.payline.com/webpayment/getToken"

const	HOMO_GET_TOKEN_SERVLET = "https://homologation-webpayment.payline.com/webpayment/getToken"

const	PROD_GET_TOKEN_SERVLET = "https://webpayment.payline.com/webpayment/getToken"

const	DEV_WDGT_JS = "https://webpayment.dev.payline.com/payline-widget/scripts/widget-min.js"

const	HOMO_WDGT_JS = "https://homologation-payment.payline.com/scripts/widget-min.js"

const	PROD_WDGT_JS = "https://payment.payline.com/scripts/widget-min.js"

const	DEV_WDGT_CSS = "https://webpayment.dev.payline.com/payline-widget/styles/widget-min.css"

const	HOMO_WDGT_CSS = "https://homologation-payment.payline.com/styles/widget-min.css"

const	PROD_WDGT_CSS = "https://payment.payline.com/styles/widget-min.css"

const	HOMO_CA = 'https://homologation-admin.payline.com'

const	PROD_CA = 'https://admin.payline.com'

const	ERR_CODE = 'XXXXX'

const	ERR_SHORT_MESSAGE = 'ERROR'

Protected Member Functions
	paymentData (array $array)

	card (array $array)

	address (array $array)

	billingRecordForUpdate (array $array)

	wallet (array $array, array $shippingAddress=array(), array $card=array())

	authorization (array $array)

	creditor (array $array)

	cheque (array $array)

	recurring (array $array)

	merchantAuthentication (array $array)

	hideChars ($inString, $n1, $n2)

	isChildFromList ($nodeName, $parentName=null)

	responseToArray ($node, $parent=null)

	createSoapVarObject ($elementKey, $array)

	completeWSRequest (array $array, $WSRequest, $PaylineAPI, $Method)

	getApiForMethod ($Method)

	webServiceRequest (array $array, array $WSRequest, $PaylineAPI, $Method)

	buildSoapObject (array $array, $object, $typeName)

	fillObject (array $array, $object)

	userDataIsNotEmpty ($data)

	beautifulerXML (&$xml, $key)

Protected Attributes
	$webServicesEndpoint

	$logger

	$loggerPath

	$usedBy = null

	$orderDetails

	$privateData

	$parentNode

	$apiByMethod

	$servicesEndpoint

	$soapclientOptions = array()

	$failoverOptions = array()

	$lastSoapCallData = array()

Private Member Functions
	formatRequest (&$array)

Constructor & Destructor Documentation

◆ __construct()

Payline\PaylineSDK::__construct	(	$merchant_id,
		$access_key,
		$proxy_host,
		$proxy_port,
		$proxy_login,
		$proxy_password,
		$environment,
		$pathLog = `null`,
		$logLevel = `200`,
		$externalLogger = `null`,
		$defaultTimezone = `"Europe/Paris"`
	)

PaylineSDK class constructor

Parameters

string	$merchant_id	the merchant identifier
string	$access_key	the access key generated in Payline Administration Center
string	$proxy_host	host of your proxy (set null if no proxy)
string	$proxy_port	port used by your proxy (set null if no proxy)
string	$proxy_login	login required by your proxy (set null if no proxy)
string	$proxy_password	password required by your proxy (set null if no proxy)
string	$environment	target Payline environment : set PaylineSDK::ENV_HOMO for homologation, PaylineSDK::ENV_PROD for production
string	$pathLog	path to your custom log folder, must end by directory separator. If null, default logs folder is used. Default : null
int	$logLevel	log level. Default : \Monolog\Logger::INFO
Logger	$externalLogger	\Monolog\Logger instance, used by PaylineSDK but external to it

Member Function Documentation

◆ setSoapOptions()

Payline\PaylineSDK::setSoapOptions	(	$key,
		$value = `null`
	)

Set option passed to SoapClient

Parameters

	$key	style use connection_timeout trace soap_client (use of custom Soap client will disable failover mechanism)
null	$value

Returns: $this

Exceptions

Exception

◆ getSoapOptions()

Payline\PaylineSDK::getSoapOptions ( $key = null )

◆ setFailoverOptions()

Payline\PaylineSDK::setFailoverOptions	(	$key,
		$value = `null`
	)

Parameters

	$key	disabled => true, false cache_pool => file (default), apc cache_file_path => directory path to store file cache cache_namespace cache_default_ttl *
null	$value

Returns: $this

Exceptions

Exception

◆ getFailoverOptions()

Payline\PaylineSDK::getFailoverOptions ( $key = null )

Parameters

$key

Returns: array|mixed|null

◆ reset()

Payline\PaylineSDK::reset ( )

Returns: $this

◆ resetFailoverOptions()

Payline\PaylineSDK::resetFailoverOptions ( )

◆ resetOrderDetails()

Payline\PaylineSDK::resetOrderDetails ( )

reset OrderDetails

◆ resetPrivateData()

Payline\PaylineSDK::resetPrivateData ( )

reset Private Data

◆ privateDataList()

Payline\PaylineSDK::privateDataList ( )

get Private Data

◆ paymentData()

Payline\PaylineSDK::paymentData ( array $array )

protected

build PaymentData instance from $array and make SoapVar object for payment

Deprecated:

Parameters

array $array the array keys are listed in PaymentData class

Returns: SoapVar representation of PaymentData instance

◆ card()

Payline\PaylineSDK::card ( array $array )

protected

build Card instance from $array and make SoapVar object for card

Deprecated:

Parameters

array $array the array keys are listed in Card CLASS.

Returns: SoapVar representation of Card instance

◆ address()

Payline\PaylineSDK::address ( array $array )

protected

build Address instance from $array and make SoapVar object for address.

Deprecated:

Parameters

array $array the array keys are listed in Address CLASS.

Returns: SoapVar representation of Address instance

◆ billingRecordForUpdate()

Payline\PaylineSDK::billingRecordForUpdate ( array $array )

protected

build BillingRecordForUpdate instance from $array and make SoapVar object for billingRecordForUpdate

Deprecated:

Parameters

array $array the array keys are listed in BillingRecordForUpdate CLASS.

Returns: SoapVar representation of BillingRecordForUpdate instance

◆ wallet()

Payline\PaylineSDK::wallet	(	array	$array,
		array	$shippingAddress = `array()`,
		array	$card = `array()`
	)

protected

build Wallet instance from $array and make SoapVar object for wallet

Deprecated:

Parameters

array	$array	the array keys are listed in Wallet CLASS.
array	$shippingAddress	the array keys are listed in Address CLASS.
array	$card	the array keys are listed in Card CLASS.

Returns: SoapVar representation of Wallet instance

◆ authorization()

Payline\PaylineSDK::authorization ( array $array )

protected

build Authorization instance from $array and make SoapVar object for authorization

Deprecated:

Parameters

array $array the array keys are listed in Authorization CLASS.

Returns: SoapVar representation of Authorization instance

◆ creditor()

Payline\PaylineSDK::creditor ( array $array )

protected

build Creditor instance from $array and make SoapVar object for creditor

Deprecated:

Parameters

array $array the array keys are listed in Creditor CLASS.

Returns: SoapVar representation of Creditor instance

◆ cheque()

Payline\PaylineSDK::cheque ( array $array )

protected

build Cheque instance from $array and make SoapVar object for cheque

Deprecated:

Parameters

array $array the array keys are listed in Cheque CLASS.

Returns: SoapVar representation of Cheque instance

◆ recurring()

Payline\PaylineSDK::recurring ( array $array )

protected

build Recurring instance from $array and make SoapVar object for recurring

Deprecated:

Parameters

array $array the array keys are listed in Recurring CLASS.

Returns: SoapVar representation of Recurring instance

◆ merchantAuthentication()

Payline\PaylineSDK::merchantAuthentication ( array $array )

protected

build MerchantAuthentication instance from $array and make SoapVar object for merchantAuthentication

Deprecated:

Parameters

array $array the array keys list in MerchantAuthentication CLASS.

Returns: SoapVar representation of MerchantAuthentication instance

◆ hideChars()

Payline\PaylineSDK::hideChars	(	$inString,
		$n1,
		$n2
	)

protected

Hide characters in a string

Parameters

String	$inString	the string to hide
int	$n1	number of characters shown at the begining of the string
int	$n2	number of characters shown at end begining of the string

◆ isChildFromList()

Payline\PaylineSDK::isChildFromList	(	$nodeName,
		$parentName = `null`
	)

protected

Parameters

String	$nodeName	name of a node in a web service response
null \| String	$parentName	name of its parent

Returns: boolean whether $nodeName is child from a list or not

◆ responseToArray()

Payline\PaylineSDK::responseToArray	(	$node,
		$parent = `null`
	)

protected

make an array from a payline server response object.

Parameters

object	$node	response node from payline web service
string	$parent	name of the node's parent

Returns: array representation of the object

◆ formatRequest()

Payline\PaylineSDK::formatRequest ( & $array )

private

Adds indexes with empty values to the web services request array, in order to prevent SOAP format exception

Parameters

array $array associative array containing web services parameters

◆ createSoapVarObject()

Payline\PaylineSDK::createSoapVarObject	(	$elementKey,
		$array
	)

protected

◆ completeWSRequest()

Payline\PaylineSDK::completeWSRequest	(	array	$array,
			$WSRequest,
			$PaylineAPI,
			$Method
	)

protected

Complete $WSRequest according wsdl definition (much more efficient than parsing with xpath)

Parameters

array	$array
	$WSRequest
	$PaylineAPI
	$Method

Returns: mixed

◆ getDefaultWSRequest()

Payline\PaylineSDK::getDefaultWSRequest ( $Method )

◆ getApiForMethod()

Payline\PaylineSDK::getApiForMethod ( $Method )

protected

Parameters

$Method

Returns: false|string

◆ webServiceRequest()

Payline\PaylineSDK::webServiceRequest	(	array	$array,
		array	$WSRequest,
			$PaylineAPI,
			$Method
	)

protected

Create the SoapClient instance and make the web service call

Parameters

array	$array	the associative array passed to the public function
array	$WSRequest	the SOAP-formated request
string	$PaylineAPI	the Payline API to be called
string	$Method	the name of the web service

◆ usedBy()

Payline\PaylineSDK::usedBy ( $toolName )

Sets the name of the tool using this library (Magento for example...) Info is sent in HTTP header, an retrieved in "Technical monitoring of web services" screen of administration center

Parameters

string $toolName name of the tool using this library

◆ getLogger()

Payline\PaylineSDK::getLogger ( )

Returns: Logger \Monolog\Logger instance

◆ addOrderDetail()

Payline\PaylineSDK::addOrderDetail ( array $newOrderDetail )

Adds details about an order item

Parameters

array $newOrderDetail associative array containing details about an order item

◆ addPrivateData()

Payline\PaylineSDK::addPrivateData ( array $array )

Adds a privateData element

Parameters

array $array an array containing two indexes : key and value

◆ doAuthorization()

Payline\PaylineSDK::doAuthorization ( array $array )

calls doAuthorization web service

Parameters

array $array associative array containing doAuthorization parameters

◆ doCapture()

Payline\PaylineSDK::doCapture ( array $array )

calls doCapture web service

Parameters

array $array associative array containing doCapture parameters

◆ doReAuthorization()

Payline\PaylineSDK::doReAuthorization ( array $array )

calls doReAuthorization web service

Parameters

array $array associative array containing doReAuthorization parameters

◆ doDebit()

Payline\PaylineSDK::doDebit ( array $array )

calls doDebit web service

Parameters

array $array associative array containing doDebit parameters

◆ doRefund()

Payline\PaylineSDK::doRefund ( $array )

calls doRefund web service

Parameters

array $array associative array containing doRefund parameters

◆ doReset()

Payline\PaylineSDK::doReset ( array $array )

calls doReset web service

Parameters

array $array associative array containing doReset parameters

◆ doCredit()

Payline\PaylineSDK::doCredit ( array $array )

calls doCredit web service

Parameters

array $array associative array containing doCredit parameters

◆ createWallet()

Payline\PaylineSDK::createWallet ( array $array )

calls createWallet web service

Parameters

array $array associative array containing createWallet parameters

◆ updateWallet()

Payline\PaylineSDK::updateWallet ( array $array )

calls updateWallet web service

Parameters

array $array associative array containing updateWallet parameters

◆ getWallet()

Payline\PaylineSDK::getWallet ( array $array )

calls getWallet web service

Parameters

array $array associative array containing getWallet parameters

◆ getCards()

Payline\PaylineSDK::getCards ( array $array )

calls getCards web service

Parameters

array $array associative array containing getCards parameters

◆ disableWallet()

Payline\PaylineSDK::disableWallet ( array $array )

calls disableWallet web service

Parameters

array $array associative array containing disableWallet parameters

◆ enableWallet()

Payline\PaylineSDK::enableWallet ( array $array )

calls enableWallet web service

Parameters

array $array associative array containing enableWallet parameters

◆ doImmediateWalletPayment()

Payline\PaylineSDK::doImmediateWalletPayment ( array $array )

calls doImmediateWalletPayment web service

Parameters

array $array associative array containing doImmediateWalletPayment parameters

◆ doScheduledWalletPayment()

Payline\PaylineSDK::doScheduledWalletPayment ( array $array )

calls doScheduledWalletPayment web service

Parameters

array $array associative array containing doScheduledWalletPayment parameters

◆ doRecurrentWalletPayment()

Payline\PaylineSDK::doRecurrentWalletPayment ( array $array )

calls doRecurrentWalletPayment web service

Parameters

array $array associative array containing doRecurrentWalletPayment parameters

◆ getPaymentRecord()

Payline\PaylineSDK::getPaymentRecord ( array $array )

calls getPaymentRecord web service

Parameters

array $array associative array containing getPaymentRecord parameters

◆ disablePaymentRecord()

Payline\PaylineSDK::disablePaymentRecord ( array $array )

calls disablePaymentRecord web service

Parameters

array $array associative array containing disablePaymentRecord parameters

◆ verifyEnrollment()

Payline\PaylineSDK::verifyEnrollment ( array $array )

calls verifyEnrollment web service

Parameters

array $array associative array containing verifyEnrollment parameters

◆ verifyAuthentication()

Payline\PaylineSDK::verifyAuthentication ( array $array )

calls verifyAuthentication web service

Parameters

array $array associative array containing verifyAuthentication parameters

◆ doScoringCheque()

Payline\PaylineSDK::doScoringCheque ( array $array )

calls doScoringCheque web service

Parameters

array $array associative array containing doScoringCheque parameters

◆ getEncryptionKey()

Payline\PaylineSDK::getEncryptionKey ( array $array )

calls getEncryptionKey web service

Parameters

array $array associative array containing getEncryptionKey parameters

◆ getMerchantSettings()

Payline\PaylineSDK::getMerchantSettings ( array $array )

calls getMerchantSettings web service

Parameters

array $array associative array containing getMerchantSettings parameters

◆ getBalance()

Payline\PaylineSDK::getBalance ( array $array )

calls getBalance web service

Parameters

array $array associative array containing getBalance parameters

◆ getToken()

Payline\PaylineSDK::getToken ( array $array )

calls getToken web service

Parameters

array $array associative array containing getToken parameters

◆ unBlock()

Payline\PaylineSDK::unBlock ( array $array )

calls unBlock web service

Parameters

array $array associative array containing getBalance parameters

◆ updatePaymentRecord()

Payline\PaylineSDK::updatePaymentRecord ( array $array )

calls updatePaymentRecord web service

Parameters

array $array associative array containing updatePaymentRecord parameters

◆ getBillingRecord()

Payline\PaylineSDK::getBillingRecord ( array $array )

calls getBillingRecord web service

Parameters

array $array associative array containing getBillingRecord parameters

◆ updateBillingRecord()

Payline\PaylineSDK::updateBillingRecord ( array $array )

calls updateBillingRecord web service

Parameters

array $array associative array containing updateBillingRecord parameters

◆ doBankTransfer()

Payline\PaylineSDK::doBankTransfer ( array $array )

calls doBankTransfer web service

Parameters

array $array associative array containing doBankTransfer parameters

◆ isRegistered()

Payline\PaylineSDK::isRegistered ( array $array )

calls isRegistered web service

Parameters

array $array associative array containing isRegistered parameters

◆ prepareSession()

Payline\PaylineSDK::prepareSession ( array $array )

calls prepareSession web service

Parameters

array $array associative array containing prepareSession parameters

◆ doWebPayment()

Payline\PaylineSDK::doWebPayment ( array $array )

calls doWebPayment web service

Parameters

array $array associative array containing doWebPayment parameters

◆ doAuthorizationRedirect()

Payline\PaylineSDK::doAuthorizationRedirect ( array $array )

calls doAuthorizationRedirect web service

Parameters

array $array associative array containing doAuthorizationRedirectRequest parameters

◆ getWebPaymentDetails()

Payline\PaylineSDK::getWebPaymentDetails ( array $array )

calls doWebPayment web service

Parameters

array $array associative array containing getWebPaymentDetails parameters

◆ manageWebWallet()

Payline\PaylineSDK::manageWebWallet ( array $array )

calls manageWebWallet web service

Parameters

array $array associative array containing manageWebWallet parameters

◆ createWebWallet()

Payline\PaylineSDK::createWebWallet ( array $array )

calls createWebWallet web service

Parameters

array $array associative array containing createWebWallet parameters

◆ updateWebWallet()

Payline\PaylineSDK::updateWebWallet ( array $array )

calls updateWebWallet web service

Parameters

array $array associative array containing updateWebWallet parameters

◆ getWebWallet()

Payline\PaylineSDK::getWebWallet ( array $array )

calls getWebWallet web service

Parameters

array $array associative array containing getWebWallet parameters

◆ getTransactionDetails()

Payline\PaylineSDK::getTransactionDetails ( array $array )

calls getTransactionDetails web service

Parameters

array $array associative array containing getWebWallet parameters

◆ transactionsSearch()

Payline\PaylineSDK::transactionsSearch ( array $array )

calls transactionsSearch web service

Parameters

array $array associative array containing getWebWallet parameters

◆ getAlertDetails()

Payline\PaylineSDK::getAlertDetails ( array $array )

calls getAlertDetails web service

Parameters

array $array associative array containing getAlertDetails parameters

◆ base64_url_encode()

Payline\PaylineSDK::base64_url_encode ( $input )

End API methods

Custom base64 url encoding. Replace unsafe url chars

Parameters

string $input message to encode

Returns: string

◆ base64_url_decode()

Payline\PaylineSDK::base64_url_decode ( $input )

Custom base64 url decode. Replace custom url safe values with normal base64 characters before decoding.

Parameters

string $input message to decode

Returns: string

◆ getEncrypt()

Payline\PaylineSDK::getEncrypt	(	$message,
		$accessKey
	)

AES compliant encryption (uses MCRYPT_RIJNDAEL_128). This function is used to build authentication data for getToken servlet

Parameters

string	$message	message to encrypt
string	$accessKey	merchant access key (SHA256 encrypted)

Returns: string encrypted message

◆ getDecrypt()

Payline\PaylineSDK::getDecrypt	(	$message,
		$accessKey
	)

Decrypts message sent by getToken servlet

Parameters

string	$message	message to decrypt
string	$accessKey	merchant access key (SHA256 encrypted)

◆ gzdecode()

Payline\PaylineSDK::gzdecode	(		$data,
		&	$filename = `''`,
		&	$error = `''`,
			$maxlength = `null`
	)

Unzip data

Parameters

string	$data	decrypted message sent by getToken servlet
string	$filename
string	$error
int	$maxlength

Returns: NULL|boolean|string

◆ buildSoapObject()

Payline\PaylineSDK::buildSoapObject	(	array	$array,
			$object,
			$typeName
	)

protected

Building Soap Objects

Deprecated:: , should use SoapVarFactory

Deprecated:

Parameters

array	$array
	$object
	$typeName

Returns: SoapVar

◆ fillObject()

Payline\PaylineSDK::fillObject	(	array	$array,
			$object
	)

protected

Deprecated:

Parameters

array	$array
	$object

Returns: mixed

◆ userDataIsNotEmpty()

Payline\PaylineSDK::userDataIsNotEmpty ( $data )

protected

Test user data

Deprecated:

Parameters

$data

Returns: bool

◆ beautifulerXML()

Payline\PaylineSDK::beautifulerXML	(	&	$xml,
			$key
	)

protected

Other tools

Pretty print XML

Parameters

$xml
$key

Returns: void

◆ getSoapLastContent()

Payline\PaylineSDK::getSoapLastContent	(	$key = `''`,
		$beautifuler = `true`
	)

Parameters

string	$key	Request RequestHeaders Response ResponseHeaders HttpHeaders
boolean	$beautifuler

Returns: array

Member Data Documentation

◆ SDK_RELEASE

const Payline\PaylineSDK::SDK_RELEASE = 'PHP SDK 25.9'

Payline release corresponding to this version of the package

See also: https://docs.payline.com/display/DT/API+version+history

◆ ENV_DEV

const Payline\PaylineSDK::ENV_DEV = "DEV"

development environment flag

◆ ENV_INT

const Payline\PaylineSDK::ENV_INT = "INT"

integration environment flag

◆ ENV_HOMO

const Payline\PaylineSDK::ENV_HOMO = "HOMO"

homologation environment flag

◆ ENV_HOMO_CC

const Payline\PaylineSDK::ENV_HOMO_CC = "HOMO_CC"

homologation environment flag - uses certificate-based authentication

◆ ENV_PROD

const Payline\PaylineSDK::ENV_PROD = "PROD"

production environment flag

◆ ENV_PROD_CC

const Payline\PaylineSDK::ENV_PROD_CC = "PROD_CC"

production environment flag - uses certificate-based authentication

◆ DIRECT_API

const Payline\PaylineSDK::DIRECT_API = 'DirectPaymentAPI'

name of Payline DirectPaymentAPI

◆ EXTENDED_API

const Payline\PaylineSDK::EXTENDED_API = 'ExtendedAPI'

name of Payline ExtendedAPI

◆ WEB_API

const Payline\PaylineSDK::WEB_API = 'WebPaymentAPI'

name of Payline WebPaymentAPI

◆ SOAP_AUTHORIZATION

const Payline\PaylineSDK::SOAP_AUTHORIZATION = 'authorization'

SOAP name of authorization object

◆ SOAP_CARD

const Payline\PaylineSDK::SOAP_CARD = 'card'

SOAP name of card object

◆ SOAP_ORDERDETAIL

const Payline\PaylineSDK::SOAP_ORDERDETAIL = 'orderDetail'

SOAP name of orderDetail object

◆ SOAP_PAYMENT_DATA

const Payline\PaylineSDK::SOAP_PAYMENT_DATA = 'paymentData'

SOAP name of paymentData object

◆ SOAP_PRIVATE_DATA

const Payline\PaylineSDK::SOAP_PRIVATE_DATA = 'privateData'

SOAP name of privateData object

◆ SOAP_ADDRESS

const Payline\PaylineSDK::SOAP_ADDRESS = 'address'

SOAP name of address object

◆ SOAP_CHEQUE

const Payline\PaylineSDK::SOAP_CHEQUE = 'cheque'

SOAP name of cheque object

◆ SOAP_CREDITOR

const Payline\PaylineSDK::SOAP_CREDITOR = 'creditor'

SOAP name of creditor object

◆ SOAP_BILLING_RECORD_FOR_UPDATE

const Payline\PaylineSDK::SOAP_BILLING_RECORD_FOR_UPDATE = 'billingRecordForUpdate'

SOAP name of billingRecordForUpdate object

◆ SOAP_RECURRING

const Payline\PaylineSDK::SOAP_RECURRING = 'recurring'

SOAP name of recurring object

◆ SOAP_MERCHANT_AUTHENTICATION

const Payline\PaylineSDK::SOAP_MERCHANT_AUTHENTICATION = 'merchantAuthentication'

SOAP name of merchantAuthentication object

◆ SOAP_WALLET

const Payline\PaylineSDK::SOAP_WALLET = 'wallet'

SOAP name of wallet object

◆ HOMO_SERVICES_ENDPOINT

const Payline\PaylineSDK::HOMO_SERVICES_ENDPOINT = 'https://homologation-payment.payline.com/services/servicesendpoints/SOAP'

directory services endpoint in production environment

◆ PROD_SERVICES_ENDPOINT

const Payline\PaylineSDK::PROD_SERVICES_ENDPOINT = 'https://payment.payline.com/services/servicesendpoints/SOAP'

directory services endpoint in development environment

◆ DEV_ENDPOINT

const Payline\PaylineSDK::DEV_ENDPOINT = 'https://ws.dev.payline.com/V4/services/'

web services endpoint in development environment

◆ INT_ENDPOINT

const Payline\PaylineSDK::INT_ENDPOINT = 'https://ws.int.payline.com/V4/services/'

web services endpoint in integration environment

◆ HOMO_ENDPOINT

const Payline\PaylineSDK::HOMO_ENDPOINT = 'https://homologation.payline.com/V4/services/'

standard web services endpoint in homologation environment

◆ HOMO_CC_ENDPOINT

const Payline\PaylineSDK::HOMO_CC_ENDPOINT = 'https://homologation-cc.payline.com/V4/services/'

certificate-based authentication web services endpoint in homologation environment

◆ PROD_ENDPOINT

const Payline\PaylineSDK::PROD_ENDPOINT = 'https://services.payline.com/V4/services/'

standard web services endpoint in production environment

◆ PROD_CC_ENDPOINT

const Payline\PaylineSDK::PROD_CC_ENDPOINT = 'https://services-cc.payline.com/V4/services/'

certificate-based authentication web services endpoint in production environment

◆ DEV_GET_TOKEN_SERVLET

const Payline\PaylineSDK::DEV_GET_TOKEN_SERVLET = "https://webpayment.dev.payline.com/webpayment/getToken"

URL of getToken servlet, used by AJAX API, in development environment

◆ INT_GET_TOKEN_SERVLET

const Payline\PaylineSDK::INT_GET_TOKEN_SERVLET = "https://webpayment.int.payline.com/webpayment/getToken"

URL of getToken servlet, used by AJAX API, in integration environment

◆ HOMO_GET_TOKEN_SERVLET

const Payline\PaylineSDK::HOMO_GET_TOKEN_SERVLET = "https://homologation-webpayment.payline.com/webpayment/getToken"

URL of getToken servlet, used by AJAX API, in homologation environment

◆ PROD_GET_TOKEN_SERVLET

const Payline\PaylineSDK::PROD_GET_TOKEN_SERVLET = "https://webpayment.payline.com/webpayment/getToken"

URL of getToken servlet, used by AJAX API, in production environment

◆ DEV_WDGT_JS

const Payline\PaylineSDK::DEV_WDGT_JS = "https://webpayment.dev.payline.com/payline-widget/scripts/widget-min.js"

Widget JavaScript in development environment

◆ HOMO_WDGT_JS

const Payline\PaylineSDK::HOMO_WDGT_JS = "https://homologation-payment.payline.com/scripts/widget-min.js"

Widget JavaScript in homologation environment

◆ PROD_WDGT_JS

const Payline\PaylineSDK::PROD_WDGT_JS = "https://payment.payline.com/scripts/widget-min.js"

Widget JavaScript in production environment

◆ DEV_WDGT_CSS

const Payline\PaylineSDK::DEV_WDGT_CSS = "https://webpayment.dev.payline.com/payline-widget/styles/widget-min.css"

Widget css in development environment

◆ HOMO_WDGT_CSS

const Payline\PaylineSDK::HOMO_WDGT_CSS = "https://homologation-payment.payline.com/styles/widget-min.css"

Widget css in homologation environment

◆ PROD_WDGT_CSS

const Payline\PaylineSDK::PROD_WDGT_CSS = "https://payment.payline.com/styles/widget-min.css"

Widget css in production environment

◆ HOMO_CA

const Payline\PaylineSDK::HOMO_CA = 'https://homologation-admin.payline.com'

homologation administration center URL

◆ PROD_CA

const Payline\PaylineSDK::PROD_CA = 'https://admin.payline.com'

administration center URL

◆ ERR_CODE

const Payline\PaylineSDK::ERR_CODE = 'XXXXX'

error code/shortMessage returned when Payline can't be reached

◆ ERR_SHORT_MESSAGE

const Payline\PaylineSDK::ERR_SHORT_MESSAGE = 'ERROR'

◆ $webServicesEndpoint

Payline\PaylineSDK::$webServicesEndpoint

protected

◆ $logger

Payline\PaylineSDK::$logger

protected

◆ $loggerPath

Payline\PaylineSDK::$loggerPath

protected

◆ $usedBy

Payline\PaylineSDK::$usedBy = null

protected

tool / e-commerce module using this library

◆ $orderDetails

Payline\PaylineSDK::$orderDetails

protected

array containing order details

◆ $privateData

Payline\PaylineSDK::$privateData

protected

array containing private data

◆ $parentNode

Payline\PaylineSDK::$parentNode

protected

Initial value:

= array(
        'cards'                    => 'cardsList',
        'billingRecord'            => 'billingRecordList',
        'walletId'                 => 'walletIdList',
        'transaction'              => 'transactionList',
        'pointOfSell'              => 'listPointOfSell',
        'contract'                 => 'contracts',
        'customPaymentPageCode'    => 'customPaymentPageCodeList',
        'function'                 => 'functions',
        'details'                  => 'details',
        'privateData'              => 'privateDataList',
        'associatedTransactions'   => 'associatedTransactionsList',
        'statusHistory'            => 'statusHistoryList',
        'paymentAdditional'        => 'paymentAdditionalList',
        'CustomerTrans'            => 'CustomerTransHist',
        'PaymentMeansTrans'        => 'PaymentMeansTransHist',
        'AlertsTrans'              => 'AlertsTransHist'
    )

array containing parent-child nodes associations

◆ $apiByMethod

Payline\PaylineSDK::$apiByMethod

protected

◆ $servicesEndpoint

Payline\PaylineSDK::$servicesEndpoint

protected

◆ $soapclientOptions

Payline\PaylineSDK::$soapclientOptions = array()

protected

◆ $failoverOptions

Payline\PaylineSDK::$failoverOptions = array()

protected

◆ $lastSoapCallData

Payline\PaylineSDK::$lastSoapCallData = array()

protected

The documentation for this class was generated from the following file:

CaMykS/plugin/input/PaylinePayment/Payline/PaylineSDK.php

Public Member Functions

Public Attributes

Protected Member Functions

Protected Attributes

Private Member Functions

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ setSoapOptions()

◆ getSoapOptions()

◆ setFailoverOptions()

◆ getFailoverOptions()

◆ reset()

◆ resetFailoverOptions()

◆ resetOrderDetails()

◆ resetPrivateData()

◆ privateDataList()

◆ paymentData()

◆ card()

◆ address()

◆ billingRecordForUpdate()

◆ wallet()

◆ authorization()

◆ creditor()

◆ cheque()

◆ recurring()

◆ merchantAuthentication()

◆ hideChars()

◆ isChildFromList()

◆ responseToArray()

◆ formatRequest()

◆ createSoapVarObject()

◆ completeWSRequest()

◆ getDefaultWSRequest()

◆ getApiForMethod()

◆ webServiceRequest()

◆ usedBy()

◆ getLogger()

◆ addOrderDetail()

◆ addPrivateData()

◆ doAuthorization()

◆ doCapture()

◆ doReAuthorization()

◆ doDebit()

◆ doRefund()

◆ doReset()

◆ doCredit()

◆ createWallet()

◆ updateWallet()

◆ getWallet()

◆ getCards()

◆ disableWallet()

◆ enableWallet()

◆ doImmediateWalletPayment()

◆ doScheduledWalletPayment()

◆ doRecurrentWalletPayment()

◆ getPaymentRecord()

◆ disablePaymentRecord()

◆ verifyEnrollment()

◆ verifyAuthentication()

◆ doScoringCheque()

◆ getEncryptionKey()

◆ getMerchantSettings()

◆ getBalance()

◆ getToken()

◆ unBlock()

◆ updatePaymentRecord()

◆ getBillingRecord()

◆ updateBillingRecord()

◆ doBankTransfer()

◆ isRegistered()

◆ prepareSession()

◆ doWebPayment()

◆ doAuthorizationRedirect()

◆ getWebPaymentDetails()

◆ manageWebWallet()

◆ createWebWallet()

◆ updateWebWallet()

◆ getWebWallet()

◆ getTransactionDetails()