Interface ClientConfig

Configuration options for initializing the LivePay client.

Remarks

IP Whitelisting & Serverless Environments: The LivePay gateway requires strict IP whitelisting and does not allow wildcard IP whitelisting. If your deployment (e.g. Firebase Functions, AWS Lambda, Vercel) does not use a single fixed static IP, contact support@livepay.me for guidance if you experience API rejections.

interface ClientConfig {
    accountNumber?: string;
    apiKey?: string;
    baseUrl?: string;
    fetch?: {
        (input, init?): Promise<Response>;
        (input, init?): Promise<Response>;
    };
    logger?: Logger;
    maxRetries?: number;
    rateLimit?: RateLimitOptions;
    timeout?: number;
    webhookSecret?: string;
}

Properties

accountNumber? apiKey? baseUrl? fetch? logger? maxRetries? rateLimit? timeout? webhookSecret?

Properties

Optional accountNumber

accountNumber?: string

Optional apiKey

apiKey?: string

Optional baseUrl

baseUrl?: string

Optional fetch

fetch?: {
    (input, init?): Promise<Response>;
    (input, init?): Promise<Response>;
}

Type declaration

    • (input, init?): Promise<Response>

    • MDN Reference

      Parameters

      • input: URL | RequestInfo
      • Optional init: RequestInit

      Returns Promise<Response>

    • (input, init?): Promise<Response>

    • Parameters

      • input: string | URL | Request
      • Optional init: RequestInit

      Returns Promise<Response>

Optional logger

logger?: Logger

Optional maxRetries

maxRetries?: number

Optional rateLimit

rateLimit?: RateLimitOptions

Optional timeout

timeout?: number

Optional webhookSecret

webhookSecret?: string

Settings

Member Visibility

Theme

On This Page

accountNumberapiKeybaseUrlfetchloggermaxRetriesrateLimittimeoutwebhookSecret