Skip to main content
GET
Get savings order by ID

Authorizations

Authorization
string
header
required

Auth0-issued access token that includes the scopes listed for the endpoint.

Headers

x-user-id
string
required

User identifier for the M2M client to specify which user's data to access.

Pattern: ^[a-f0-9]{24}$

Path Parameters

id
string
required

Savings order identifier (MongoDB ObjectId)

Pattern: ^[a-f0-9]{24}$

Response

Savings order retrieved successfully

id
string
required

Savings order identifier.

side
enum<string>
required

Direction of the savings order (Buy for top up, Sell for withdrawal).

Available options:
Buy,
Sell
status
enum<string>
required

Current order status.

Available options:
Pending,
Matched,
Rejected,
Settled,
Cancelled
isin
string
required

ISIN of the savings product.

consideration
object
required

Savings order consideration with currency and amount.

displayId
string

User-friendly display identifier for the order (e.g. ORD-ABC123).

quantity
number<double>

Order quantity (optional).

settledAt
string<date-time> | null

ISO datetime when the savings order is expected to settle.

fees
object | null

Fee breakdown for the savings order (optional).

createdAt
string<date-time>

Timestamp when the order was created (optional).

filledAt
string<date-time> | null

ISO datetime when order was matched

unitPrice
object

Price per unit in major units (e.g. 1.00 for €1.00).

fxRate
object | null

Exchange rate used for currency conversion (optional, present for foreign currency orders).

isCancellable
boolean

Whether the order can be cancelled by the user.