Checkout

When placing a booking. It is often required to take some form of upfront payment.

To do this, you can utilise our eCommerce checkout API to create a checkout url to direct the user to, and once they have paid, can be brought back to your purchase flow to complete the booking.

This return will include a payment id, which you can then send along with the creation of the booking, to allocate the payment against it.

mutation {
  ecommerce {
    checkout {
      createCheckout(
        buildingId: ID!, # This is required to ascertain which merchant account
        price {
          amount: Integer
        }
        # The URL to redirect your customer back to after they authenticate
        # or cancel their payment on the payment method’s app or site. 
        returnUrl: string
        # The URL to redirect the customer back to once payment has been taken
        successUrl: string
      ) {
        url
      }  
    }
  }
}