checkout( )

Performs a checkout on reserved tickets.

Migration Instructions

To stay compatible with future changes, migrate to checkout().

To migrate to the new method:

  1. Add a backend file to your site.

  2. Write a code so that it replaces the checkout() method from the frontend with the checkout() method from the backend. Export your backend function so that it can be used in the frontend.

  3. Import your backend function into the frontend file. Test your changes to make sure your code behaves as expected.

To checkout tickets, you must first call reserve() to reserve the tickets.

Use the returned order to process payment for the tickets by passing the order's paymentId to startPayment(). Note that since the order has a paymentId, you don't need to first call createPayment() to create a payment.

Before using startPayment(), you will need to set up a site to accept payments. To learn more, see Accepting Payments: An Overview. When setting up a site to accept payments, be sure to select the payment methods to offer and set the payment currency.

Notes:

  • The frontend Events APIs aren't functional when previewing a site. View a published version of a site to see their complete functionality.
  • With this method it's not possible to have separate ticket reservation forms for each ticket. You can only have 1 reservation form per ticket order.
Method Declaration
Copy
Method Parameters
eventIdstringRequired

ID of the event that the ticket reservations are for.

reservationIdstringRequired

ID of the ticket reservations.

checkoutInfoCheckoutInfoRequired

Information related to the checkout.

Returns
Return Type:Promise<CheckoutResponse>
Errors

This method doesn't return any custom errors, but may return standard errors. Learn more about standard Wix errors.

Did this help?