USERS
/v1/apps/bootstrapBootstrap into the Flyt API
/v1/userRegisters a new user
/v1/user/meReturns the user object
/v2/auth/loginAuthenticates a user
/users/v1/tokenCreate a token valid for the channel specified in the request
/users/v1/provider/registrationRegister a user for a specific provider. The user created has access to resources and services of the provider.
/users/v1/provider/token/{userToken}Retrieve an access token (allowing you to use our new SSO API) from a user token (provided by the older SSO API). Use this to migrate users.
/v1/user/me/profile-fieldAdd information to the profile of a user
BILLS
/v2/bill/join/tableNumberGets the bill using the table number and the location
/v2/bill/{billId}/request-refreshQueues a refresh of this bill to the POS
/v2/bill/{billId}/add-external-paymentAdds an external payment to the bill
/v3/bill/{billId}Returns the bill object for a given billId
BUSINESS
/v4/businessGet a list of business associated to the accessToken or SSO tokens provided with the request.
LOCATIONS
/v5/location/registryGet a list of locations available close to the user
/v5/locationGet information about a location
/v3/location/{locationId}/bills/closedGet all closed bills within a date range for a location
MENUS
/v2/location/{locationId}/menu/{orderTypeId}Returns a menu for ordering for a particular service type
ORDERING
/ordering/v3/orderCreates and saves an order.
/ordering/v3/orderGet last orders.
/ordering/v3/order/{orderUuid}/fulfillment-type/collection-by-customerAdds a fulfillment type of collection-by-customer to an existing order.
/ordering/v3/order/{orderUuid}/fulfillment-type/delivery-by-operatorAdds a fulfillment type of delivery-by-operator to an existing order.
/ordering/v3/order/{orderUuid}/fulfillment-type/delivery-by-delivery-partnerAdds a fulfillment type of delivery-by-delivery-partner to an existing order.
/ordering/v3/order/{orderUuid}/fulfillment-type/order-at-tableAdds a fulfillment type of order-at-table to an existing order.
/ordering/v3/order/{orderUuid}/mark-as-paidMark an existing order as paid
/ordering/v3/order/{orderUuid}/mark-as-paid/payment/{paymentHash}Mark an order as paid and link a payment generated using the Payments API
/ordering/v3/order/{orderUuid}/notificationsSubscribe to events for this order via webhooks
/ordering/v3/order/{orderUuid}/send-to-pos-asyncSend an order to the Point of sale (POS) system in an asyncronous manner. On success and failure, corresponding events will be sent to a pre-configured webhook URL
/ordering/v3/location/{locationId}/{orderType}/kitchen-slotsGet a kitchen slots from the Point of sale (POS) system in a synchronous manner.
PAYMENTS
/payments/v1/paymentInitialize a new payment on Flypay side, without actually passing it to the payment provider
/payments/v1/payment/{paymentHash}/auth-and-chargeProcess the whole payment (authorize and capture) with the payment provider
/payments/v1/payment/{paymentHash}/authProcess the authorization request with the payment provider
/payments/v1/payment/{paymentHash}/authCancels the authorization (not charged yet) with the payment provider to unlock the user's money on the card
/payments/v1/payment/{paymentHash}/chargeProcess the capture request with the payment provider to finalize the payment
GET

Bills

Returns the bill object for a given billId

ParameterDescriptionExample
IN URL
billId
The Bill ID
AFTER URL
accessToken
The access token received from bootstrapping and authenticated at login
404
200