PayFanout API reference
    Preparing search index...

    Interface PayZenServerAdapterConfig

    interface PayZenServerAdapterConfig {
        apiBaseUrl?: string;
        environment: "sandbox" | "live";
        fetch?: {
            (input: URL | RequestInfo, init?: RequestInit): Promise<Response>;
            (input: string | URL | Request, init?: RequestInit): Promise<Response>;
        };
        hmacKey?: string
        | string[];
        maxNetworkRetries?: number;
        now?: () => number;
        password: string | string[];
        paymentMethods?: PaymentMethodCapability[];
        requestTimeoutMs?: number;
        shopId: string;
        sleep?: (ms: number) => Promise<void>;
    }
    Index
    apiBaseUrl? environment fetch? hmacKey? maxNetworkRetries? now? password paymentMethods? requestTimeoutMs? shopId sleep?
    apiBaseUrl?: string

    REST API base up to (excluding) /V4 — the Back Office "Server name" plus "/api-payment". Sister Lyra platforms use different hosts, so this is config, not a constant. Default: https://api.payzen.eu/api-payment

    environment: "sandbox" | "live"

    Explicit, never inferred. PayZen selects TEST vs LIVE by the KEY SET, not the endpoint — the adapter validates that the password family matches this declaration and refuses mismatches.

    fetch?: {
        (input: URL | RequestInfo, init?: RequestInit): Promise<Response>;
        (input: string | URL | Request, init?: RequestInit): Promise<Response>;
    }

    Injected for tests.

    Type Declaration

      • (input: URL | RequestInfo, init?: RequestInit): Promise<Response>

      • MDN Reference

        Parameters

        • input: URL | RequestInfo
        • Optionalinit: RequestInit

        Returns Promise<Response>

      • (input: string | URL | Request, init?: RequestInit): Promise<Response>

      • MDN Reference

        Parameters

        • input: string | URL | Request
        • Optionalinit: RequestInit

        Returns Promise<Response>

    hmacKey?: string | string[]

    Back Office "HMAC-SHA-256 key" — signs BROWSER-return kr-answers (kr-hash-key: "sha256_hmac"). Optional because IPN-only integrations never see that path. Accepts an array for rotation.

    maxNetworkRetries?: number

    Automatic retries for transport-level trouble only (network failure, timeout, HTTP 5xx, 429) with exponential backoff. Default 2. PayZen answers HTTP 200 even for errors, so business errors NEVER retry here — and because PayZen has no idempotency mechanism at all, refunds and state-transition calls are never auto-retried either (a lost response may mean the operation was applied); their transport failures surface retryable: false so callers cannot replay them blindly.

    now?: () => number

    Injected clock for tests (epoch milliseconds, default Date.now). Feeds the default subscription effectDate and the pending-vs-active status derivation of native subscriptions.

    password: string | string[]

    REST API password for the SELECTED environment (testpassword_… / prodpassword_…). Also the HMAC key that signs IPN kr-answers (kr-hash-key: "password"). An array keeps old + new valid while the Back Office key is being regenerated (any entry verifies IPNs); the FIRST entry authenticates REST calls.

    paymentMethods?: PaymentMethodCapability[]

    Wallet/APM enablement varies per shop contract — override the conservative card-only default once the Back Office lists the contract (e.g. flip { type: "paypal", flow: "popup", supported: true }). Overrides wholesale, like every adapter with per-account rails.

    requestTimeoutMs?: number

    Abort a hung PayZen connection after this many milliseconds (default 30000). The timer covers the whole exchange including the response body read. Timeouts surface as psp_unavailable — retryable except on refund/cancel/validate, whose outcome is unknown.

    shopId: string

    Back Office "User" — the numeric shop id, Basic-auth username.

    sleep?: (ms: number) => Promise<void>

    Injected backoff sleep for retry tests; defaults to real setTimeout.

    Settings
    Member Visibility

    On This Page
    Properties