Apple Pay overview

Important

Apple Pay® is currently only available for Toast platform integrations on Apple’s Safari web browser.

You can use the Toast Apple Pay API to accept Apple Pay® payments from guests for orders on your Toast platform ordering integration.

To accept Apple Pay payments for Toast platform restaurant orders

1. Register your Apple Pay payment integration with the Toast platform. For more information, see Registering an Apple Pay integration.

2. Implement the Apple Pay payment interface in your guest ordering experience. For example, if you are accepting Apple Pay payments from an ordering website, include Apple Pay functionality in the implementation of your websites. Use the Apple JavaScript API for Apple Pay payments to implement the payment interface.

   • Create an Apple Pay payment request object and a payment session object.

   • Handle the Apple Pay merchant validation event. Your payment interface JavaScript gets an Apple Pay merchant session identifier from the Toast platform to handle this event.

   • Handle the Apple Pay payment authorized event. Your payment interface JavaScript gets a payment authorization status response from the Toast platform to handle this event.

3. Implement the Toast API REST requests that your integration sends to the Toast platform. In your integration, you must implement the Toast API requests in a server component that is separate from the client implementation that guests interact with.

   • Make a request to the /merchants/{restaurantGuid}/applepay/paymentsession endpoint of the Toast credit cards API to get a merchant session identifier when your guest payment interface handles the Apple Pay merchant validation event.

   • Make a request to the /merchants/{restaurantGuid}/payments/{paymentUuid} endpoint of the Toast credit cards API to authorize an Apple Pay payment when your guest payment interface handles the Apple Pay payment authorized.

4. Apply the authorized Apple Pay payment to a Toast platform order for the restaurant guest. For information about applying authorized payments to Toast platform orders, see Applying an authorized credit card payment to an orders API check.

The following diagram shows the process for registering your Apple Pay integration with the Toast platform and handling Apple Pay payments for guest transactions.