PayFanout API reference
    Preparing search index...

    Interface AdyenClientAdapterConfig

    interface AdyenClientAdapterConfig {
        adyenEnvironment?: string;
        clientKey: string;
        countryCode: string;
        cspNonce?: string;
        environment: "sandbox" | "live";
        getAdyenGlobal?: () => AdyenWebGlobal | undefined;
        loadScript?: (url: string) => Promise<void>;
        loadStylesheet?: (url: string) => Promise<void>;
        locale?: string;
        paymentMethods?: PaymentMethodCapability[];
        sdkUrl?: string;
        sdkVersion?: string;
        stylesheetUrl?: string;
    }
    Index
    adyenEnvironment? clientKey countryCode cspNonce? environment getAdyenGlobal? loadScript? loadStylesheet? locale? paymentMethods? sdkUrl? sdkVersion? stylesheetUrl?
    adyenEnvironment?: string

    The environment value handed to Adyen Web, which also selects the CDN host the SDK loads from (checkoutshopper-{value}.cdn.adyen.com): Adyen requires both to match the region of the account's live endpoints. Defaults to "test" on sandbox and "live" (Europe) on live; a live account served from another region sets "live-us", "live-au", "live-nea", "live-in" or "live-apse". The value is lowercased first, as Adyen Web does itself. "live-apse" is accepted because Adyen Web types it and maps it to its own hosts, which serve the pinned build, though Adyen's v6 integration guides do not list it. Any other value, or one that contradicts environment, is refused at construction.

    clientKey: string

    Browser-safe client key; its origins are allowlisted in the Customer Area. Adyen prefixes every client key with its environment, and the constructor refuses a client key that does not start with test_ on sandbox or live_ on live (a legacy origin key included).

    countryCode: string

    ISO 3166-1 alpha-2. Adyen Web v6 requires it on the checkout instance.

    cspNonce?: string

    A Content-Security-Policy nonce for the two tags the adapter injects, the Adyen Web <script> and the stylesheet <link>, set as their nonce attribute before insertion, so a script-src and a style-src that allow them by nonce load them; a 'strict-dynamic' script-src allows the script without one, and never applies to styles. The Card component reads no nonce and adds no script or <style> of its own, unless fieldOptions configures a wallet such as Click to Pay. Pass the value alone, as in the policy's 'nonce-<value>' source; the constructor refuses anything else. The adapter never reads a nonce from the page, and the loadScript and loadStylesheet seams load their file without it.

    environment: "sandbox" | "live"

    Explicit; selects the client key prefix, the CDN host and the SDK's own environment value.

    getAdyenGlobal?: () => AdyenWebGlobal | undefined

    Test seam: returns the SDK in place of window.AdyenWeb.

    loadScript?: (url: string) => Promise<void>

    Test seam: loads the script in place of the adapter's injection, which carries the integrity check.

    loadStylesheet?: (url: string) => Promise<void>

    Test seam: loads the stylesheet in place of the adapter's injection, which carries the integrity check.

    locale?: string

    BCP-47 locale for Adyen's own field texts. MountOptions.locale wins per mount.

    paymentMethods?: PaymentMethodCapability[]

    Account capabilities vary per contract — override the conservative default.

    sdkUrl?: string

    Self-hosting: the script URL to load instead of Adyen's CDN copy, without an integrity check.

    sdkVersion?: string

    Adyen Web version to load from the CDN instead of ADYEN_WEB_VERSION. Pinned, never floating. The adapter carries Adyen's integrity hashes for its own pinned build only, so with this set both files load without an integrity check.

    stylesheetUrl?: string

    Self-hosting: the stylesheet URL to load instead of Adyen's CDN copy, without an integrity check. An empty string loads no stylesheet, for a page that ships Adyen Web's styles itself. loadSdk() waits for the sheet to load or fail, and with it for every sheet it @imports, so a sheet that imports from a slow host delays the first mount on each page load.

    Settings
    Member Visibility

    On This Page
    Properties