Skip to main content
POST
/
savings
/
orders
curl --request POST \
  --url https://{host}/savings/orders \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'x-user-id: <x-user-id>' \
  --data '
{
  "side": "buy",
  "currency": "EUR",
  "amount": 250
}
'
{
  "id": "7501d8537fb3fc001234abcd",
  "side": "buy",
  "status": "Pending",
  "currency": "EUR",
  "amount": 250,
  "settledAt": "2024-07-12",
  "createdAt": "2024-07-11T10:00:00Z",
  "updatedAt": "2024-07-11T10:00:00Z"
}

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.

Body

application/json
​
side
enum<string>
required

Savings order direction.

Available options:
buy,
sell
​
currency
string
required

ISO 4217 currency that identifies the savings product.

​
amount
number<double>
required

Monetary amount to invest or withdraw.

Required range: x >= 0.01

Response

Savings order accepted for processing

​
id
string

Savings order identifier.

​
side
enum<string>

Direction of the savings order (buy for top up, sell for withdrawal).

Available options:
buy,
sell
​
status
enum<string>
Available options:
Pending,
Matched,
Rejected,
Settled,
Cancelled
​
currency
string

ISO 4217 currency code for the savings order.

​
amount
number<double>

Monetary amount requested for the savings order.

​
settledAt
string<date> | null

Date when the savings order is expected to settle.

​
createdAt
string<date-time>

Timestamp when the order was created.

​
updatedAt
string<date-time>

Timestamp when the order was last updated.