@lanari/quickpay

QuickPay Gateway SDK for integrating payment services into your website or app.
Provides secure, token-based access to QuickPay APIs for initiating payments, checking status, and retrieving transaction history.

Installation

npm install @lanari/quickpay

--
## Initialization


```bash
const QuickPay = require("@lanari/quickpay");

const qp = new QuickPay({
  clientId: "YOUR_CLIENT_ID",
  clientSecret: "YOUR_CLIENT_SECRET",
  baseUrl: "https://api.quickpay.rw/v1",
});
---

clientId – your developer/client ID provided after payment.

clientSecret – your API secret token.

baseUrl – QuickPay API base URL.


Methods
createPayment({ amount, currency, recipient, description })

Initiates a new payment.

Parameters:

amount (number) – amount to pay

currency (string, optional) – default "RWF"

recipient (string) – recipient phone or account

description (string) – payment description


const payment = await qp.createPayment({
  amount: 15000,
  recipient: "0788123456",
  description: "Hosting service payment",
});
console.log(payment);


getPaymentStatus(paymentId)

Checks the status of a payment.

const status = await qp.getPaymentStatus("payment_id_here");
console.log(status);


getTransactionHistory()

Retrieves all transactions for your account.

const history = await qp.getTransactionHistory();
console.log(history);



validateToken()

Verifies that your API token is valid.

const valid = await qp.validateToken();
console.log(valid);



Headers Used

All requests automatically include:

Authorization: Bearer <clientSecret>

x-client-id: <clientId>

No manual header setup is required in the SDK.


# Example Full Flow
    const QuickPay = require("@lanari/quickpay");

(async () => {
  const qp = new QuickPay({
    clientId: "QP_DEV_001",
    clientSecret: "sk_test_a8c3d98b27f",
    baseUrl: "https://api.quickpay.rw/v1",
  });

  // Create payment
  const payment = await qp.createPayment({
    amount: 20000,
    recipient: "0788123456",
    description: "Subscription fee",
  });
  console.log("Payment:", payment);

  // Check status
  const status = await qp.getPaymentStatus(payment.id);
  console.log("Status:", status);

  // Get history
  const history = await qp.getTransactionHistory();
  console.log("History:", history);
})();



Support

For questions or integration help, contact Lanari HQ.