BoomPay SDK

BoomPay SDK is a powerful library allowing developers to interact seamlessly with the BoomPay API. The key features encompassed by this SDK include:

• Payment intent creation and retrieval
• Default Wallet retrieval
• Convenient Webhook integration

The SDK is built to support both TypeScript and JavaScript.

Installation

Use the following command to install the BoomPay SDK via npm:

npm install boompay-sdk

Basic Usage

Start by importing the SDK and initializing it with your API key:

const BoomPay = require('boompay-sdk');

const boomPay = new BoomPay({
  apiKey: 'your-api-key',
  sandbox: true, // Optional: Enable the sandbox mode for testing purposes.
});

// Rest of your code

SDK Methods

Create a Wallet

Wallets are now created on the Boom App. You can download it here. Once created this will be the wallet which is tied to your API Key hence you won't need to specify the wallet address on API requests.

Create a Payment Intent

Create a new payment intent by specifying the amount, URLs for success and failure scenarios, additional metadata, and a label:

const payment = await boomPay.payments.createIntent({
  amount: 5,
  currency: 'BMC',
  successUrl: 'https://your-success-url.com',
  failureUrl: 'https://your-failure-url.com',
  metadata: {
    anyKey: 'anyValue',
  },
  label: 'Payment Label',
});

console.log(payment);

Retrieve a Payment

Retrieve details of a specific payment using its ID:

const payment = await boomPay.payments.getPayment('payment-id');

console.log(payment);

Retrieve the Default Wallet

Retrieve details of the default wallet:

const defaultWallet = await boomPay.wallets.getDefaultWallet();

console.log(defaultWallet);

Webhooks

BoomPay SDK provides an Express middleware for webhook handling. In addition to delivering the data payload, each webhook event comes with a signature in the request header. This signature is essential for verifying the authenticity of the event.

app.get('/webhook/success', boomPay.webhooks({
  apiKey: 'zHTRNaf6gaTE3YC2HI72PJjiyBtik1Q8',
}), (req, res) => {
  return res.status(200).send('OK');
});

The BoomPay SDK handles this verification process automatically when you use the provided boomPay.webhooks() function, ensuring the data received is indeed from BoomPay.

Error Handling

Ensure you handle exceptions for each function as they would throw an Error if the request fails:

try {
  const wallet = await boomPay.wallets.getDefaultWallet();
} catch (error) {
  console.error('Error getting default wallet:', error);
}

Sandbox Mode

The SDK offers a sandbox mode to aid testing. Enable it by setting the sandbox option to true:

const boomPay = new BoomPay({
  apiKey: 'your-sandbox-api-key',
  sandbox: true, // Enable sandbox mode
});

Supported Currencies

The SDK supports only Boomcoin (BMC) and as such there is no need to specify the currency when creating a payment intent.

TypeScript Support

TypeScript definitions for all types and interfaces are included. Simply import BoomPay from boompay-sdk:

import BoomPay from 'boompay-sdk';

Use the SDK just as in the JavaScript examples.