> ## Documentation Index
> Fetch the complete documentation index at: /llms.txt
> Use this file to discover all available pages before exploring further.

# Node.js SDK

> Status of the official Simiz Node.js SDK (@simiz/node-sdk), early access and the REST API alternative.

The official Simiz Node.js SDK is named **`@simiz/node-sdk`**. It is currently in
**early access**: it is **not yet published on npm**. Until publication, installing it from
the public npm registry is not possible.

## How to integrate Simiz today

The **REST API** covers every capability (payments, customers, webhooks, refunds) and
remains the recommended integration path:

* [Quickstart](/en/quickstart) — first payment request in minutes
* [Authentication](/en/core-concepts/security/authentication) — API keys and headers
* [Error handling](/en/guides/error-handling) — error codes and resolution

To get early access to the SDK, contact the Simiz team from your dashboard.

## SDK preview

Once you have the SDK, usage looks like this:

```typescript
import { Simiz } from '@simiz/node-sdk';

const simiz = new Simiz(process.env.SIMIZ_SECRET_KEY);

const transaction = await simiz.transactions.create({
  amount: 5000,
  currency: 'XAF',
  payment_method: 'ORANGE_MONEY',
  payer: { phone: '237690000000', name: 'John Doe' },
  callback_url: 'https://your-site.com/webhooks/simiz',
});

console.log(transaction.payment_url); // Redirect the customer here
```

The SDK exposes the `transactions`, `refunds` and `customers` resources plus webhook
signature verification helpers, with built-in pagination and retries.

<Note>
  This page will be updated with installation instructions as soon as the package is
  published on npm. Until then, do not reference `@simiz/node-sdk` in a production
  `package.json`.
</Note>