The imin Platform
2.0.0
2.0.0
  • Introduction to the imin Platform
  • Using the Platform
    • imin's Platform Products
    • Authentication
    • Our Platform Data
      • Understanding Responses
      • Namespaces and Extensions
      • Defensive Data Consumption
      • Mocking the Interface
  • platform products
    • Search
      • imin Events API
        • Events API Reference
        • Virtual & Physical Sessions
        • Concepts
          • EventSeries
          • ScheduledSessions and eventSchedules
          • Activities and Collections
            • Activities
            • Activity Concept Collections
          • Accessibility Support
          • Prices
        • Filters
          • Modes
          • Age Ranges
          • Dates and Times
          • Activities and Concept Collections
          • High Frequency Sessions
      • imin Facilities API
        • Query Parameter Search
          • Mandatory Query Parameters
            • mode=discovery-geo
            • mode=upcoming-slots
          • Optional Query Parameters
        • ByID Search
          • FacilityUse By-ID
          • Slot By-ID
        • FacilityUses and IndividualFacilityUses
        • Slots
        • Facilities Slot Booking
      • imin Places API [BETA]
        • Example Request & Response
    • Firehose
      • Introduction to the Firehose
      • Accessing the Firehose
      • Firehose Usage Policy & Restrictions
      • Firehose and Search
      • Bookable Firehose Feeds
      • Bookable Sellers Feed
      • Attribution Catalog Endpoint
    • Live Timetables
      • Pre-Requisites: Open Data Feeds
      • The Onboarding Process
        • 1. Ensuring your Data Offers the Best User Experience
        • 2. Setting up and Embedding your First Timetable
        • 3. Setting up the Rest of your Timetables
        • 4. Activating Booking via Guest Checkout
      • Features Available Upon Request
      • Styling the Live Timetables
      • FAQs
    • Data Dashboard
  • incorporating book and pay
    • imin Branded Checkout
      • Introduction
      • Setup
        • Information We Require From You
        • Actions You Need to Complete
      • Authenticated Checkout
        • Testing [BETA]
        • 👪Group Booking [BETA]
      • Standalone Checkout
      • Firehose and Checkout [BETA]
        • Loading the Checkout via Firehose
    • imin Booking Platform
      • Customer Account Management
        • Create Customer Account
        • Update Customer Account
        • Get Customer Account
        • Delete Customer Account
        • Example Scenario
        • Payment Card Management
        • Linked Accounts
        • Entitlement
          • Evidence Requests
          • Entitlement Pricing in Search
          • Entitlement Pricing in Checkout
        • Access Pass
        • Webhooks
      • Orders
        • Order History
        • Order (by ID)
        • Cancellations & Refunds
      • Upcoming OrderItems
      • Receipt (by ID)
  • imin and booking systems
    • Seller Onboarding
      • API
  • HINTS & TIPS
    • Get the Best Out of Search
      • Displaying Schedule Information
      • URLs and Offering a Call to Action
      • Searching by Activity
      • Your Search Results and HighFrequencySessions
      • Customer Specific Images
  • Info for Data Publishers
    • Your RPDE Feed & the imin Platform [BETA]
      • Providing Places Data [BETA]
      • Providing Schedule Information [BETA]
Powered by GitBook
On this page
  • Update your DNS Settings
  • checkoutBaseUrl
  • Sender Authentication
  • Add a "Book" Button to your Search Platform
  • Update Legal Information to Reference imin
  • Update your Cookie Policy
  • Setup Analytics on your Search Platform
  1. incorporating book and pay
  2. imin Branded Checkout
  3. Setup

Actions You Need to Complete

PreviousInformation We Require From YouNextAuthenticated Checkout

Last updated 6 months ago

Update your DNS Settings

checkoutBaseUrl

The Checkout will be hosted on yourprimarydomain.com, which will have checkout.as a sub-domain, for example https://checkout.yourprimarydomain.com. This custom domain base URL is known as the checkoutBaseUrl.

By way of example, the checkoutBaseUrl for www.badmintonengland.co.uk is https://checkout.badmintonengland.co.uk.

By altering your DNS settings accordingly, when users click the "Book" button on your search platform, imin will be able to generate the Checkout page for them to book and pay for their chosen activity. It also allows imin to remotely update and resolve any issues.

What you need to do:

  • In your name server, add the CNAME record that imin provides to you with:

    • Name: checkout.yourprimarydomain.com; and

    • Target/value: imin-checkout-2.azureedge.net.

  • You can check that this has worked by inputting the checkoutBaseUrl into .

If you require additional checkout for testing purposes, then these will will also need these to be added to your name server.

If you do not want to use checkout. as the subdomain, please get in touch.

Sender Authentication

You also need to add further DNS records to prevent confirmation emails going to spam folders (this is only actionable once step 1 above has been completed).

What you need to do:

  • Tell us which provider is your DNS host, e.g. Cloudflare, 123 Reg, GoDaddy, etc.

  • We will provide you with three CNAMEs and their corresponding values, which you will need to enter into your DNS host. These will take the following form:

    • Host: em123.yourwebsite.co.uk

    • Value: u1234567890.wl105.sendgrid.net

Once you have confirmed completion of this step, we will perform some tests before putting it live on your primary domain.

imin uses the Stripe API and we have completed the necessary work to use a modern version of TLS in order to comply with PCI-DSS, as per Stripe's guidelines.

Add a "Book" Button to your Search Platform

In your user flow, the user will need to perform an action (normally clicking a “Book” button or a link) to indicate they wish to proceed to the Checkout, where they can select which session time slot they would like to book, before proceeding to payment.

In order for your branded Checkout to appear, you will need to ensure that your "Book" button opens the webpage specified by the imin:checkoutUrlTemplate, with the template placeholdercheckoutBaseUrl to be replaced by your custom domain base URL (e.g. https://checkout.yourwebsite.com).

For example "imin:checkoutUrlTemplate": "{checkoutBaseUrl}/v1/events/fusion-123" should be rendered as "https://checkout.yourwebsite.com/v1/events/fusion-123".

Bookable sessions provided via the imin Events API will have an imin:checkoutUrlTemplate. Please note that there are two imin:checkoutUrlTemplates provided within subEvent of the API:

  • A session-level imin:checkoutUrlTemplate at SessionSeries level; and

  • An occurrence-level imin:checkoutUrlTemplate for each specific occurrence of a bookable session at the ScheduledSession level.

Not all ScheduledSession will have an imin:checkoutUrlTemplate. This could be because a ScheduledSession may be outside of the booking window (7 days), have no remaining capacity, or belong to a provider that is not yet bookable.

Please note that imin:checkoutUrlTemplate was previously located within imin:aggregateOffer at the EventSerieslevel, however, this is no longer the case. imin:checkoutUrlTemplate is now only available within the subEvent of SessionSeries and thesubEventofScheduledSession.

In order to enable Apple Pay and Google Pay, when the user clicks the “Book” button, it should open in:

  • The same tab for web;

  • A SFSafariViewController for iOS; and

  • A Webview for Android.

If you are exclusively offering booking via a mobile app, a native in-app web-browser can be used to show the Checkout without pushing the user over to Chrome or Safari. For this you will still need a checkoutBaseUrl to enable you to direct the end user to your Branded Checkout in your app.

Update Legal Information to Reference imin

As such, your user-facing documentation needs to reflect the fact that several parties are involved in providing the booking and payment service to the end user. This documentation can include terms & conditions and/or a privacy policy.

What you need to do:

Update your Cookie Policy

Your cookie policy needs to reflect the fact that Stripe, the third party payment platform that we use within our Checkout, generates two cookies on our Checkout pages.

What you need to do:

  • Update your cookie policy to reflect the presence of cookies for the purposes of fraud prevention and detection of suspicious activity.

Example wording you could include in your cookie policy:

Stripe, the payment processor used for guest bookings, generates two cookies on our checkout page for the purposes of fraud prevention and detection of suspicious activity.

Setup Analytics on your Search Platform

By setting up analytics from the start, we can work with you to better understand what how the search platform is performing and where data improvements and UX enhancements can be made.

What you need to do:

  • Setup analytics on the search platform.

  • Let us know if you use Google Tag Manager and we can provide you with instructions.

When you begin working with imin, you must agree to and comply with our (Schedule 4, clause 4). These terms state that, in situations where imin is processing personal data about your users on your behalf (such as during a booking), you must provide said users with a prominent link to imin's .

Add a prominent link to imin's to your terms & conditions (or your privacy policy if you do not have terms & conditions).

A failure to update your documentation (either your terms & conditions or your privacy policy) in this manner will be considered a breach of our .

Stripe has informed us that it is not possible to remove these cookies, and that they are used for the purposes of fraud prevention and detection of suspicious activity. If you do not update your cookie policy to reference these types of cookies, this will be considered a breach of our .

Google Dig
Service Terms of Use
Privacy Policy
Privacy Policy
Service Terms of Use
terms