Skip to main content
The UQPAY Node.js SDK provides typed access to the UQPAY API, including automatic authentication, pagination, retries, and webhook verification.

npm

@uqpay/sdk
The SDK requires Node.js 22 or later. Version 1.2.0 is its first release in the coordinated client release line.

Installation

Quick start

Before you begin, create a sandbox account and create API keys.

Configuration

Pass options when you create the client:

Authentication

The SDK uses your clientId and apiKey to retrieve a UQPAY Access Token, caches it, and retrieves a new Token before the current one expires. You do not need to manage Tokens manually.

Acting on behalf of a sub-account

To make API calls on behalf of a connected sub-account, pass the x-on-behalf-of header:

Idempotency

Every request includes an auto-generated UUID idempotency key. To provide your own:

Pagination

All list methods return a PaginatedResponse<T> with data, total_pages, and total_items:
Increment page_number until it reaches total_pages to paginate through all results.

Logging

Enable debug logging to see all requests and responses:
Sensitive fields (apiKey, card_number, cvc, iban, etc.) are automatically redacted. You can add custom fields to redact:

Escape hatch

For endpoints not yet covered by the SDK, use the generic request method:

Platform info

If you are building a platform on top of UQPAY, attach your app info to the User-Agent header:
Stablecoin Account (Ramp) is not included in the current SDK product scope.