Models¶
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!
Payment¶
Every payment is represented by a Payment instance and has the following properties:
Property | Description |
---|---|
id | Unique id of the payment |
method | Payment method associated with this payment |
currency | Payment’s currency |
amount | Payment’s amount |
state | Payment’s state |
details | Payment’s details |
createdAt | Date of creation |
updatedAt | Date of the last update |
Note
This model implements the PaymentInterface.
Hint
All default payment states are available in Payment States.
PaymentMethod¶
Every method of payment is represented by a PaymentMethod instance and has the following properties:
Property | Description |
---|---|
id | Unique id of the payment method |
code | Unique code of the payment method |
name | Payment method’s name |
enabled | Indicate whether the payment method is enabled |
description | Payment method’s description |
gatewayConfig | Payment method’s gateway (and its configuration) to use |
position | Payment method’s position among other methods |
environment | Required app environment |
createdAt | Date of creation |
updatedAt | Date of the last update |
Note
This model implements the PaymentMethodInterface.
PaymentMethodTranslation¶
This model is used to ensure that different locales have the correct representation of the following payment properties:
Property | Description |
---|---|
id | Unique id of the payment method |
name | Payment method’s name |
description | Payment method’s description |
Note
This model implements the PaymentMethodTranslationInterface.