SDK reference

function initEscrowCheckout(config: InitConfig): void;
function pay(input: PayInput): Promise<void>;

interface InitConfig {
  publicKey: string;
  scriptUrlOverride?: string;
  globalName?: string;
  crossOrigin?: '' | 'anonymous' | 'use-credentials';
}

interface PayInput {
  paymentToken: string | string[];
  reference: string;
  redirectUrl: string;
  logoUrl?: string;
  brand?: string;
  customerId?: string;
  extra?: Record<string, unknown>;
  callback?: (result: any) => void;
  onClose?: () => void;
}

interface SessionResponse {
  session: unknown;
}

type EscrowWidget = (options: Record<string, unknown>) => void;

type EscrowCheckoutErrorCode =
  | 'NOT_INITIALIZED'
  | 'BROWSER_ONLY'
  | 'INVALID_INPUT'
  | 'WIDGET_LOAD'
  | 'NETWORK'
  | 'SESSION_CREATE'
  | 'SESSION_RESPONSE';

interface UseEscrowCheckoutResult {
  ready: boolean;
  loading: boolean;
  error: Error | null;
  pay: typeof pay;
}

function useEscrowCheckout(): UseEscrowCheckoutResult;

interface EscrowCheckoutButtonProps {
  paymentToken: string | string[];
  reference: string;
  redirectUrl: string;
  children?: React.ReactNode;
  disabled?: boolean;
  className?: string;
  title?: string;
  brand?: string;
  customerId?: string;
  logoUrl?: string;
  callback?: (result: any) => void;
  onClose?: () => void;
  extra?: Record<string, unknown>;
}

class EscrowCheckoutError extends Error {
  code: EscrowCheckoutErrorCode;
  status?: number;
  details?: unknown;
  constructor(
    message: string,
    code: EscrowCheckoutErrorCode,
    options?: { status?: number; details?: unknown },
  );
}