Overview
The Lollipay REST API. Try every endpoint from this site with your own test key.
The API lives at https://api.lollipay.cc/v1. It takes and returns JSON, uses standard HTTP statuses, and wraps every
response in { "ok": true, "data": … } or { "ok": false, "error": … }.
Authentication
Send a bearer key's secret as Authorization: Bearer lp_test_sk_…, or sign the request with an HMAC key. See
Authentication. Each endpoint below lists the permission it needs.
Endpoints
| Endpoint | Permission | |
|---|---|---|
POST /v1/stores/{storeId}/checkouts | checkouts:write | Create checkout session |
GET /v1/stores/{storeId}/checkouts/{checkoutId} | checkouts:read | Retrieve checkout session |
Trying requests
Each endpoint page has a playground. Paste a test key, fill in your store ID and choose Send: the request goes to the real API and you see the response. Never paste a live key into a browser.
The OpenAPI 3.1 spec is the source of these pages; Copy Markdown on any page gives you a plain-text version for your editor or AI assistant.
Errors and rate limits
Every failed request returns the same JSON shape with a stable code. Here's what each code means and what to do about it.
Create checkout session POST
Creates a checkout session that stays open for 1 hour and returns a `checkout_url` to redirect the buyer to. Line items are dynamic: send a `name` and an `amount` (in minor units, for example cents) for each one. When the buyer pays they're sent to `return_url` with `checkout_id` added to the query string. Requires the `checkouts:write` permission.