API Reference

# Your test key starts with sk_test_
# Your live key starts with sk_live_
export CALMONY_API_KEY=sk_test_your_key_here

curl https://api.calmonypay.com/v1/customers \
  -H "Authorization: Bearer sk_test_..." \
  -H "Content-Type: application/json" \
  -d '{"email":"user@example.com","name":"Alice Smith"}'

curl https://api.calmonypay.com/v1/payment_intents \
  -H "Authorization: Bearer sk_test_..." \
  -H "Content-Type: application/json" \
  -d '{
    "amount": 2500,
    "currency": "gbp",
    "customerId": "cus_01HXYZ",
    "paymentMethodId": "pm_01HXYZ",
    "confirm": true
  }'

curl https://api.calmonypay.com/v1/customers \
  -H "Authorization: Bearer sk_live_your_key_here"

curl https://api.calmonypay.com/v1/payment_intents \
  -H "Authorization: Bearer sk_live_..." \
  -H "Idempotency-Key: a4e2c8f0-1234-5678-abcd-ef0123456789" \
  -H "Content-Type: application/json" \
  -d '{"amount":2500,"currency":"gbp"}'

npm install calmony-pay

import { CalmonyPay } from "calmony-pay";

const client = new CalmonyPay({
  apiKey: process.env.CALMONY_API_KEY!, // sk_live_... or sk_test_...
});

import { CalmonyPay } from "calmony-pay";

const pay = new CalmonyPay({ apiKey: process.env.CALMONY_API_KEY! });

// Create a customer
const customer = await pay.customers.create({
  email: "user@example.com",
  name: "Alice Smith",
});

// Tokenise a payment method
const paymentMethod = await pay.paymentMethods.create({
  customerId: customer.id,
  card: { number: "4111111111111111", expMonth: 12, expYear: 2026, cvc: "123" },
});

// Attach it to the customer
await pay.paymentMethods.attach(paymentMethod.id, { customerId: customer.id });

// Create and confirm a payment intent
const intent = await pay.paymentIntents.create({
  amount: 2500,        // in pence
  currency: "gbp",
  customerId: customer.id,
  paymentMethodId: paymentMethod.id,
  confirm: true,
});

console.log(intent.status); // "succeeded"

// Verify a webhook signature
const event = CalmonyPay.webhooks.verifySignature(
  rawBody,
  request.headers.get("Calmony-Signature")!,
  process.env.WEBHOOK_SECRET!
);

curl https://api.calmonypay.com/v1/webhook_endpoints \
  -X POST \
  -H "Authorization: Bearer sk_live_..." \
  -H "Content-Type: application/json" \
  -d '{
    "url": "https://yourapp.com/webhooks/calmony",
    "enabledEvents": [
      "payment_intent.succeeded",
      "payment_intent.failed",
      "subscription.created",
      "invoice.paid"
    ]
  }'

// app/api/webhooks/route.ts
import { NextRequest, NextResponse } from "next/server";
import { CalmonyPay } from "calmony-pay";

export async function POST(req: NextRequest) {
  const rawBody = await req.text();
  const signature = req.headers.get("Calmony-Signature") ?? "";
  const secret = process.env.CALMONY_WEBHOOK_SECRET!;

  let event;
  try {
    event = CalmonyPay.webhooks.verifySignature(rawBody, signature, secret);
  } catch (err) {
    return NextResponse.json({ error: "Invalid signature" }, { status: 400 });
  }

  switch (event.type) {
    case "payment_intent.succeeded":
      console.log("Payment succeeded:", event.data.object.id);
      break;
    case "payment_intent.failed":
      console.log("Payment failed:", event.data.object.id);
      break;
    case "subscription.created":
      console.log("Subscription created:", event.data.object.id);
      break;
    case "invoice.paid":
      console.log("Invoice paid:", event.data.object.id);
      break;
  }

  return NextResponse.json({ received: true });
}

{
  "id": "evt_01HXYZABCDEF",
  "type": "payment_intent.succeeded",
  "created": 1705312200,
  "data": {
    "object": {
      "id": "pi_01HXYZABCDEF",
      "amount": 2500,
      "currency": "gbp",
      "status": "succeeded"
    }
  }
}

{
  "error": {
    "type": "invalid_request_error",
    "message": "No such customer: cus_01HXYZ",
    "param": "customerId"
  }
}