lollipayDocs
Checkouts

Retrieve checkout session

GET
/v1/stores/{storeId}/checkouts/{checkoutId}

Returns a checkout session created with a key of the same mode. Use it on your return_url page to confirm status is complete before fulfilling the order.

Requires the checkouts:read permission (checkouts:write includes it).

Authorization

headerAuthorizationBearer <lp_test_sk_… / lp_live_sk_…>

A bearer key's secret in the Authorization header. Keep it on your server.

Path Parameters

storeId*string

Your store ID, shown in Dashboard → Developers → API keys.

Formatuuid
checkoutId*string

Checkout session ID, cs_ and 64 hex characters (the earliest sessions have 32).

Match^cs_[0-9a-f]{32}([0-9a-f]{32})?$

Response Body

The checkout session.

application/json
  1. response
ok*boolean
data*
Example Request
curl -X GET 'https://api.lollipay.cc/v1/stores/497f6eca-6276-4993-bfeb-53cbbbba6f08/checkouts/string'
Example Response
{  "ok": true,  "data": {    "id": "cs_55ca30f7581d9a76ac7188349f33b4811c4b43f28935ed507586d3bd92fa4982",    "object": "checkout_session",    "livemode": false,    "status": "complete",    "title": "Upgrade to Pro",    "description": null,    "checkout_url": "https://checkout.lollipay.cc/invoice/cs_55ca30f7581d9a76ac7188349f33b4811c4b43f28935ed507586d3bd92fa4982",    "merchant": {      "id": "4f9c2d1e-7b3a-4c58-9e21-6d0f8a3b5c47",      "name": "Example",      "statement_descriptor": "ALTURA",      "website": "https://example.com"    },    "currency": "USD",    "amount": 7900,    "discount_amount": 0,    "tax_amount": 0,    "total_amount": 7900,    "items": [      {        "name": "Pro plan (yearly)",        "amount": 4900,        "quantity": 1,        "image": null      },      {        "name": "Extra seat",        "amount": 1500,        "quantity": 2,        "image": null      }    ],    "customer": {      "email": "buyer@example.com",      "name": "Emma Wilson"    },    "metadata": {      "order_id": "A-1042"    },    "return_url": "https://example.com/thanks",    "cancel_url": "https://example.com/pricing",    "payment_id": "pay_8c41f2a9d0e34b7f9a6c3e1b5d2f7a40",    "created_at": 1792315200,    "expires_at": 1792336800,    "completed_at": 1792315468  }}

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.