Copied!

PaymentInterface

PaymentInterface.php : 19

Marker interface for Payment Workflow subject.

Methods

publicgetAmount()

PaymentInterface.php : 38
public getAmount() : Money

Return values

Money

publicgetContext()

PaymentInterface.php : 62

Returns the payment context.

public getContext() : MapInterface<string, mixed>|null

The context is a set of key-value pairs that can be used to store additional information about the payment.

Return values

MapInterface<string, mixed>|null

publicgetCreatedAt()

PaymentInterface.php : 74

Returns the date and time when the payment was created.

public getCreatedAt() : DateTimeInterface

Return values

DateTimeInterface

publicgetId()

PaymentInterface.php : 21
public getId() : int

Return values

int

publicgetIdentifier()

PaymentInterface.php : 29

Returns the payment identifier.

public getIdentifier() : string

Identifier is a unique string (typically referring to payment record in 3rd-party system) containing only alphanumeric characters, hyphen, dashes, and underscores. Maximum allowed identifier length is 64 characters.

Return values

string

publicgetMethod()

PaymentInterface.php : 43

Returns the payment method used to process the payment.

public getMethod() : PaymentMethodInterface

Return values

PaymentMethodInterface

publicgetOrder()

PaymentInterface.php : 48

Returns the order associated with payment.

public getOrder() : OrderInterface

Return values

OrderInterface

publicgetOwner()

PaymentInterface.php : 53

Returns the user who owns the payment.

public getOwner() : User|null

Return values

User|null

publicgetStatus()

PaymentInterface.php : 36

Returns the payment status.

public getStatus() : string

The status is a state identifier in associated workflow definition.

Return values

string

publicgetUpdatedAt()

PaymentInterface.php : 79

Returns the date and time when the payment was last updated.

public getUpdatedAt() : DateTimeInterface

Return values

DateTimeInterface