# SDK Reference

Official client libraries for integrating HivePay into your applications.

The official TypeScript SDK provides a fully typed, promise-based API for interacting with HivePay.

• Full TypeScript support with comprehensive type definitions
• Promise-based API with async/await
• Native async iterators for pagination
• Built-in webhook verification
• Custom error types for easy error handling
• Zero dependencies (uses native fetch)
• Tree-shakeable ESM module
• Works in Node.js 18+ and modern browsers

import { HivePay } from '@hivepay/client';

const hivepay = new HivePay({ apiKey: 'sk_live_xxx' });

// Create a payment
const payment = await hivepay.payments.create({
  amount: '10500',
  currency: 'HBD',
  description: 'Order #123'
});

// Redirect to checkout
window.location.href = payment.checkoutUrl;

const { HivePay } = require('@hivepay/client');

const hivepay = new HivePay({ apiKey: 'sk_live_xxx' });

const payment = await hivepay.payments.create({
  amount: '10500',
  currency: 'HBD',
  description: 'Order #123'
});

Webhook verification requires a secure context (HTTPS or localhost).

• npm Package
• GitHub Repository
• TypeScript Definitions