Skip to content

@checkout-kit/core / PaymentAction

Type Alias: PaymentAction ​

ts
type PaymentAction = 
  | ActionBase & {
  fields?: Readonly<Record<string, string>>;
  kind: "redirect";
  method: "GET" | "POST";
  returnUrlField?: string;
  surface: Exclude<ActionSurface, "inline" | "none">;
  url: string;
}
  | ActionBase & {
  fields: readonly ("number" | "exp" | "cvc" | "holder")[];
  kind: "collect_fields";
  origin: string;
  surface: "inline";
  theme?: Readonly<Record<string, string>>;
  url: string;
}
  | ActionBase & {
  integrity?: string;
  kind: "sdk_handoff";
  params: Readonly<Record<string, unknown>>;
  scriptUrl?: string;
  sdk: string;
  surface: "none";
}
  | ActionBase & {
  completion: Extract<CompletionSpec, {
     via: "poll";
  }>;
  deeplink?: string;
  format: "qr" | "code" | "instructions";
  imageUrl?: string;
  instructions?: string;
  kind: "display";
  surface: "inline";
  value: string;
}
  | ActionBase & {
  kind: "poll";
  surface: "none";
};

Apache-2.0 · Headless engine, provider adapters and runnable examples.