@ariyor/sdk

Premium Node.js SDK for the Ariyor financial operating system. Build world-class financial experiences for African SMEs and NGOs.

Installation

npm install @ariyor/sdk
# or
yarn add @ariyor/sdk

Quick Start

import { Ariyor } from '@ariyor/sdk';

const ariyor = new Ariyor({
  secretKey: 'ary_sk_live_...', // Your secret key from the Ariyor Dashboard
});

// Retrieve a campaign
const campaign = await ariyor.campaigns.retrieve('medical-outreach-2026');
console.log(`Raised: ${campaign.currency} ${campaign.totalRaised}`);

// Create an invoice
const invoice = await ariyor.invoices.create({
  customerId: 'cust_abc123',
  amount: 25000,
  currency: 'NGN',
  items: [{ description: 'Strategy Session', price: 25000, quantity: 1 }]
});

Features

• Campaigns: Manage donations and product sales campaigns.
• Transactions: List and retrieve transaction history.
• Invoices: Generate and send tax-compliant invoices.
• Customers: Manage your donor or client database.
• Webhooks: Secure signature verification for incoming events.

Security

The Ariyor SDK uses HMAC-SHA256 signatures to ensure the integrity of webhooks. Verification is built-in:

const isValid = ariyor.webhooks.verify(rawBody, signature);

Documentation

For full API documentation, visit docs.ariyor.io.

License

MIT