# Overview

The Lollipay REST API. Try every endpoint from this site with your own test key.

Source: https://docs.lollipay.cc/developers/api-reference

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 [#authentication]

Send a bearer key's secret as `Authorization: Bearer lp_test_sk_…`, or sign the request with an HMAC key. See
[Authentication](/developers/authentication). Each endpoint below lists the [permission](/developers/permissions) it needs.

## Endpoints [#endpoints]

| Endpoint | Permission | |
| --- | --- | --- |
| `POST /v1/stores/{storeId}/checkouts` | `checkouts:write` | [Create checkout session](/developers/api-reference/checkouts/createCheckoutSession) |
| `GET /v1/stores/{storeId}/checkouts/{checkoutId}` | `checkouts:read` | [Retrieve checkout session](/developers/api-reference/checkouts/retrieveCheckoutSession) |

## Trying requests [#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](/llms.mdx/developers/api-reference) on any page gives you a
plain-text version for your editor or AI assistant.