Skip to content
Docs
Reference

Type Alias: CheckoutMessage

Type Alias: CheckoutMessage in @ticketlayer/live.

@ticketlayer/live


@ticketlayer/live / native / CheckoutMessage

type CheckoutMessage = 
  | {
  type: "tl:ready";
  version: 1;
}
  | {
  height: number;
  type: "tl:height";
  version: 1;
}
  | {
  accessToken?: string;
  orderId: string;
  orderReference: string;
  type: "tl:complete";
  version: 1;
}
  | {
  type: "tl:close";
  version: 1;
}
  | {
  code: string;
  message: string;
  type: "tl:error";
  version: 1;
};

Defined in: native/checkoutUrl.ts:124

Messages the hosted checkout posts to the WebView (protocol version 1).

Union Members#

Type Literal#

{
  type: "tl:ready";
  version: 1;
}

Type Literal#

{
  height: number;
  type: "tl:height";
  version: 1;
}

Type Literal#

{
  accessToken?: string;
  orderId: string;
  orderReference: string;
  type: "tl:complete";
  version: 1;
}

accessToken?#

optional accessToken?: string;

Order possession token: lets the app read the order as a guest (X-Order-Access-Token).

orderId#

orderId: string;

orderReference#

orderReference: string;

type#

type: "tl:complete";

version#

version: 1;

Type Literal#

{
  type: "tl:close";
  version: 1;
}

Type Literal#

{
  code: string;
  message: string;
  type: "tl:error";
  version: 1;
}