Skip to main content
POST
Place an order

Authorizations

x-api-key
string
header
default:kal_live_xxxxxxxxxxxxxxxxxxxxxxxx
required

Your Kalixo API key. Send it in the x-api-key header on every request.

Body

application/json
externalOrderCode
string
required

Your unique reference for this order. Acts as the idempotency key.

Example:

"O-12345"

currency
string
required
Example:

"GBP"

orderProducts
object[]
required
Minimum array length: 1
price
integer

Optional expected order total in minor units. If sent, must equal the sum of (line unit price × quantity).

Example:

10000

Response

Order accepted and now processing.

orderId
string<uuid>
Example:

"b9f6f9a2-4d0a-4f5c-9a1e-7c2d8f3b6e10"

externalOrderCode
string
Example:

"O-12345"

status
enum<string>
Available options:
processing
Example:

"processing"

estimatedReadyAt
string<date-time>

Approximate time the codes should be ready. Poll the order after this time.

Example:

"2026-06-02T11:05:00Z"

wallet
object