Inheritance diagram for Parameters:

Public Member Functions
	setPaymentRecurringType (RecurringTypes $paymentRecurringType)
	Sets the type of recurring payment.

	setCardNumber (string $cardNumber)
	Sets the card number for the transaction.

	setAutoCapture (bool $autoCapture)
	Sets the auto capture flag for the transaction.

	setPrintReceipt (bool $printReceipt)
	Sets the flag to print a receipt for the transaction.

	setExpDate (string $expDate)
	Sets the expiration date of the card.

	setCvnNumber (int $cvnNumber)
	Sets the CVN number of the card.

	setCardNumberToken (string $cardNumberToken)
	Sets the tokenized card number.

	setSubscriptionPlan (string $subscriptionPlan)
	Sets the subscription plan.

	setOperationType (OperationTypes $operationType)
	Sets the type of operation for the transaction.

	setMerchantExemptionsSca (MerchantExemptionsSca $merchantExemptionsSca)
	Sets the type of operation for the transaction.

Public Member Functions inherited from ParametersInterface
	__construct ()

	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.

	validate ()

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

bool	$isSettingPaysolExtendedData = false

Member Function Documentation

◆ setAutoCapture()

setAutoCapture ( bool $autoCapture )

Sets the auto capture flag for the transaction.

Parameters

mixed $autoCapture The auto capture flag (true or false).

Returns: self Returns the instance of the class for method chaining.

Exceptions

InvalidFieldException if the provided value is not a valid boolean.

◆ setCardNumber()

setCardNumber ( string $cardNumber )

Sets the card number for the transaction.

Parameters

string $cardNumber The card number.

Returns: self Returns the instance of the class for method chaining.

◆ setCardNumberToken()

setCardNumberToken ( string $cardNumberToken )

Sets the tokenized card number.

Parameters

string $cardNumberToken The tokenized card number.

Returns: self Returns the instance of the class for method chaining.

Exceptions

InvalidFieldException if the provided token is not valid.

◆ setCvnNumber()

setCvnNumber ( int $cvnNumber )

Sets the CVN number of the card.

Parameters

int $cvnNumber The CVN number.

Returns: self Returns the instance of the class for method chaining.

Exceptions

InvalidFieldException if the provided CVN number is not an integer.

◆ setExpDate()

setExpDate ( string $expDate )

Sets the expiration date of the card.

Parameters

string $expDate The expiration date in MMYY format.

Returns: self Returns the instance of the class for method chaining.

Exceptions

InvalidFieldException if the provided expiration date is not in valid MMYY format.

◆ setMerchantExemptionsSca()

setMerchantExemptionsSca ( MerchantExemptionsSca $merchantExemptionsSca )

Sets the type of operation for the transaction.

Parameters

MerchantExemptionsSca $operationType The operation type (e.g., DEBIT, CREDIT).

Returns: self Returns the instance of the class for method chaining.

Exceptions

InvalidFieldException if the provided operation type is not valid.

◆ setOperationType()

setOperationType ( OperationTypes $operationType )

Sets the type of operation for the transaction.

Parameters

OperationTypes $operationType The operation type (e.g., DEBIT, CREDIT).

Returns: self Returns the instance of the class for method chaining.

Exceptions

InvalidFieldException if the provided operation type is not valid.

◆ setPaymentRecurringType()

setPaymentRecurringType ( RecurringTypes $paymentRecurringType )

Sets the type of recurring payment.

Parameters

RecurringTypes $paymentRecurringType The type of recurring payment (e.g., subscription, installment).

Returns: self Returns the instance of the class for method chaining.

Exceptions

InvalidFieldException if the provided recurring type is not valid.

◆ setPrintReceipt()

setPrintReceipt ( bool $printReceipt )

Sets the flag to print a receipt for the transaction.

Parameters

mixed $printReceipt The print receipt flag (true or false).

Returns: self Returns the instance of the class for method chaining.

Exceptions

InvalidFieldException if the provided value is not a valid boolean.

◆ setSubscriptionPlan()

setSubscriptionPlan ( string $subscriptionPlan )

Sets the subscription plan.

Parameters

string $subscriptionPlan The subscription plan.

Returns: self Returns the instance of the class for method chaining.

Exceptions

InvalidFieldException if the subscription plan is not valid.

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

Parameters.php

Public Member Functions

Additional Inherited Members

Member Function Documentation

◆ setAutoCapture()

◆ setCardNumber()

◆ setCardNumberToken()

◆ setCvnNumber()

◆ setExpDate()

◆ setMerchantExemptionsSca()

◆ setOperationType()

◆ setPaymentRecurringType()

◆ setPrintReceipt()

◆ setSubscriptionPlan()