CoolCMS API

Payment extends Payment
in package

Application

#[Entity]

#[Table]: $name: 'cms_system_payments'

#[TableAlias]: 'payment'

Constants

TAX_MARKER_CREDIT_REDEMPTION : string = 'CREDIT_REDEMPTION'
TAX_MARKER_INTERMEDIARY : string = 'INTERMEDIARY': Values of `tax_treatment` that are not invoice codes: the payment bypasses the tax engine and the customer gets no invoice.
TAX_MARKERS_WITHOUT_INVOICE : array<string|int, mixed> = [self::TAX_MARKER_INTERMEDIARY, self::TAX_MARKE...

Properties

$callback : string|null
$cancelUrl : string|null
$code : string|null
$countryCode : string|null
$currencyId : int|null
$customerVatIdCheckId : int|null: Applied VAT id check (`cms_system_vat_id_checks`): consultation number or manual proof.
$customerVatIdOutageCheckId : int|null: Record of a VIES outage on the supply date.
$customerVatIdVerified : bool|null: Null means the VAT id does not matter (empty or domestic); false is unverified; true is verified.
$customerVatIdVerifiedAt : DateTime|null
$description : string
$email : string|null
$encryptedSignature : string|null
$gatewayPaymentId : string|null
$id : int|null
$insertDatetime : DateTime
$invoicedStatus : int|null
$ip : string|null
$localization : object|null: Invoice localization: number and currency formatting is taken from here, not from the current request.
$name : string|null
$notifyUrl : string|null
$paymentCallbackId : int|null
$paymentDatetime : DateTime|null
$paymentEetId : int|null
$paymentGateFeePercents : int
$paymentGateFeePercentsPrice : string
$paymentGateFeePrice : string
$paymentGateFeeTotal : string
$paymentGateId : int|null
$paymentRegionId : int|null
$requirePaymentEet : bool
$status : int|null
$successUrl : string|null
$summaryReportCode : string|null: Supply code for the summary report (`3` services, `0` goods); null means it is not reported.
$taxCountryCode : string|null: Country of the applied rate (null without VAT).
$taxDate : DateTime|null: Date of the rate and of the seller status.
$taxFlags : array<int, string>|null
$taxNote : string|null: Note in the document language (plus Czech), resolved at creation.
$taxTreatment : string|null: Treatment code; on a payment also the markers `INTERMEDIARY` and `CREDIT_REDEMPTION`.
$totalPrice : string|null
$userId : int|null
$variableSymbol : string|null

Methods

__construct() : mixed
callInitMethods() : void: Calls `init{TraitName}()` for every used trait that defines such a method.
getAllTraits() : array<string, string>: Returns all traits the class uses, including those used by parent classes and nested traits.
getCallback() : string|null
getCancelUrl() : string|null
getCode() : string|null
getCountryCode() : string|null
getCurrencyId() : int|null
getCustomerVatIdCheckId() : int|null
getCustomerVatIdOutageCheckId() : int|null
getCustomerVatIdVerified() : bool|null
getCustomerVatIdVerifiedAt() : DateTime|null
getDescription() : string
getEmail() : string|null
getEncryptedSignature() : string|null
getGatewayPaymentId() : string|null
getId() : int|null
getInsertDatetime() : DateTime
getInvoicedStatus() : int|null
getIp() : string|null
getLocalization() : object|null
getLocalizationId() : int|null: The object wins over the scalar (a freshly set localization beats the mirror loaded from the database). `$localization` is an untyped `object`, hence the guard instead of a plain `?->getId()`; without it PHPStan reports `object::getId()` and a foreign object in the association would fail at runtime.
getName() : string|null
getNotifyUrl() : string|null
getPaymentCallbackId() : int|null
getPaymentDatetime() : DateTime|null
getPaymentEetId() : int|null
getPaymentGateFeePercents() : int
getPaymentGateFeePercentsPrice() : string
getPaymentGateFeePrice() : string
getPaymentGateFeeTotal() : string
getPaymentGateId() : int|null
getPaymentRegionId() : int|null
getRequirePaymentEet() : bool
getStatus() : int|null
getSuccessUrl() : string|null
getSummaryReportCode() : string|null
getTaxCountryCode() : string|null
getTaxDate() : DateTime|null
getTaxFlags() : array<int, string>|null
getTaxNote() : string|null
getTaxTreatment() : string|null
getTotalPrice() : string|null
getUserId() : int|null
getVariableSymbol() : string|null
hasTaxFlag() : bool
isPersisted() : bool
isRequirePaymentEet() : bool
setCallback() : $this
setCancelUrl() : $this
setCode() : $this
setCountryCode() : $this
setCurrencyId() : $this
setCustomerVatIdCheckId() : static
setCustomerVatIdOutageCheckId() : static
setCustomerVatIdVerified() : static
setCustomerVatIdVerifiedAt() : static
setDescription() : $this
setEmail() : $this
setEncryptedSignature() : $this
setGatewayPaymentId() : $this
setId() : $this
setInsertDatetime() : $this
setInvoicedStatus() : $this
setIp() : $this
setLocalization() : $this: IMPORTANT: deliberately does not set `$this->localizationId = $localization?->getId()`.
setName() : $this
setNotifyUrl() : $this
setPaymentCallbackId() : $this
setPaymentDatetime() : $this
setPaymentEetId() : $this
setPaymentGateFeePercents() : $this
setPaymentGateFeePercentsPrice() : $this
setPaymentGateFeePrice() : $this
setPaymentGateFeeTotal() : $this
setPaymentGateId() : $this
setPaymentRegionId() : $this
setRequirePaymentEet() : $this
setStatus() : $this
setSuccessUrl() : $this
setSummaryReportCode() : static
setTaxCountryCode() : static
setTaxDate() : static
setTaxFlags() : static
setTaxNote() : static
setTaxTreatment() : static
setTotalPrice() : $this
setUserId() : $this
setVariableSymbol() : $this
getTraitsRecursive() : array<string, string>: Walks the trait list recursively and collects nested traits too.

TAX_MARKER_CREDIT_REDEMPTION


    public
        string
    TAX_MARKER_CREDIT_REDEMPTION
    = 'CREDIT_REDEMPTION'

TAX_MARKER_INTERMEDIARY

Values of `tax_treatment` that are not invoice codes: the payment bypasses the tax engine and the customer gets no invoice.


    public
        string
    TAX_MARKER_INTERMEDIARY
    = 'INTERMEDIARY'

INTERMEDIARY: gate intermediary_supply; the intermediary billed the service to the customer in its own name (art. 9a), the invoice goes to the aggregator manually,
CREDIT_REDEMPTION: payment by credits (non-monetary currency), redemption of a single-purpose voucher already taxed at purchase.

TAX_MARKERS_WITHOUT_INVOICE


    public
        array<string|int, mixed>
    TAX_MARKERS_WITHOUT_INVOICE
    = [self::TAX_MARKER_INTERMEDIARY, self::TAX_MARKER_CREDIT_REDEMPTION]

$callback


        protected
            string|null
    $callback
     = null

#[Column]: $name: 'callback'; $type: 'string'; $length: 45; $nullable: true

$cancelUrl


        protected
            string|null
    $cancelUrl
     = null

#[Column]: $name: 'cancel_url'; $type: 'text'; $nullable: true

$code


        protected
            string|null
    $code
     = null

#[Column]: $name: 'code'; $type: 'string'; $length: 40; $nullable: true

$countryCode


        protected
            string|null
    $countryCode
     = null

#[Column]: $name: 'country_code'; $type: 'string'; $length: 2; $nullable: true; $options: ['fixed' => true]

#[ExternalReadonly]

$currencyId


        protected
            int|null
    $currencyId
     = null

#[Column]: $name: 'cms_system_currencies_currency_id'; $type: 'integer'; $nullable: true; $options: ['unsigned' => true]

$customerVatIdCheckId

Applied VAT id check (`cms_system_vat_id_checks`): consultation number or manual proof.


        protected
            int|null
    $customerVatIdCheckId
     = null

#[Column]: $name: 'customer_vat_id_check_id'; $type: 'integer'; $nullable: true; $options: ['unsigned' => true]

#[ExternalReadonly]

$customerVatIdOutageCheckId

Record of a VIES outage on the supply date.


        protected
            int|null
    $customerVatIdOutageCheckId
     = null

#[Column]: $name: 'customer_vat_id_outage_check_id'; $type: 'integer'; $nullable: true; $options: ['unsigned' => true]

#[ExternalReadonly]

$customerVatIdVerified

Null means the VAT id does not matter (empty or domestic); false is unverified; true is verified.


        protected
            bool|null
    $customerVatIdVerified
     = null

#[Column]: $name: 'customer_vat_id_verified'; $type: 'boolean'; $nullable: true

#[ExternalReadonly]

$customerVatIdVerifiedAt


        protected
            DateTime|null
    $customerVatIdVerifiedAt
     = null

#[Column]: $name: 'customer_vat_id_verified_at'; $type: 'datetime'; $nullable: true

#[ExternalReadonly]

$description


        protected
            string
    $description
     = ''

Attributes

#[Column]: $name: 'description'; $type: 'string'; $length: 255

$email


        protected
            string|null
    $email
     = null

#[Column]: $name: 'email'; $type: 'string'; $length: 255; $nullable: true

$encryptedSignature


        protected
            string|null
    $encryptedSignature
     = null

#[Column]: $name: 'encrypted_signature'; $type: 'string'; $length: 255; $nullable: true

$gatewayPaymentId


        protected
            string|null
    $gatewayPaymentId
     = null

#[Column]: $name: 'gateway_payment_id'; $type: 'string'; $length: 255; $nullable: true

$id


        protected
            int|null
    $id
     = null

#[Column]: $name: 'payment_id'; $type: 'integer'; $options: ['unsigned' => true]

#[GeneratedValue]

#[Id]

$insertDatetime


        protected
            DateTime
    $insertDatetime
     = new DateTime()

#[Column]: $name: 'insert_datetime'; $type: 'datetime'

#[ExternalReadonly]

$invoicedStatus


        protected
            int|null
    $invoicedStatus
     = null

#[Column]: $name: 'invoiced_status'; $type: 'integer'; $nullable: true

#[ExternalReadonly]

$ip


        protected
            string|null
    $ip
     = null

#[Column]: $name: 'ip'; $type: 'string'; $length: 45; $nullable: true

#[ExternalReadonly]

#[PersonalData]: PersonalDataKind::Hidden

$localization

Invoice localization: number and currency formatting is taken from here, not from the current request.


        protected
            object|null
    $localization
     = null

Load it with ->include(['localization']), the same way the currency is loaded.

#[JoinColumn]: $name: 'cms_system_localizations_localization_id'; $referencedColumnName: 'localization_id'; $onDelete: 'SET NULL'

#[ManyToOne]: $targetEntity: \App\UI\Api\System\Models\Entities\Localization::class; $fetch: 'LAZY'

$name


        protected
            string|null
    $name
     = null

#[Column]: $name: 'name'; $type: 'string'; $length: 255; $nullable: true

$notifyUrl


        protected
            string|null
    $notifyUrl
     = null

#[Column]: $name: 'notify_url'; $type: 'text'; $nullable: true

$paymentCallbackId


        protected
            int|null
    $paymentCallbackId
     = null

#[Column]: $name: 'cms_system_payment_callbacks_callback_id'; $type: 'integer'; $nullable: true; $options: ['unsigned' => true]

$paymentDatetime


        protected
            DateTime|null
    $paymentDatetime
     = null

#[Column]: $name: 'payment_datetime'; $type: 'datetime'; $nullable: true

#[ExternalReadonly]

$paymentEetId


        protected
            int|null
    $paymentEetId
     = null

#[Column]: $name: 'cms_system_payment_eets_payment_eet_id'; $type: 'integer'; $nullable: true; $options: ['unsigned' => true]

$paymentGateFeePercents


        protected
            int
    $paymentGateFeePercents
     = 0

#[Column]: $name: 'payment_gate_fee_percents'; $type: 'smallint'

$paymentGateFeePercentsPrice


        protected
            string
    $paymentGateFeePercentsPrice
     = '0.000'

#[Column]: $name: 'payment_gate_fee_percents_price'; $type: 'decimal'; $precision: 10; $scale: 3

$paymentGateFeePrice


        protected
            string
    $paymentGateFeePrice
     = '0.000'

#[Column]: $name: 'payment_gate_fee_price'; $type: 'decimal'; $precision: 10; $scale: 3

$paymentGateFeeTotal


        protected
            string
    $paymentGateFeeTotal
     = '0.000'

#[Column]: $name: 'payment_gate_fee_total'; $type: 'decimal'; $precision: 10; $scale: 3

$paymentGateId


        protected
            int|null
    $paymentGateId
     = null

#[Column]: $name: 'cms_system_payment_gates_payment_gate_id'; $type: 'integer'; $nullable: true; $options: ['unsigned' => true]

$paymentRegionId


        protected
            int|null
    $paymentRegionId
     = null

#[Column]: $name: 'cms_system_payment_regions_payment_region_id'; $type: 'integer'; $nullable: true; $options: ['unsigned' => true]

$requirePaymentEet


        protected
            bool
    $requirePaymentEet
     = false

#[Column]: $name: 'require_payment_eet'; $type: 'boolean'

$status


        protected
            int|null
    $status
     = 0

#[Column]: $name: 'status'; $type: 'integer'; $nullable: true

$successUrl


        protected
            string|null
    $successUrl
     = null

#[Column]: $name: 'success_url'; $type: 'text'; $nullable: true

$summaryReportCode

Supply code for the summary report (`3` services, `0` goods); null means it is not reported.


        protected
            string|null
    $summaryReportCode
     = null

Attributes

#[Column]: $name: 'summary_report_code'; $type: 'string'; $length: 1; $nullable: true; $options: ['fixed' => true]

#[ExternalReadonly]

$taxCountryCode

Country of the applied rate (null without VAT).


        protected
            string|null
    $taxCountryCode
     = null

#[Column]: $name: 'tax_country_code'; $type: 'string'; $length: 2; $nullable: true; $options: ['fixed' => true]

#[ExternalReadonly]

$taxDate

Date of the rate and of the seller status.


        protected
            DateTime|null
    $taxDate
     = null

#[Column]: $name: 'tax_date'; $type: 'date'; $nullable: true

#[ExternalReadonly]

$taxFlags


        protected
            array<int, string>|null
    $taxFlags
     = null

TaxFlag codes

#[Column]: $name: 'tax_flags'; $type: 'json'; $nullable: true

#[ExternalReadonly]

$taxNote

Note in the document language (plus Czech), resolved at creation.


        protected
            string|null
    $taxNote
     = null

#[Column]: $name: 'tax_note'; $type: 'text'; $nullable: true

#[ExternalReadonly]

$taxTreatment

Treatment code; on a payment also the markers `INTERMEDIARY` and `CREDIT_REDEMPTION`.


        protected
            string|null
    $taxTreatment
     = null

#[Column]: $name: 'tax_treatment'; $type: 'string'; $length: 24; $nullable: true

#[ExternalReadonly]

$totalPrice


        protected
            string|null
    $totalPrice
     = null

#[Column]: $name: 'total_price'; $type: 'decimal'; $precision: 10; $scale: 3; $nullable: true

$userId


        protected
            int|null
    $userId
     = null

#[Column]: $name: 'cms_system_users_user_id'; $type: 'integer'; $nullable: true; $options: ['unsigned' => true]

#[ExternalReadonly]

$variableSymbol


        protected
            string|null
    $variableSymbol
     = null

#[Column]: $name: 'variable_symbol'; $type: 'string'; $length: 50; $nullable: true

__construct()


    public
                    __construct([int|null $id = null ][, int|null $currencyId = null ][, string|null $totalPrice = null ][, int|null $paymentGateId = null ][, int|null $userId = null ][, string|null $email = null ][, string|null $code = null ][, string|null $variableSymbol = null ][, string|null $gatewayPaymentId = null ][, string|null $encryptedSignature = null ][, DateTime $insertDatetime = new DateTime() ][, DateTime|null $paymentDatetime = null ][, int|null $status = 0 ][, string|null $name = null ][, string $description = '' ][, string|null $ip = null ][, string|null $successUrl = null ][, string|null $cancelUrl = null ][, string|null $notifyUrl = null ][, string|null $callback = null ][, int|null $paymentCallbackId = null ][, int|null $paymentEetId = null ][, bool $requirePaymentEet = false ][, string $paymentGateFeePrice = '0.000' ][, int $paymentGateFeePercents = 0 ][, string $paymentGateFeeTotal = '0.000' ][, string $paymentGateFeePercentsPrice = '0.000' ][, int|null $paymentRegionId = null ][, string|null $countryCode = null ][, int|null $invoicedStatus = null ][, mixed $localization = null ][, int|null $localizationId = null ]) : mixed

Parameters

$id : int|null = null
$currencyId : int|null = null
$totalPrice : string|null = null
$paymentGateId : int|null = null
$userId : int|null = null
$email : string|null = null
$code : string|null = null
$variableSymbol : string|null = null
$gatewayPaymentId : string|null = null
$encryptedSignature : string|null = null
$insertDatetime : DateTime = new DateTime()
$paymentDatetime : DateTime|null = null
$status : int|null = 0
$name : string|null = null
$description : string = ''
$ip : string|null = null
$successUrl : string|null = null
$cancelUrl : string|null = null
$notifyUrl : string|null = null
$callback : string|null = null
$paymentCallbackId : int|null = null
$paymentEetId : int|null = null
$requirePaymentEet : bool = false
$paymentGateFeePrice : string = '0.000'
$paymentGateFeePercents : int = 0
$paymentGateFeeTotal : string = '0.000'
$paymentGateFeePercentsPrice : string = '0.000'
$paymentRegionId : int|null = null
$countryCode : string|null = null
$invoicedStatus : int|null = null
$localization : mixed = null
$localizationId : int|null = null

callInitMethods()

Calls `init{TraitName}()` for every used trait that defines such a method.


    public
                    callInitMethods() : void

getAllTraits()

Returns all traits the class uses, including those used by parent classes and nested traits.


    public
                    getAllTraits() : array<string, string>

Return values

array<string, string>

getCallback()


    public
                    getCallback() : string|null

Return values

string|null

getCancelUrl()


    public
                    getCancelUrl() : string|null

Return values

string|null

getCode()


    public
                    getCode() : string|null

Return values

string|null

getCountryCode()


    public
                    getCountryCode() : string|null

Return values

string|null

getCurrencyId()


    public
                    getCurrencyId() : int|null

Return values

int|null

getCustomerVatIdCheckId()


    public
                    getCustomerVatIdCheckId() : int|null

Return values

int|null

getCustomerVatIdOutageCheckId()


    public
                    getCustomerVatIdOutageCheckId() : int|null

Return values

int|null

getCustomerVatIdVerified()


    public
                    getCustomerVatIdVerified() : bool|null

Return values

bool|null

getCustomerVatIdVerifiedAt()


    public
                    getCustomerVatIdVerifiedAt() : DateTime|null

Return values

DateTime|null

getDescription()


    public
                    getDescription() : string

Return values

string

getEmail()


    public
                    getEmail() : string|null

Return values

string|null

getEncryptedSignature()


    public
                    getEncryptedSignature() : string|null

Return values

string|null

getGatewayPaymentId()


    public
                    getGatewayPaymentId() : string|null

Return values

string|null

getId()


    public
                    getId() : int|null

Return values

int|null

getInsertDatetime()


    public
                    getInsertDatetime() : DateTime

Return values

DateTime

getInvoicedStatus()


    public
                    getInvoicedStatus() : int|null

Return values

int|null

getIp()


    public
                    getIp() : string|null

Return values

string|null

getLocalization()


    public
                    getLocalization() : object|null

Return values

object|null

getLocalizationId()

The object wins over the scalar (a freshly set localization beats the mirror loaded from the database). `$localization` is an untyped `object`, hence the guard instead of a plain `?->getId()`; without it PHPStan reports `object::getId()` and a foreign object in the association would fail at runtime.


    public
                    getLocalizationId() : int|null

Return values

int|null

getName()


    public
                    getName() : string|null

Return values

string|null

getNotifyUrl()


    public
                    getNotifyUrl() : string|null

Return values

string|null

getPaymentCallbackId()


    public
                    getPaymentCallbackId() : int|null

Return values

int|null

getPaymentDatetime()


    public
                    getPaymentDatetime() : DateTime|null

Return values

DateTime|null

getPaymentEetId()


    public
                    getPaymentEetId() : int|null

Return values

int|null

getPaymentGateFeePercents()


    public
                    getPaymentGateFeePercents() : int

Return values

int

getPaymentGateFeePercentsPrice()


    public
                    getPaymentGateFeePercentsPrice() : string

Return values

string

getPaymentGateFeePrice()


    public
                    getPaymentGateFeePrice() : string

Return values

string

getPaymentGateFeeTotal()


    public
                    getPaymentGateFeeTotal() : string

Return values

string

getPaymentGateId()


    public
                    getPaymentGateId() : int|null

Return values

int|null

getPaymentRegionId()


    public
                    getPaymentRegionId() : int|null

Return values

int|null

getRequirePaymentEet()


    public
                    getRequirePaymentEet() : bool

Return values

bool

getStatus()


    public
                    getStatus() : int|null

Return values

int|null

getSuccessUrl()


    public
                    getSuccessUrl() : string|null

Return values

string|null

getSummaryReportCode()


    public
                    getSummaryReportCode() : string|null

Return values

string|null

getTaxCountryCode()


    public
                    getTaxCountryCode() : string|null

Return values

string|null

getTaxDate()


    public
                    getTaxDate() : DateTime|null

Return values

DateTime|null

getTaxFlags()


    public
                    getTaxFlags() : array<int, string>|null

Return values

array<int, string>|null

getTaxNote()


    public
                    getTaxNote() : string|null

Return values

string|null

getTaxTreatment()


    public
                    getTaxTreatment() : string|null

Return values

string|null

getTotalPrice()


    public
                    getTotalPrice() : string|null

Return values

string|null

getUserId()


    public
                    getUserId() : int|null

Return values

int|null

getVariableSymbol()


    public
                    getVariableSymbol() : string|null

Return values

string|null

hasTaxFlag()


    public
                    hasTaxFlag(string $flag) : bool

Parameters

$flag : string

Return values

bool

isPersisted()


    public
                    isPersisted() : bool

Return values

bool

isRequirePaymentEet()


    public
                    isRequirePaymentEet() : bool

Return values

bool

setCallback()


    public
                    setCallback(string|null $callback) : $this

Parameters

$callback : string|null

Return values

$this

setCancelUrl()


    public
                    setCancelUrl(string|null $cancelUrl) : $this

Parameters

$cancelUrl : string|null

Return values

$this

setCode()


    public
                    setCode(string|null $code) : $this

Parameters

$code : string|null

Return values

$this

setCountryCode()


    public
                    setCountryCode(string|null $countryCode) : $this

Parameters

$countryCode : string|null

Return values

$this

setCurrencyId()


    public
                    setCurrencyId(int|null $currencyId) : $this

Parameters

$currencyId : int|null

Return values

$this

setCustomerVatIdCheckId()


    public
                    setCustomerVatIdCheckId(int|null $customerVatIdCheckId) : static

Parameters

$customerVatIdCheckId : int|null

Return values

static

setCustomerVatIdOutageCheckId()


    public
                    setCustomerVatIdOutageCheckId(int|null $customerVatIdOutageCheckId) : static

Parameters

$customerVatIdOutageCheckId : int|null

Return values

static

setCustomerVatIdVerified()


    public
                    setCustomerVatIdVerified(bool|null $customerVatIdVerified) : static

Parameters

$customerVatIdVerified : bool|null

Return values

static

setCustomerVatIdVerifiedAt()


    public
                    setCustomerVatIdVerifiedAt(DateTime|null $customerVatIdVerifiedAt) : static

Parameters

$customerVatIdVerifiedAt : DateTime|null

Return values

static

setDescription()


    public
                    setDescription(string $description) : $this

Parameters

$description : string

Return values

$this

setEmail()


    public
                    setEmail(string|null $email) : $this

Parameters

$email : string|null

Return values

$this

setEncryptedSignature()


    public
                    setEncryptedSignature(string|null $encryptedSignature) : $this

Parameters

$encryptedSignature : string|null

Return values

$this

setGatewayPaymentId()


    public
                    setGatewayPaymentId(string|null $gatewayPaymentId) : $this

Parameters

$gatewayPaymentId : string|null

Return values

$this

setId()


    public
                    setId(int|null $id) : $this

Parameters

$id : int|null

Return values

$this

setInsertDatetime()


    public
                    setInsertDatetime(DateTime $dt) : $this

Parameters

$dt : DateTime

Return values

$this

setInvoicedStatus()


    public
                    setInvoicedStatus(int|null $invoicedStatus) : $this

Parameters

$invoicedStatus : int|null

Return values

$this

setIp()


    public
                    setIp(string|null $ip) : $this

Parameters

$ip : string|null

Return values

$this

setLocalization()

IMPORTANT: deliberately does not set `$this->localizationId = $localization?->getId()`.


    public
                    setLocalization(object|null $localization) : $this

During two-phase hydration the setter runs before the shell receives its id and would overwrite the correctly loaded read-only scalar with null.

Parameters

$localization : object|null

Return values

$this

setName()


    public
                    setName(string|null $name) : $this

Parameters

$name : string|null

Return values

$this

setNotifyUrl()


    public
                    setNotifyUrl(string|null $notifyUrl) : $this

Parameters

$notifyUrl : string|null

Return values

$this

setPaymentCallbackId()


    public
                    setPaymentCallbackId(int|null $paymentCallbackId) : $this

Parameters

$paymentCallbackId : int|null

Return values

$this

setPaymentDatetime()


    public
                    setPaymentDatetime(DateTime|null $dt) : $this

Parameters

$dt : DateTime|null

Return values

$this

setPaymentEetId()


    public
                    setPaymentEetId(int|null $paymentEetId) : $this

Parameters

$paymentEetId : int|null

Return values

$this

setPaymentGateFeePercents()


    public
                    setPaymentGateFeePercents(int $paymentGateFeePercents) : $this

Parameters

$paymentGateFeePercents : int

Return values

$this

setPaymentGateFeePercentsPrice()


    public
                    setPaymentGateFeePercentsPrice(string $paymentGateFeePercentsPrice) : $this

Parameters

$paymentGateFeePercentsPrice : string

Return values

$this

setPaymentGateFeePrice()


    public
                    setPaymentGateFeePrice(string $paymentGateFeePrice) : $this

Parameters

$paymentGateFeePrice : string

Return values

$this

setPaymentGateFeeTotal()


    public
                    setPaymentGateFeeTotal(string $paymentGateFeeTotal) : $this

Parameters

$paymentGateFeeTotal : string

Return values

$this

setPaymentGateId()


    public
                    setPaymentGateId(int|null $paymentGateId) : $this

Parameters

$paymentGateId : int|null

Return values

$this

setPaymentRegionId()


    public
                    setPaymentRegionId(int|null $paymentRegionId) : $this

Parameters

$paymentRegionId : int|null

Return values

$this

setRequirePaymentEet()


    public
                    setRequirePaymentEet(bool $requirePaymentEet) : $this

Parameters

$requirePaymentEet : bool

Return values

$this

setStatus()


    public
                    setStatus(int|null $status) : $this

Parameters

$status : int|null

Return values

$this

setSuccessUrl()


    public
                    setSuccessUrl(string|null $successUrl) : $this

Parameters

$successUrl : string|null

Return values

$this

setSummaryReportCode()


    public
                    setSummaryReportCode(string|null $summaryReportCode) : static

Parameters

$summaryReportCode : string|null

Return values

static

setTaxCountryCode()


    public
                    setTaxCountryCode(string|null $taxCountryCode) : static

Parameters

$taxCountryCode : string|null

Return values

static

setTaxDate()


    public
                    setTaxDate(DateTime|null $taxDate) : static

Parameters

$taxDate : DateTime|null

Return values

static

setTaxFlags()


    public
                    setTaxFlags(array<int, string>|null $taxFlags) : static

Parameters

$taxFlags : array<int, string>|null

Return values

static

setTaxNote()


    public
                    setTaxNote(string|null $taxNote) : static

Parameters

$taxNote : string|null

Return values

static

setTaxTreatment()


    public
                    setTaxTreatment(string|null $taxTreatment) : static

Parameters

$taxTreatment : string|null

Return values

static

setTotalPrice()


    public
                    setTotalPrice(string|null $totalPrice) : $this

Parameters

$totalPrice : string|null

Return values

$this

setUserId()


    public
                    setUserId(int|null $userId) : $this

Parameters

$userId : int|null

Return values

$this

setVariableSymbol()


    public
                    setVariableSymbol(string|null $variableSymbol) : $this

Parameters

$variableSymbol : string|null

Return values

$this

getTraitsRecursive()

Walks the trait list recursively and collects nested traits too.


    private
            static        getTraitsRecursive(array<string, string> $traits) : array<string, string>

Parameters

$traits : array<string, string>

Return values

array<string, string>

Payment extends Payment in package Application

Attributes

Table of Contents

Constants

Properties

Methods

Constants

TAX_MARKER_CREDIT_REDEMPTION

TAX_MARKER_INTERMEDIARY

TAX_MARKERS_WITHOUT_INVOICE

Properties

$callback

Attributes

$cancelUrl

Attributes

$code

Attributes

$countryCode

Attributes

$currencyId

Attributes

$customerVatIdCheckId

Attributes

$customerVatIdOutageCheckId

Attributes

$customerVatIdVerified

Attributes

$customerVatIdVerifiedAt

Attributes

$description

Attributes

$email

Attributes

$encryptedSignature

Attributes

$gatewayPaymentId

Attributes

$id

Attributes

$insertDatetime

Attributes

$invoicedStatus

Attributes

$ip

Attributes

$localization

Attributes

$name

Attributes

$notifyUrl

Attributes

$paymentCallbackId

Attributes

$paymentDatetime

Attributes

$paymentEetId

Attributes

$paymentGateFeePercents

Attributes

$paymentGateFeePercentsPrice

Attributes

$paymentGateFeePrice

Attributes

$paymentGateFeeTotal

Attributes

$paymentGateId

Attributes

$paymentRegionId

Attributes

$requirePaymentEet

Attributes

$status

Attributes

$successUrl

Attributes

$summaryReportCode

Attributes

$taxCountryCode

Attributes

$taxDate

Payment extends Payment
in package

Application