absolutepay (Node SDK) - v0.7.1
    Preparing search index...

    Class AbsolutePay

    The AbsolutePay API client — the entry point to the SDK.

    Construct it once with your credentials and reuse the instance; every resource (balances, payouts, invoices, …) hangs off it as a property. When a signingSecret is configured the client HMAC-signs every request automatically. This is a SERVER-SIDE client: your API key and signing secret must never reach a browser.

    import { AbsolutePay } from "absolutepay";

    const client = new AbsolutePay({
      apiKey: process.env.ABSOLUTEPAY_API_KEY!,
      signingSecret: process.env.ABSOLUTEPAY_SIGNING_SECRET!, // apisign_…
      sandbox: true, // omit / false for production
    });

    const balances = await client.balances.list();

    Implements

    Index

    Constructors

    constructor

    Properties

    balances checkouts conversions deposits fees giftcards invoices offramp payouts reconciliation refunds subscriptions

    Methods

    request

    Constructors

    Properties

    balances: Balances

    Workspace asset balances and FX-valued summary (scope: balances:read).

    checkouts: Checkouts

    Hosted checkout links — payer picks the asset/chain (scopes: invoices:write / invoices:read).

    conversions: Conversions

    Asset-to-asset conversions + settled convert history (scopes: convert:write / convert:read).

    deposits: Deposits

    Own-balance deposit addresses + settled deposit history (scope: balances:read).

    fees: Fees

    Fee previews from the pricing matrix (scope: balances:read).

    giftcards: GiftCards

    Gift-card issuance and templates (scopes: balances:read to read, payments:write to issue).

    invoices: Invoices

    Invoices — up-front fixed-address flow (scopes: invoices:write / invoices:read).

    offramp: OffRamp

    Crypto → fiat off-ramp to a bank account (scopes: payouts:write / payouts:read).

    payouts: Payouts

    Batch crypto payouts (scopes: payouts:write / payouts:read).

    reconciliation: Reconciliation

    Settled pay-in / withdrawal ledgers for reconciliation (scope: ledger:read).

    refunds: Refunds

    Refunds on settled collections (scope: payments:write).

    subscriptions: Subscriptions

    Recurring plans and subscriptions (scopes: subscriptions:write / subscriptions:read).

    Methods

    • Low-level request primitive used by every resource. Adds the Bearer auth header, signs the request when a signing secret is set, enforces the configured timeout, and turns non-2xx responses into AbsolutePayError. You rarely call this directly — prefer the typed resource methods — but it is available for endpoints the SDK does not yet wrap.

      Type Parameters

      • T

        Expected shape of the parsed JSON response.

      Parameters

      • method: HttpMethod

        HTTP method.

      • path: string

        Path INCLUDING query string, e.g. /v1/balances?quote=USDT.

      • Optionalbody: unknown

        Optional request body; JSON-serialized and sent with content-type: application/json.

      • OptionalextraHeaders: Record<string, string>

        Optional headers merged AFTER signing (e.g. Idempotency-Key), so they are not part of the signed canonical string.

      Returns Promise<T>

      The parsed response body as T (or null when the response has no body).

      On any non-2xx response (401/403 auth, 429 rate limit, etc.).

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Methods