Create a quote

post

https://myapi.xegora.com/api/v1/quotes

Prices one purchase and locks the total for a few minutes. Every order is priced by a quote: one created here, or one POST /api/v1/orders makes itself from an item that takes exactly this request's members. Requires the quotes.create scope. Send the selected product's sellCurrency as currency; product/variant denomination currency and faceValue are not the wallet price. A new quote's status is active; read it back with GET /api/v1/quotes/{quoteId}. Refused while the workspace's API access is inactive (403 api_access_inactive).

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

What to buy. A body member not listed here is refused (400 invalid_request).

productId

uuid

required

variantId

uuid | null

An available variant id for a variant purchase. Do not also supply value.

value

number | null

Positive denomination in product currency for a purchase without variantId. Must satisfy the current range, increment, and currency precision. If omitted, the product's default faceValue is used when available.

quantity

integer

required

1 to 20

currency

string

required

Must equal the selected product's sellCurrency (settlement currency), which can differ from its denomination currency.

Headers

X-Correlation-Id

string

length ≤ 128

^[A-Za-z0-9._:-]{1,128}$

Your own correlation id, carried through Xegora's logs and audit records and returned in correlationId. Kept when it is 1–128 characters of ASCII letters, digits, ., _, : and -; anything else is replaced by an id of Xegora's.

X-Language

string

enum

The language an error's message, title and detail are written in; without it, Accept-Language decides, then English. Successful responses are not translated.

string

enum

Defaults to application/json

Generated from available response content types

Allowed:

Responses

200The binding quote.

400The request is malformed (code = invalid_request): a bad parameter or header, a missing or malformed Idempotency-Key, or a body member the contract does not have — named, by its path in the body, in errors. Do not retry unchanged.

401No valid API key (code = unauthorized): missing, malformed, unknown, revoked or expired, or a wrong secret. The message is worded for an API key — this surface has no session to sign in to.

403As Forbidden, and also entitlement_required — API purchasing is not enabled for the workspace (normally answered earlier as api_access_inactive).

404No such resource in this workspace, or no such route (code = not_found).

413The request body is over 256 KiB (code = payload_too_large).

415The request body is not application/json (code = unsupported_media_type).

422Quote cannot be created under the current conditions. Codes: currency_not_supported (use the product's sellCurrency), product_unavailable, and pricing_unavailable. Refresh the product and handle the rejection before attempting checkout.