| Table of Contents | ||
|---|---|---|
|
This page aims to provide the information and links to help RBI partners with the integrations related to the Iberia features.
POS Integration
Type | Function | Notes |
|---|
WEBHOOK |
Within the payment field we also inform the Payment Method ( PaymentMethodBrand field ) that was made. |
Function | Notes | ||||
|---|---|---|---|---|---|
WEBHOOK | Price Get Order | 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 FeePOS can retrieve specific fee types in the field: data / charges / fees / type ( |
Delivery Integration
For integrations with our delivery, we have some webhooks that send some of the information related to the request made by our guests and a unique endpoint to update us regarding the delivery status.
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
Type | Function | Notes |
|---|---|---|
WEBHOOK | For quote errors we expect to receive the codes within a predefined set of values | |
WEBHOOK | For quote errors we expect to receive the codes within a predefined set of values | |
WEBHOOK | Within the payment field we also inform the Payment Method ( PaymentMethodBrand field ) that was made. |
Fields Specifications
PaymentMethodBrand
A property called PaymentMethodBrand was developed, which contains the types of payments made in RBI 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 enabled payments 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.
Within the fees field, we have the information about fee types Service Fee and Bag fee |
Fields details
PaymentMethod and PaymentMethodBrand
PaymentMethod was initially developed, then PaymentMethodBrand was introduced. When PaymentMethodBrand is mapped, it should have higher priority to identify the payment method made in RBI platform. They should be properly read by external system via Partners APIs.
PaymentMethod | PaymentMethodBrand | ||
|---|---|---|---|
CREDIT_CARD | SODEXO | ||
CASH | SODEXO_VOUCHER | ||
CREDIT_CARD | CHEQUE_GOURMET | ||
CASH | CHEQUE_GOURMET_VOUCHER | ||
CREDIT_CARD | TICKET_RESTAURANT_CARD | ||
CASH | TICKET_RESTAURANT_VOUCHER | ||
CASH | PAYMENT_ON_DELIVERY_CARDPAYMENT_ON | ||
CREDIT_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 | OnlineBIZUM |
CREDIT_CARD | WAYLET | ||
CREDIT_CARD | APPLEPAYLINK | ||
PAYPAL | <not sent> | ||
CREDIT_CARD | <not sent for mastercard, visa and other brands> | ||
CASH | <not sent> |
Next PaymentMethodBrand’s (Not implemented yet):
PaymentMethod | PaymentMethodBrand |
|---|---|
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.
...
It is also possible to set discounts for the Service Fee. For example, when the Service Fee is $5, you can still give a $2 discount, so the final value of the Service Fee will be $3.
Bag Fee
A mandatory fixed tax in some countries. E.g.: BK PT. This value is configured by service mode.
Quote errors
When a create quote or apply quote fails the partner send a list containing the errors associated with each quote that are used to improve the user experience. The table below lists the code associate with unavailable restaurants:
Code | Reason |
|---|---|
NUMBER_OF_ORDERS | Too many orders |
TECHNICAL_ISSUES | Technical issue |
RESTAURANT_NEAR_TO_CLOSE | Preparing to close |
WEATHER | Weather issue |
UNREACHABLE_RESTAURANT | Unable to reach destination due to any road/street blocks |
NO_DRIVERS_AVAILABLE | Lack of drivers |
REDUCED_CAPACITY | Restaurant is operating at reduced capacity |