curl "https://www.gomry.com/api/v1/checkout_sessions/acp_sess_AbCdEfGhIjKlMnOpQrSt" \
-H "X-API-KEY: your_api_key" \
-H "API-Version: 2025-09-12"
const res = await fetch(
`https://www.gomry.com/api/v1/checkout_sessions/${sessionId}`,
{
headers: {
"X-API-KEY": process.env.GOMRY_API_KEY,
"API-Version": "2025-09-12",
},
}
);
const session = await res.json();
{
"id": "acp_sess_AbCdEfGhIjKlMnOpQrSt",
"buyer": { "name": "Ada Lovelace", "email": "ada@example.com" },
"payment_provider": { "provider": "stripe", "supported_payment_methods": ["card"] },
"status": "completed",
"currency": "usd",
"line_items": [
{
"id": "li_1",
"item": { "id": "TktAbCdEfGhIjKlMnOpQ", "quantity": 2 },
"base_amount": 15800,
"discount": 0,
"subtotal": 15800,
"tax": 0,
"total": 16790
}
],
"fulfillment_address": null,
"fulfillment_option_id": "digital",
"fulfillment_options": [
{
"type": "digital",
"id": "digital",
"title": "Digital ticket",
"subtitle": "Delivered by email",
"subtotal": 0,
"tax": 0,
"total": 0
}
],
"totals": [
{ "type": "items_base_amount", "display_text": "Tickets", "amount": 15800 },
{ "type": "fee", "display_text": "Service fee", "amount": 990 },
{ "type": "total", "display_text": "Total", "amount": 16790 }
],
"messages": [],
"links": [{ "type": "terms_of_use", "url": "https://www.gomry.com/terms" }],
"order": {
"id": "ord_AbCdEfGhIjKlMnOpQrSt",
"checkout_session_id": "acp_sess_AbCdEfGhIjKlMnOpQrSt",
"permalink_url": "https://www.gomry.com/ticket/AbCdEfGhIjKlMnOpQrSt?pk=pay_XyZ123"
}
}
Checkout Sessions
Get Checkout Session
Retrieve the current state of a checkout session
GET
/
checkout_sessions
/
{checkout_session_id}
curl "https://www.gomry.com/api/v1/checkout_sessions/acp_sess_AbCdEfGhIjKlMnOpQrSt" \
-H "X-API-KEY: your_api_key" \
-H "API-Version: 2025-09-12"
const res = await fetch(
`https://www.gomry.com/api/v1/checkout_sessions/${sessionId}`,
{
headers: {
"X-API-KEY": process.env.GOMRY_API_KEY,
"API-Version": "2025-09-12",
},
}
);
const session = await res.json();
{
"id": "acp_sess_AbCdEfGhIjKlMnOpQrSt",
"buyer": { "name": "Ada Lovelace", "email": "ada@example.com" },
"payment_provider": { "provider": "stripe", "supported_payment_methods": ["card"] },
"status": "completed",
"currency": "usd",
"line_items": [
{
"id": "li_1",
"item": { "id": "TktAbCdEfGhIjKlMnOpQ", "quantity": 2 },
"base_amount": 15800,
"discount": 0,
"subtotal": 15800,
"tax": 0,
"total": 16790
}
],
"fulfillment_address": null,
"fulfillment_option_id": "digital",
"fulfillment_options": [
{
"type": "digital",
"id": "digital",
"title": "Digital ticket",
"subtitle": "Delivered by email",
"subtotal": 0,
"tax": 0,
"total": 0
}
],
"totals": [
{ "type": "items_base_amount", "display_text": "Tickets", "amount": 15800 },
{ "type": "fee", "display_text": "Service fee", "amount": 990 },
{ "type": "total", "display_text": "Total", "amount": 16790 }
],
"messages": [],
"links": [{ "type": "terms_of_use", "url": "https://www.gomry.com/terms" }],
"order": {
"id": "ord_AbCdEfGhIjKlMnOpQrSt",
"checkout_session_id": "acp_sess_AbCdEfGhIjKlMnOpQrSt",
"permalink_url": "https://www.gomry.com/ticket/AbCdEfGhIjKlMnOpQrSt?pk=pay_XyZ123"
}
}
Get Checkout Session
Returns a session as currently stored.Requires
checkout: write and an allowlisted partner key. No signature is needed: a GET has no body to sign. Send API-Version as on every other checkout call. Or send no credential at all: a session created without one is reached by its id alone, with no credential, so keep the id between you and your buyer.404 session_not_found.
Path Parameters
string
required
The session id returned at creation.
Response
string
Session identifier.
string
not_ready_for_payment, ready_for_payment, completed, or canceled.completed means tickets exist. A succeeded payment with no issued tickets is never reported as completed — that would be money taken without a product.string
ISO 4217, lowercase.
array
array
Ordered rows for display.
type is one of items_base_amount, items_discount, subtotal, discount, fulfillment, tax, fee, total; display_text is what to show a buyer; amount is in minor units.array
Always exactly one option — the buyer is not choosing a delivery speed, they are being told how the ticket they already chose will arrive.
Show Option
Show Option
string
digital or shipping. Most tickets are digital, but some externally supplied inventory is a paper ticket sent by post — for those, type is shipping and a fulfillment_address is required.string
digital or shipping.string
Display title.
string
Display subtitle.
integer
Fulfillment cost in minor units.
string | null
The selected option.
object | null
Stored address, when one was supplied.
array
Why the session is not payable, or what to tell the buyer.
type: "error" blocks payment; type: "info" is advisory. See Checkout Errors.array
Seller policy documents.
type is terms_of_use, privacy_policy, or seller_shop_policies.The event page URL is not here — that field is for policies, not merchandising. Get the event URL from the catalog.string
Present while the session is
ready_for_payment with a total above zero. The standard handoff for an agent that cannot pay itself: send it to the buyer, who opens it with no credential and pays by card, Apple Pay or Google Pay. It opens their tickets if the session is already paid, and the event page if the cart can no longer be sold. Valid for 24 hours.object
Present only after you created a payment link.
status is open, paid, refunded or expired; url is present only while it is open. Poll this while the buyer pays.object
Cache-Control: no-store. Sessions are per-buyer and must never be shared by a cache.
curl "https://www.gomry.com/api/v1/checkout_sessions/acp_sess_AbCdEfGhIjKlMnOpQrSt" \
-H "X-API-KEY: your_api_key" \
-H "API-Version: 2025-09-12"
const res = await fetch(
`https://www.gomry.com/api/v1/checkout_sessions/${sessionId}`,
{
headers: {
"X-API-KEY": process.env.GOMRY_API_KEY,
"API-Version": "2025-09-12",
},
}
);
const session = await res.json();
{
"id": "acp_sess_AbCdEfGhIjKlMnOpQrSt",
"buyer": { "name": "Ada Lovelace", "email": "ada@example.com" },
"payment_provider": { "provider": "stripe", "supported_payment_methods": ["card"] },
"status": "completed",
"currency": "usd",
"line_items": [
{
"id": "li_1",
"item": { "id": "TktAbCdEfGhIjKlMnOpQ", "quantity": 2 },
"base_amount": 15800,
"discount": 0,
"subtotal": 15800,
"tax": 0,
"total": 16790
}
],
"fulfillment_address": null,
"fulfillment_option_id": "digital",
"fulfillment_options": [
{
"type": "digital",
"id": "digital",
"title": "Digital ticket",
"subtitle": "Delivered by email",
"subtotal": 0,
"tax": 0,
"total": 0
}
],
"totals": [
{ "type": "items_base_amount", "display_text": "Tickets", "amount": 15800 },
{ "type": "fee", "display_text": "Service fee", "amount": 990 },
{ "type": "total", "display_text": "Total", "amount": 16790 }
],
"messages": [],
"links": [{ "type": "terms_of_use", "url": "https://www.gomry.com/terms" }],
"order": {
"id": "ord_AbCdEfGhIjKlMnOpQrSt",
"checkout_session_id": "acp_sess_AbCdEfGhIjKlMnOpQrSt",
"permalink_url": "https://www.gomry.com/ticket/AbCdEfGhIjKlMnOpQrSt?pk=pay_XyZ123"
}
}