@checkout-kit/core / CompletionSpec

Type Alias: CompletionSpec

type CompletionSpec = 
  | {
  via: "return_url";
}
  | {
  correlationField?: string;
  origin: string;
  type: string;
  via: "post_message";
}
  | {
  intervalMs: number;
  timeoutMs: number;
  via: "poll";
}
  | {
  via: "sdk_callback";
};

How the runner will learn that the action finished.

Union Members

Type Literal

{
  via: "return_url";
}

---

Type Literal

{
  correlationField?: string;
  origin: string;
  type: string;
  via: "post_message";
}

correlationField?

optional correlationField?: string;

Field in the message that carries the action id. Defaults to actionId; banks name it challengeId, MD and so on, and the check still has to happen.

origin

origin: string;

type

type: string;

via

via: "post_message";

---

Type Literal

{
  intervalMs: number;
  timeoutMs: number;
  via: "poll";
}

---

Type Literal

{
  via: "sdk_callback";
}