POS Integration
Type | Function | Notes |
|---|---|---|
GET | Within the payment field we also inform the Payment Method ( PaymentMethodBrand field ) that was made. |
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 |
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.
Type | Function | Notes |
|---|---|---|
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.
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 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.
Add Comment