| Table of Contents | ||
|---|---|---|
|
Feature Developed
Sodexo and Cheque Gourmet
In our system we have two payment methods with Sodexo or Cheque Gourmet, one that is related to online payment where the user makes the payment when purchasing the order and the voucher where payment will be made with a physical card at the time of delivery of the order.
Sodexo Card
The sodexo Sodexo card option is a direct integration with the PSP to use online payment, we propagate this information in the PaymentMethodBrand.
Sodexo Voucher
The sodexo voucher option is an indirect integration for using in-person payment at the time of order delivery, we propagate this information in the PaymentMethodBrand
Cheque Gourmet Card
The cheque gourmet card option is a direct integration with the PSP to use online payment, we propagate this information in the PaymentMethodBrand.
Cheque Gourmet Voucher
The cheque gourmet voucher option is an indirect integration for using in-person payment at the time of order delivery, we propagate this information in the PaymentMethodBrand.
Payment Method Brand
As mentioned above for integration, a property called PaymentMethodBrand was developed, which contains the types of payments made in our system. This string-type property that we pass on to partners covers payments made online and which will be made in person at the time of delivery of the order. The list of payments enabled in our system will be described below.
This property is inside the "payment" object where it will contain some other information, such as: paymentMethod, total, amountLeftToBePaid and tip.
ENUM | Value | Description | Payment |
|---|---|---|---|
SODEXO | SODEXO | Payment was paid using a sodexo card | Online |
SODEXO_VOUCHER | SODEXO_VOUCHER | Payment will be paid using a cheque gourmet card | In Person |
CHEQUE_GOURMET | CHEQUE_GOURMET | Payment was paid using a cheque gourmet card | Online |
CHEQUE_GOURMET_VOUCHER | CHEQUE_GOURMET_VOUCHER | Payment will be paid using a cheque gourmet card | In Person |
PAYMENT_ON_DELIVERY_CARD | PAYMENT_ON_DELIVERY_CARD | Payment will be paid using a physical card | In Person |
BIZUM | BIZUM | Payment was paid using BIZUM | Online |
WAYLET | WAYLET | Payment was paid using WAYLET | Online |
APPLEPAYLINK | APPLEPAYLINK | Payment was paid using APPLE PAY | Online |
Service Fee
The Service Fee is a value that can be a combination of things, for example, the size of the shopping cart, payment method, loyalty level, and company priorities. This fee can be configured by the restaurant, giving more autonomy in setting the values. In addition to setting the value per restaurant, it is possible to add value levels.
For example:
Purchases up to $10 will have a Service Fee of $5
Purchases from $10 to $20 will have a Service Fee of $3
Purchases over $20 will have a Service Fee of $0 - Free
It is also possible to set discounts for the Service Fee. For some reason, when the Service Fee is $5, you can still give a $2 discount, so the final value of the Service Fee will be $3.
These values can be added, and the calculation is already prepared to handle value ranges and discounts.
The integration of partners:
Commit Order - Partners API should send this info to POS/food aggregators (Partners)
Price Order - Partners API should get this info from POS/food aggregators (Partners)
https://euw3-dev-plk-partners-api.rbictg.com/docs/market/#tag/OrderWebhook/operation/webhookOrdersCommit
Integration
POS Integration
For integrations with our POS, we have some endpoints to retrieve store status, menu and a unique endpoint to update the order status.
...
Type
...
Function
...
Notes
...
GET
...
...
PUT
...
...
GET
...
...
GET
...
...
Within the payment field we also inform the Payment Method ( PaymentMethodBrand field ) that was made.
...
POST
...
Partners Integration
For integrations with our partners, we have some webhooks that send some of the information related to the request made by our users.
...
Type
...
Function
...
Notes
...
WEBHOOK
...
...
Within the fees field, we have the information of Service Fee
...
WEBHOOK
...
...
Within the payment field we also inform the Payment Method ( PaymentMethodBrand field ) that was made.
Within the fees field, we have the information of Service Fee
...
WEBHOOK
...
...
WEBHOOK
...
...
WEBHOOK
...
...
WEBHOOK
...
Delivery Integration
For integrations with our delivery, we have some webhooks that send some of the information related to the request made by our users and a unique endpoint to update us regarding the delivery status.
...
Type
...
Function
...
Notes
...
WEBHOOK
...
...
WEBHOOK
...
...
WEBHOOK
...
...
Within the payment field we also inform the Payment Method ( PaymentMethodBrand field ) that was made.
...
WEBHOOK
...
...
POST
...
For more details related to the integrations, refer to this link