Skip to content
For LLMsView as Markdown·

Read a cashier payment for the player who opened it ​

http
GET https://api.onehazel.com/onehazel-api/embed/v1/{key}/payments/intents/{id}

Unauthenticated. key is the operator's public embed key (never the operator id) and the browser Origin must be on the operator's allowed websites list, else 403 unauthorized with details.code SURFACE_ORIGIN_NOT_ALLOWED; an unknown or rotated key, an operator id in place of the key, or an account that is not active all get this route's unknown answer (404 transaction_unknown). The player token travels as ?player_token=<jwt> (a simple request with no CORS preflight) or in an X-OH-Player header. Returns { intent_id, status, direction, currency, exponent, amount_minor, redirect_url, failure_reason? }, where status is created, authorised, settled, failed or cancelled. Reading asks the payment provider for the current status. An intent that belongs to another player answers 404 transaction_unknown, exactly like an unknown id. 401 unauthorized for a token problem; 404 unavailable while the cashier is not enabled.

Section: Surfaces
Operation id: getEmbedV1ByKeyPaymentsIntentsById

Authentication ​

No authentication.

Parameters ​

NameInRequiredDescription
keypathyes
idpathyes

Responses ​

200 { "success": true, "data": ... }

Errors return { "success": false, "error": { "code": "...", "message": "..." } } with a 4xx or 5xx status.

Example ​

bash
curl -X GET "https://api.onehazel.com/onehazel-api/embed/v1/{key}/payments/intents/{id}"

Machine-readable: openapi.yaml, openapi.json.