Quick Start
Get up and running with Nile Pay in 5 minutes
Get started with Nile Pay in three simple steps.
Sign Up
Create a merchant account at nilepay.nilesquad.com. After onboarding, you'll receive your API credentials from the merchant dashboard.
Install the SDK
pnpm add @nilepay/sdkCollect Your First Payment
Initialize the client and start accepting payments:
import { createNilePay } from "@nilepay/sdk";
import { randomUUID } from "crypto";
const nilePay = createNilePay({
environment: "sandbox",
apiKey: "npk_sandbox_...",
apiSecret: "nps_sandbox_...",
});
const payment = await nilePay.collectPayment({
amount: 5000,
currency: "UGX",
customer: { phone: "256700000000" },
reference: randomUUID(),
description: "Order #1234",
});
payment.on("success", (data) => {
console.log("Payment successful!", data.transactionId);
});Next Steps
- Installation, detailed setup instructions
- Your First Payment, complete payment flow walkthrough
- SDK Reference, all available methods and options