Versions Compared

Old Version 18

changes.mady.by.user Macedo Ferreira, Samuel

Saved on

compared with

New Version Current

changes.mady.by.user Raphael Ferreira Gomes

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Type

Function

Notes

WEBHOOK

Commit Order

Within the payment field we also inform the Payment Method ( PaymentMethodBrand field ) that was made.

WEBHOOK

Get Order

POS can retrieve specific fee types in the field:

data / charges / fees / type ( "BAG_FEE" "DELIVERY_FEE" "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

Create Quote

For quote errors we expect to receive the codes within a predefined set of values

WEBHOOK

Apply Quote

For quote errors we expect to receive the codes within a predefined set of values

WEBHOOK

Create Delivery

Within the payment field we also inform the Payment Method ( PaymentMethodBrand field ) that was made.

Within the fees field, we have the information of about fee types Service Fee and Bag fee

Fields details

PaymentMethod and 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.

...

ENUM

...

Value

...

SODEXO

...

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_VOUCHERSODEXO

CREDIT_VOUCHERCARD

CHEQUE_GOURMETCHEQUE_GOURMET

CASH

CHEQUE_GOURMET_VOUCHERCHEQUE

CREDIT_GOURMET_VOUCHERCARD

TICKET_RESTAURANT_CARDTICKET_RESTAURANT

CASH

TICKET_RESTAURANT_VOUCHERTICKET_RESTAURANT_VOUCHER

CASH

PAYMENT_ON_DELIVERY_CARDPAYMENT

CREDIT_ON_DELIVERY_CARD

BIZUMBIZUM

CREDIT_CARD

WAYLETWAYLET

CREDIT_CARD

APPLEPAYLINK

APPLEPAYLINK

MASTERCARD

MASTERCARD

PAYPAL

PAYPALPAYPAL

<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:

...