Generate a checkout token

⚠️ Warning

This is a work in progress and not yet available.

If you want to use managed version of Geins Checkout you will need to create a checkout token. This token will be used by the checkout to load the cart and customer information. The token can also carry the look and feel of your brand during the checkout process.

Example: Generate a checkout token

import { GeinsCore } from '@geins/core';
import { GeinsOMS } from '@geins/oms';
import type { GenerateCheckoutTokenOptions } from '@geins/types';

const geinsSettings = {
  apiKey: 'your-api-key', // xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx
  accountName: 'your-account-name', // 'name'
  channel: 'your-channel-id', // '1'
  tld: 'your-tld', // 'com'
  locale: 'your-locale', // 'en-US'
  market: 'your-market', // 'us'
};

const geinsCore = new GeinsCore(geinsSettings);
const geinsOMS = new GeinsOMS(geinsSettings);

const checkoutTokenOptions: GenerateCheckoutTokenOptions = {
  cartId: 'my-cart-id',
};

// generate checkout token
const token = await geinsOMS.createCheckoutToken(checkoutTokenOptions);
window.open(`https://checkout.geins.services/${token}`);

Generate a checkout token

Follow these steps to generate a token for the checkout:

1. Set up your Geins Settings

2. Create a Cart

3. Generate a checkout token

Cart ID

Checkout Settings

Payment Method ID

Shipping Method ID

Customer Type

Select typeD2CB2B

Urls

Success Url

Url to redirect to after successful checkout, if you don't want to use the default one.

Cancel Url

Url to redirect to if user cancels the checkout.

Error Url

Url to redirect to if an error occurs during the checkout, if you want to use a custom one.

Terms Url

Will display a Terms link on the checkout page.

Privacy Url

Will display a Privacy link on the checkout page.

Checkout Branding

Title

Optional title for the checkout page. A tip is to add your brand name here if you don't wanna use a logo.

Icon URL

Used next to the logo or title. Will be shown in a circle as 48x48px

Logo URL

Url for your logo. Will be shown 48px high with auto width.

Font Size

Font size of the body text

Border Radius

Radius of UI elements in pixels

Branding Colors

The colors below are set to the default values.

Background Color

The first background color

Foreground Color

Color for text and icons used on the first background color

Secondary Background Color

Used as a secondary background color

Secondary Foreground Color

Color for text and icons used on the secondary background color

Accent Color

Color used on buttons and other accent elements

Accent Foreground Color

Color for text and icons used on accent elements

Border Color

Color for borders

Sale Color

Color used for sale prices in the cart