Skip to main content

Documentation Index

Fetch the complete documentation index at: https://mintlify.com/paynow-gg/typescript-sdk/llms.txt

Use this file to discover all available pages before exploring further.

The PayNow TypeScript SDK provides a fully type-safe interface to the PayNow API, enabling you to build e-commerce integrations with confidence. Whether you’re building a storefront experience or managing your store’s backend operations, this SDK has you covered.

​
Key features

The SDK is designed to make your development experience smooth and error-free:

Type-safe API clients

Separate clients for storefront and management operations with full TypeScript support

Auto-generated types

Types automatically generated from OpenAPI specifications ensure accuracy

Built-in error handling

PayNowError types with type guards for robust error handling

Flexible authentication

Support for customer tokens and API key authentication

Webhook types

Type definitions for all webhook payload structures

Axios-based

Built on Axios with full configuration options support

​
Two client types for different use cases

The SDK provides two distinct client types to match your integration needs:

​
Storefront client

Use the storefront client for customer-facing operations like managing carts, creating checkouts, and accessing product catalogs. This client supports optional customer token authentication for personalized experiences. 
import { createStorefrontClient } from "@paynow-gg/typescript-sdk";

const storefront = createStorefrontClient("411486491630370816");

​
Management client

Use the management client for administrative operations like managing products, orders, customers, and store configuration. This client requires API key authentication. 
import { createManagementClient } from "@paynow-gg/typescript-sdk";

const management = createManagementClient(
  "411486491630370816",
  "your-api-key"
);

​
Get started

Quickstart

Get up and running with working code in under 5 minutes

Installation

Learn how to install and configure the SDK

API reference

Explore the complete API documentation

​
Need help?

For SDK issues, open an issue on GitHub. For PayNow API documentation and support, visit the PayNow developer portal or join the Discord community.