GET
/hyax-api/v1/checkout-sessions/:idGet a checkout session
Poll for status. `status` is `OPEN`, `COMPLETED`, `EXPIRED` or `CANCELED`; once `COMPLETED`, `order` carries the order id, number, amount and the buyer's `peopleId`. Prefer the `order.created` webhook for fulfilment and use this to reconcile or to show a "payment received" state when the buyer returns.
Base URL: https://platform.hyax.com · Replace YOUR_API_KEY with your team API key.
Request
curl -X GET 'https://platform.hyax.com/hyax-api/v1/checkout-sessions/clx_example_id' \
-H 'Authorization: Bearer YOUR_API_KEY'Response
{
"success": true,
"data": {
"id": "cs_clx…",
"status": "COMPLETED",
"email": "[email protected]",
"externalUserId": "user_8f3a",
"completedAt": "2026-09-14T18:52:10.000Z",
"paymentPlatform": "USDC_BASE",
"order": {
"id": "ord_clx…",
"orderNumber": "ORD-7Hk2Qm9a",
"amount": 10,
"currency": "USD",
"peopleId": "ppl_clx…"
}
}
}