NOWPayments API

/**
 * NOWPaymentsAPI - generated by OmniStream from NOWPayments API's OpenAPI spec.
 * One typed method per endpoint. A single Omni key reaches the API.
 */
const DEFAULT_BASE = "https://grid.skinvaults.online/v1/proxy/nowpayments";

export class NOWPaymentsAPIError extends Error {
  status: number;
  code?: string;
  constructor(status: number, code: string | undefined, message?: string) {
    super(message || `NOWPaymentsAPI error ${status}`);
    this.name = "NOWPaymentsAPIError";
    this.status = status;
    this.code = code;
  }
}

export interface NOWPaymentsAPIOptions {
  baseUrl?: string;
  fetch?: typeof fetch;
  timeoutMs?: number;
}

export class NOWPaymentsAPI {
  /** @param token Your OmniStream key (one key for every API). */
  constructor(private token: string, private opts: NOWPaymentsAPIOptions = {}) {
    if (!token) throw new Error("NOWPaymentsAPI: token is required");
  }
  rateLimit: { remainingMinute?: number; remainingDay?: number } | null = null;

  private async _request(method: string, path: string, { params, body }: { params?: Record<string, unknown>; body?: unknown } = {}): Promise<any> {
    const f = this.opts.fetch ?? globalThis.fetch;
    const url = new URL((this.opts.baseUrl ?? DEFAULT_BASE).replace(/\/+$/, "") + path);
    if (params) for (const [k, v] of Object.entries(params)) if (v != null) url.searchParams.set(k, String(v));
    const headers: Record<string, string> = { "x-omni-key": this.token };
    if (body !== undefined) headers["content-type"] = "application/json";
    const res = await f(url, { method, headers, body: body !== undefined ? JSON.stringify(body) : undefined });
    this.rateLimit = {
      remainingMinute: Number(res.headers.get("x-ratelimit-remaining-minute")) || undefined,
      remainingDay: Number(res.headers.get("x-ratelimit-remaining-day")) || undefined,
    };
    const data = await res.json().catch(() => ({}));
    if (!res.ok) throw new NOWPaymentsAPIError(res.status, data?.error?.code, data?.error?.message);
    return data.data ?? data;
  }

  /** Get estimated price */
  getEstimatedPrice(params: { "amount"?: string; "currency_from"?: string; "currency_to"?: string; "x-api-key"?: string }): Promise<any> {
    return this._request("GET", "/v1/estimate", { params });
  }

  /** Get the minimum payment amount */
  getTheMinimumPaymentAmount(params: { "currency_from"?: string; "currency_to"?: string; "x-api-key"?: string }): Promise<any> {
    return this._request("GET", "/v1/min-amount", { params });
  }

  /** Get list of payments */
  getListOfPayments(params: { "limit"?: string; "page"?: string; "sortBy"?: string; "orderBy"?: string; "dateFrom"?: string; "dateTo"?: string; "x-api-key"?: string }): Promise<any> {
    return this._request("GET", "/v1/payment/", { params });
  }

  /** Get/Update payment estimate */
  getUpdatePaymentEstimate(params: { "id": string; "x-api-key"?: string }): Promise<any> {
    return this._request("POST", "/v1/payment/{id}/update-merchant-estimate", { params });
  }

  /** Get payment status */
  getPaymentStatus(params: { "payment_id": string; "x-api-key"?: string }): Promise<any> {
    return this._request("GET", "/v1/payment/{payment_id}", { params });
  }

  /** Verify payout */
  verifyPayout(body: unknown, params: { "withdrawals-id": string; "x-api-key"?: string }): Promise<any> {
    return this._request("POST", "/v1/payout/{withdrawals-id}/verify", { body, params });
  }

  /** Get sub-partners */
  getSubPartners(params: { "id"?: string; "offset"?: string; "limit"?: string; "order"?: string }): Promise<any> {
    return this._request("GET", "/v1/sub-partner", { params });
  }

  /** Get sub-partner balance */
  getSubPartnerBalance(params: { "id": string; "x-api-key"?: string }): Promise<any> {
    return this._request("GET", "/v1/sub-partner/balance/{id}", { params });
  }

  /** Get transfer */
  getTransfer(params: { "id": string }): Promise<any> {
    return this._request("GET", "/v1/sub-partner/transfer/{id}", { params });
  }

  /** Get all transfers */
  getAllTransfers(params: { "id"?: string; "status"?: string; "limit"?: string; "offset"?: string; "order"?: string }): Promise<any> {
    return this._request("GET", "/v1/sub-partner/transfers", { params });
  }

  /** Get many recurring payments */
  getManyRecurringPayments(params: { "status"?: string; "subscription_plan_id"?: string; "is_active"?: string; "limit"?: string; "offset"?: string; "x-api-key"?: string }): Promise<any> {
    return this._request("GET", "/v1/subscriptions", { params });
  }

  /** Get many plans */
  getManyPlans(params: { "limit"?: string; "offset"?: string; "x-api-key"?: string }): Promise<any> {
    return this._request("GET", "/v1/subscriptions/plans", { params });
  }

  /** Get one plan */
  getOnePlan(params: { "plan-id": string; "x-api-key"?: string }): Promise<any> {
    return this._request("GET", "/v1/subscriptions/plans/{plan-id}", { params });
  }

  /** Update plan */
  updatePlan(body: unknown, params: { "plan-id": string }): Promise<any> {
    return this._request("PATCH", "/v1/subscriptions/plans/{plan-id}", { body, params });
  }

  /** Get one recurring payment */
  getOneRecurringPayment(params: { "sub_id": string; "x-api-key"?: string }): Promise<any> {
    return this._request("GET", "/v1/subscriptions/{sub_id}", { params });
  }

  /** Delete recurring payment */
  deleteRecurringPayment(params: { "sub_id": string }): Promise<any> {
    return this._request("DELETE", "/v1/subscriptions/{sub_id}", { params });
  }
}

export default NOWPaymentsAPI;