QuixParameters Class Reference

Inheritance diagram for QuixParameters:

Public Member Functions
	__construct ()
	setCustomerNationalIdType (CustomerNationalIdTypes $customerNationalIdType)
	Sets the customer's national ID type.
	setIpAddress (string $ipAddress)
	Sets the IP address of the customer.
	setPaysolExtendedData (BaseTransaction $paysolExtendedData)
	Sets extended payment solution data for a transaction.
	validate ()
	Validates the configuration parameters.
Public Member Functions inherited from ParametersInterface
	setMerchantTransactionId (string $merchantTransactionId)
	Sets the merchant transaction ID.
	setAmount (float $amount)
	Sets the amount for the transaction.
	getAmount ()
	setProductId (int $productId)
	setCurrency (CurrencyCodes $currency)
	Sets the currency code for the transaction.
	setCountry (CountryCodes $country)
	Sets the country code.
	setApiVersion (int $version)
	Sets the Api Version.
	setCustomerId (string $customerId)
	Sets the customer ID.
	setPaymentSolution (PaymentSolutions $paymentSolution)
	Sets the payment solution for the transaction.
	setLanguage (LanguageCodes $language)
	Sets the language for the payment interface.
	setType (Types $type)
	Sets the transaction type.
	isUrl (string $string)
	setStatusURL (string $statusURL)
	Sets the URL to which the transaction status will be sent.
	setAwaitingURL (string $awaitingURL)
	Sets the URL for redirecting the user during the payment process if additional actions are required.
	setSuccessURL (string $successURL)
	Sets the URL to which the customer will be redirected after a successful transaction.
	setErrorURL (string $errorURL)
	Sets the URL to which the customer will be redirected after a transaction error.
	setCancelURL (string $cancelURL)
	Sets the URL to which the customer will be redirected if they cancel the transaction.
	setCustomerEmail (string $customerEmail)
	Sets the customer's email address.
	setCustomerNationalId (string $customerNationalId)
	Sets the national ID of the customer.
	setCustomerCountry (CountryCodes $customerCountry)
	Sets the country code of the customer.
	setDob (string $dob)
	Sets the date of birth of the customer.
	setFirstName (string $firstName)
	Sets the first name of the customer.
	setLastName (string $lastName)
	Sets the last name of the customer.
	setChName (string $chName)
	Sets the card holder's name.
	setReferenceId (string $referenceId)
	Sets the Reference Id.
	setDescription (string $description)
	Sets Description.
	setChallengeInd (string $challengeInd)
	Sets Challenge Ind.
	setShowRememberMe (bool $showRememberMe)
	Sets Show Remember Me.
	setMerchantParams (array $params)
	Sets Merchant Params.
	setTransactionId (int $transactionId)
	Sets the transaction ID.
	setForceTokenRequest (bool $forceTokenRequest)
	Sets the force token request flag.
	setAnonymousCustomer (bool $anonymousCustomer)
	Sets the anonymous customer flag.
	setPrepayToken (string $prepayToken)
	Sets the prepayment token.
	setAdditionalParameters (string $key, mixed $value)
	Sets additional parameters for the transaction.
	addAcceptJsonHeader (bool $json)
	Adds a header to accept JSON responses.
	getOtherConfigurations ()
	Retrieves all other configurations set for the transaction.
	isValidEmail (string $email)
	Validates if the provided string is a valid email address.

Additional Inherited Members
Protected Attributes inherited from ParametersInterface
array	$otherConfigurations = []
bool	$isSettingPaysolExtendedData = false

Constructor & Destructor Documentation

__construct()

__construct

(

)

Reimplemented from ParametersInterface.

Member Function Documentation

setCustomerNationalIdType()

setCustomerNationalIdType

(

CustomerNationalIdTypes

$customerNationalIdType

)

Sets the customer's national ID type.

Validates the ID type against predefined types.

Parameters

CustomerNationalIdTypes

$customerNationalIdType

Type of the customer's national ID.

Returns

self

Exceptions

InvalidFieldException

If the ID type is invalid.

setIpAddress()

setIpAddress

(

string

$ipAddress

)

Sets the IP address of the customer.

Parameters

string

$ipAddress

Customer's IP address.

Returns

self

setPaysolExtendedData()

setPaysolExtendedData

(

BaseTransaction

$paysolExtendedData

)

Sets extended payment solution data for a transaction.

Validates and calculates the total item price. Encodes the transaction data into JSON format.

Parameters

BaseTransaction

$paysolExtendedData

Extended data for the transaction.

Returns

self

validate()

validate

(

)

Validates the configuration parameters.

Checks for the presence of required parameters and consistency of total amount.

Returns

void

Exceptions

InvalidFieldException

If any required parameter is missing or inconsistent.

Reimplemented from ParametersInterface.

---

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

• QuixParameters.php