Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs-openpay.nipuntheekshana.com/llms.txt

Use this file to discover all available pages before exploring further.

​
Quickstart

This guide walks you through integrating Open Pay into your application. By the end, you will be able to create checkout sessions and handle payment webhooks.
You need a verified merchant account to get API keys. The verification process typically takes under 24 hours.
1

Create a Merchant Account

Sign up at the Merchant Portal with your email and password. You will receive a confirmation email to verify your address.
https://olp-merchant.nipuntheekshana.com/register
2

Complete KYC Verification

After signing in, navigate to Settings > KYC Verification and submit the required documents:
  • Business registration certificate
  • National ID or passport of the business owner
  • Bank account details for fiat settlement (LKR)
The admin team will review and approve your application. You will receive an email once your account is verified.
You cannot generate API keys or process payments until KYC verification is complete.
3

Get Your API Keys

Once verified, go to the Integrations page in the Merchant Portal:
https://olp-merchant.nipuntheekshana.com/integrations
Click Generate API Key to create a new key pair. You will receive:
CredentialDescription
API KeyPublic identifier sent in the X-API-Key header
API SecretUsed to compute HMAC-SHA256 signatures (never expose this client-side)
The API Secret is shown only once. Copy it immediately and store it in a secure location such as an environment variable or secrets manager.
4

Install the SDK

Install the Open Pay SDK for your language of choice.
npm install @openpay/sdk
Initialize the client with your credentials:
import { OpenPay } from "@openpay/sdk";

const client = new OpenPay({
  apiKey: process.env.OPENPAY_API_KEY!,
  apiSecret: process.env.OPENPAY_API_SECRET!,
  baseUrl: "https://olp-api.nipuntheekshana.com",
});
The SDK handles HMAC-SHA256 request signing automatically. You do not need to compute signatures manually.
5

Create a Checkout Session

A checkout session generates a hosted payment page where your customer can pay with crypto.
const session = await client.checkout.createSession({
  amount: 25.0,
  currency: "USD",
  description: "Premium Plan - Monthly",
  metadata: {
    orderId: "order_12345",
    customerId: "cust_67890",
  },
  successUrl: "https://yoursite.com/payment/success",
  cancelUrl: "https://yoursite.com/payment/cancel",
});

// Redirect the customer to the hosted checkout page
console.log(session.checkoutUrl);
// => https://olp-api.nipuntheekshana.com/checkout/cs_abc123...
The response includes:
FieldDescription
idUnique session identifier (e.g., cs_abc123)
checkoutUrlURL to redirect your customer to
paymentIdAssociated payment record ID
expiresAtSession expiry timestamp (default: 30 minutes)
statusSession status: pending, completed, expired
6

Handle the Webhook Callback

When a payment is confirmed on-chain, Open Pay sends a webhook to your configured endpoint. Webhooks are signed with ED25519 for authenticity.First, configure your webhook URL in the Merchant Portal under Integrations > Webhooks, or via the API:
await client.webhooks.configure({
  url: "https://yoursite.com/api/webhooks/openpay",
  events: ["payment.completed", "payment.failed"],
});
Then, set up a handler to verify and process incoming webhooks:
import { OpenPay } from "@openpay/sdk";
import express from "express";

const app = express();

app.post(
  "/api/webhooks/openpay",
  express.raw({ type: "application/json" }),
  async (req, res) => {
    const signature = req.headers["x-webhook-signature"] as string;
    const timestamp = req.headers["x-webhook-timestamp"] as string;

    // Verify the ED25519 signature
    const isValid = await client.webhooks.verifySignature({
      payload: req.body,
      signature,
      timestamp,
    });

    if (!isValid) {
      return res.status(401).json({ error: "Invalid signature" });
    }

    const event = JSON.parse(req.body.toString());

    switch (event.type) {
      case "payment.completed":
        // Fulfill the order
        console.log("Payment completed:", event.data.paymentId);
        await fulfillOrder(event.data.metadata.orderId);
        break;

      case "payment.failed":
        // Handle failure
        console.log("Payment failed:", event.data.paymentId);
        break;
    }

    // Respond with 200 to acknowledge receipt
    res.status(200).json({ received: true });
  }
);

app.listen(3000);
Always return a 200 status within 10 seconds. If your endpoint fails or times out, Open Pay retries with exponential backoff (up to 5 attempts over 24 hours).

​
Next Steps

Authentication

Understand JWT, HMAC, and ED25519 auth mechanisms in depth

Payment Flow

Full lifecycle of a payment from creation to settlement

Webhooks Guide

Advanced webhook configuration, retry policies, and event types

API Reference

Explore all 80+ API endpoints with examples