Versions Compared

Key

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

Payment Method Brand

...

Table of Contents
stylenone

POS Integration

Type

Function

Notes

GET

Get Order

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

Type

Function

Notes

WEBHOOK

Price Order

Within the fees field, we have the information of Service Fee

WEBHOOK

Commit Order

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

Create Delivery

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 our 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 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.

...

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.

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

...

Get Store Status

...

PUT

...

Update Store Status

...

GET

...

Get Menu PLUs

...

GET

...

Get Order

...

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

...

POST

...

Order Event

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

...

Price Order

...

Within the fees field, we have the information of Service Fee

...

WEBHOOK

...

Commit Order

...

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

...

Fire Order

...

WEBHOOK

...

Order Event

...

WEBHOOK

...

Store Support Ticket Event

...

WEBHOOK

...

General Support Ticket Event

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

...

Create Quote

...

WEBHOOK

...

Apply Quote

...

WEBHOOK

...

Create Delivery

...

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

...

WEBHOOK

...

Delivery Event

...

POST

...