budpay-node

BudPaySDK for Node.js

BudPaySDK is a Node.js library that provides a convenient way to interact with the BudPay API. BudPay is a payment gateway that allows you to handle various payment operations such as initializing transactions, verifying transactions, creating payment links, requesting payments, and more.

Installation

You can install BudPaySDK via npm:

npm install budpay-node

Usage

To use BudPaySDK, you need to import the library and create an instance of the BudPaySDK class with your secret key and public key:

const BudPaySDK = require('budpay-node');

const secretKey = 'YOUR_SECRET_KEY';
const publicKey = 'YOUR_PUBLIC_KEY';

const budPay = new BudPaySDK(secretKey, publicKey);

Initializing a Transaction

To initialize a payment transaction, use the initializeTransaction method:

const amount = 100.0;
const card = {
  number: '4111111111111111',
  cvv: '123',
  expiry_month: '12',
  expiry_year: '25',
};
const currency = 'USD';
const email = '[e-mail]';
const reference = 'ORDER_123';

try {
  const transaction = await budPay.initializeTransaction(amount, card, currency, email, reference);
  console.log('Transaction initialized:', transaction);
} catch (error) {
  console.error('Error initializing transaction:', error);
}

Verifying a Transaction

To verify the status of a transaction, use the verifyTransaction method:

const reference = 'ORDER_123';

try {
  const transaction = await budPay.verifyTransaction(reference);
  console.log('Transaction verified:', transaction);
} catch (error) {
  console.error('Error verifying transaction:', error);
}

Creating a Payment Link

To create a payment link, use the createPaymentLink method:

const amount = 100.0;
const currency = 'USD';
const name = 'Product Name';
const description = 'Product description';
const redirect = 'https://example.com/payment-success';

try {
  const paymentLink = await budPay.createPaymentLink(amount, currency, name, description, redirect);
  console.log('Payment link created:', paymentLink);
} catch (error) {
  console.error('Error creating payment link:', error);
}

Requesting a Payment

To request a payment from a recipient, use the requestPayment method:

const recipient = '[e-mail]';
const amount = 100.0;
const currency = 'USD';
const description = 'Payment for services rendered';

try {
  const paymentRequest = await budPay.requestPayment(recipient, amount, currency, description);
  console.log('Payment request created:', paymentRequest);
} catch (error) {
  console.error('Error requesting payment:', error);
}

Documentation

For more details on the available methods and their parameters, please refer to the BudPaySDK Documentation.

Author

• LinkedIn: ibroraheem
• Twitter: ibroraheem
• GitHub: ibroraheem

License

This project is licensed under the MIT