MarzPay SDK Reference - v1.0.3
    Preparing search index...

    Interface MarzPayConfig

    interface MarzPayConfig {
        apiKey?: string;
        apiSecret?: string;
        baseUrl?: string;
        debug?: boolean;
        fetch?: {
            (input: URL | RequestInfo, init?: RequestInit): Promise<Response>;
            (input: string | URL | Request, init?: RequestInit): Promise<Response>;
        };
        logger?: Logger;
        maxRetries?: number;
        timeoutMs?: number;
        webhookSecret?: string;
    }
    Index
    apiKey? apiSecret? baseUrl? debug? fetch? logger? maxRetries? timeoutMs? webhookSecret?
    apiKey?: string

    MarzPay API Key from business dashboard. Defaults to process.env.MARZPAY_API_KEY.

    apiSecret?: string

    MarzPay API Secret from business dashboard. Defaults to process.env.MARZPAY_API_SECRET.

    baseUrl?: string

    MarzPay API base endpoint URL. Defaults to process.env.MARZPAY_API_BASE or 'https://wallet.wearemarz.com/api/v1'.

    debug?: boolean

    Enable verbose console debug logging for requests, retries, and errors. Defaults to false.

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

    Custom fetch implementation. Defaults to global fetch.

    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>

    logger?: Logger

    Pluggable custom logger instance (compatible with console, winston, pino, etc.).

    maxRetries?: number

    Maximum number of retries for 429 and 5xx errors. Defaults to 3.

    timeoutMs?: number

    Request timeout in milliseconds. Defaults to 30,000 (30 seconds).

    webhookSecret?: string

    Optional webhook HMAC signing secret. Defaults to process.env.MARZPAY_WEBHOOK_SECRET.

    Settings
    Member Visibility

    On This Page
    Properties