Skip to main content
GET
Get card order
The state of one card order. Poll it after checkout until the order reaches a terminal state.
The terminal states are order_broadcasted and order_cancelled.
An order opens at payment_pending and stays there until the first callback from the payment rail. An order never moves between the two terminal states.

Authorizations

x-calm-publishable-key
string
header
required

Publishable key identifying the calling app.

Path Parameters

id
string<uuid>
required
Pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$

Query Parameters

wallet
string
required
Pattern: ^0x[a-fA-F0-9]{40}$

Response

The card order.

created_at
string<date-time>
required
destination
object
required
id
string<uuid>
required
Pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
source
object
required
status
enum<string>
required

payment_pending until the first provider callback, then the status it carries. Poll until order_broadcasted or order_cancelled.

Available options:
payment_pending,
order_completed,
order_broadcasted,
order_cancelled