/v1/checkout
Create a hosted, branded checkout in one call. Returns a pay URL you can redirect to or embed.
Developers An API that stays out of your way
A payments API you can read in one sitting.
Clean, predictable and friendly. Plugins for the platforms you already build on, SDKs in seven languages, payment links that need no code at all, and webhooks that actually arrive. No 200-page integration guide required.
01 Quickstart
Take a payment in a few lines.
Our SDKs ship with test keys baked in, so your first payment happens during install — not your second sprint. Flip to live mode with a single environment variable, and you're taking real money.
- SDKs — Node, Python, PHP, Ruby, Go, Java and a typed CLI.
- Plugins — one-click for Shopify, WooCommerce, Wix, Squarespace and more.
- Payment links — create a hosted checkout with one API call, or zero code.
- Idempotent — every request is replay-safe, so a flaky network never double-charges.
node.js// install · npm i @korumiapay/node import Korumiapay from "@korumiapay/node"; const korumia = new Korumiapay(process.env.KORUMIA_KEY); const sale = await korumia.checkout.create({ amount: 7490, currency: "eur", brand: "maison-lila", success_url: "https://shop/thanks", }); console.log(sale.url); // → pay.korumiapay.com/c/lx_92
02 API reference
The endpoints, by what you're doing.
/v1/payments
Authorise, capture, look up and list payments. Each one carries a clean status you can trust.
/v1/refunds
Refund in full or part with one call. The customer is notified and your dashboard updates instantly.
/v1/payouts
Trigger an instant payout or read your payout schedule. See exactly what's settling and when.
/v1/subscriptions
Create plans, start subscriptions and manage trials. Smart retries recover failed cards for you.
/v1/invoices
Raise a branded invoice with a pay button, send it, and track who has paid — all by API.
/v1/customers
Store customers, saved cards and addresses so regulars check out in a single tap.
/v1/webhooks
Configure delivery, see per-event success rates and replay any failed delivery from the last 14 days.
/v1/reports
Pull tidy CSV and JSON exports for any period, ready for your accountant or your own tools.
03 Webhooks & events
Events that actually turn up.
Every webhook is signed, retried on a sensible backoff for 72 hours, and replayable from the dashboard with one click. Across our shops last quarter, deliverability was 99.99% — so your order fulfilment never waits on a payment event that vanished.
- payment.succeeded, payment.failed, payment.refunded
- checkout.completed, checkout.expired
- payout.paid, payout.instant.sent
- subscription.renewed, invoice.paid, dispute.opened
webhook · payment.succeeded{ "id": "evt_71c4a0", "created": 1779410041, "type": "payment.succeeded", "data": { "payment": "pay_8x21", "amount": 7490, "currency": "eur", "method": "apple_pay", "brand": "maison-lila" } }
Median API response0P50 across payment endpoints, 30-day rolling.
SDK languages0Node, Python, PHP, Ruby, Go, Java and a CLI.
Webhook deliverability0Delivered within 72h or surfaced for one-click replay.
One-click plugins0For the platforms shops already build their stores on.
Test keys in under five minutes.
Grab a test key, make your first payment, and ship when you're ready. If you get stuck, a real engineer answers — we don't hide behind a ticket queue.