Overview
Commerce Platform Domain
The Commerce Platform is based on a clearly defined domain model that follows the domain driven design approach. The objective of the underlying domain model is to cover requirements of a merchant's business for every channel.
The Checkout represents the central entity for your business with the customer:
- Contains all relevant data of the shopping cart.
- Contains information about the delivery address of the end customer (if available/required).
- Can directly trigger a payment execution via the PAYONE Payment Gateway.
The Commerce Case serves a container for related Checkouts:
- Contains one or more checkouts, offering the possibility to generate a purchase history for customers.
- A customer is directly assigned to a Commerce Case (personal data, billing address).
- Can be modified in case personal data or billing address changes.
Payment Execution vs. Payment Information
The Payment Execution contains the payment that is directly executed via the PAYONE Payment Gateway. This includes every payment that is processed through the eCom gateway. An online refund for a POS transaction is also a Payment Execution since it is processed vie the PAYONE Payment Gateway.
The Payment Information represents all payments that are processed outside of the PAYONE Payment Gateway. This includes (but is not limited to) all payments made at the POS, which are provided directly from the acquiring / network service provider operation (girocard). It can include cash payments or payments that have been processed by a different PSP / acquirer (in those cases the Payment Information has to be created by your systems and be provided to the Commerce Platform).
Overview Domain Model
Note: The domain model can be also be extended, if required for special business needs.
| Object | Description |
|---|---|
| Merchant | You are the central entity in our domain model. |
| Commerce Case | The Commerce Case gives the possibility to aggregate. |
| Customer | Your customer. |
| Billing Address | Billing address of your customer. Assumption: even for a shopping history, a customer will have only one active billing address. |
| Checkout | Central entity of the domain model, represents your sale to the customer. |
| Checkout Item | Single item in the checkout (product in the shopping cart). |
| Shipping Address | Shipping address of your customer provided for the checkout. |
| Payment Execution | Payment done via the PAYONE eCom Payment Gateway. Note: It's possible to initiate more than one Payment Execution (e.g. for down-payments or later available shiping items) |
| Payment Information | Information about a payment that is done at one of your POS terminals. A Payment Information can also be provided by you, if the payment is not done via PAYONE systems (e.g. cash payments). |
| Payment Method | Payment method like credit card, SEPA Direct Debit, giropay, Paypal, Apple Pay etc. |
| Payment Identity | Information needed to execute the payment for the respective payment method (e.g., credit card token, IBAN etc.). |