Better Payment 0.11.1 API
    Preparing search index...

    Interface SipayConfig

    Sipay configuration

    Values come from the Sipay merchant panel (Settings > Integration & API):

    • appId / appSecret: API credentials, used to get the Bearer token and to sign and verify hash keys
    • merchantKey: the merchant key sent with every payment request
    interface SipayConfig {
        appId: string;
        appSecret: string;
        baseUrl?: string;
        fetch?: (input: RequestInfo | URL, init?: RequestInit) => Promise<Response>;
        locale?: string;
        logger?: BetterPaymentLogger;
        merchantKey: string;
        retry?: RetryConfig;
        saleWebhookKey?: string;
        validate?: boolean;
    }

    Hierarchy (View Summary)

    Index
    appId appSecret baseUrl? fetch? locale? logger? merchantKey retry? saleWebhookKey? validate?
    appId: string
    appSecret: string
    baseUrl?: string
    fetch?: (input: RequestInfo | URL, init?: RequestInit) => Promise<Response>

    Custom fetch implementation for API calls. Default: globalThis.fetch.

    Type Declaration

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

      • MDN Reference

        Parameters

        • input: RequestInfo | URL
        • Optionalinit: RequestInit

        Returns Promise<Response>

    locale?: string
    logger?: BetterPaymentLogger
    merchantKey: string
    retry?: RetryConfig
    saleWebhookKey?: string

    sale_web_hook_key sent with payments. Set it to have Sipay notify the sale webhook defined for this key in the merchant panel.

    validate?: boolean

    Validate requests before calling the provider (card, amounts, basket, required fields). Default: true.

    Settings
    Member Visibility

    On This Page
    Properties