interfaces.rst

outdated

Interfaces

Danger

We're sorry but this documentation section is outdated. Please have that in mind when trying to use it. You can help us making documentation up to date via Sylius Github. Thank you!

Model Interfaces

PaymentInterface

This interface should be implemented by any custom model representing a payment. Also it keeps all of the default component_payment_payment-states.

Note

This interface extends the CodeAwareInterface and TimestampableInterface.

PaymentMethodInterface

In order to create a custom payment method class, which could be used by other models or services from this component, it needs to implement this interface.

Note

This interface extends the TimestampableInterface and the component_payment_model_payment-method-translation-interface.

PaymentMethodsAwareInterface

This interface should be implemented by any custom storage used to store representations of the payment method.

PaymentMethodTranslationInterface

This interface is needed in creating a custom payment method translation class, which then could be used by the payment method itself.

PaymentSourceInterface

This interface needs to be implemented by any custom payment source.

PaymentsSubjectInterface

Any container which manages multiple payments should implement this interface.

Service Interfaces

PaymentMethodRepositoryInterface

This interface should be implemented by your custom repository, used to handle payment method objects.