Skip to main content
GET
/
savings
/
orders
Get all savings orders
curl --request GET \
  --url https://{host}/savings/orders \
  --header 'Authorization: Bearer <token>' \
  --header 'x-user-id: <x-user-id>'
{
  "orders": [
    {
      "id": "7501d8537fb3fc001234abcd",
      "side": "buy",
      "status": "Settled",
      "currency": "EUR",
      "amount": 200,
      "settledAt": "2024-07-12",
      "createdAt": "2024-07-11T10:00:00Z",
      "updatedAt": "2024-07-11T12:15:00Z"
    },
    {
      "id": "7501d8537fb3fc001234abce",
      "side": "sell",
      "status": "Pending",
      "currency": "EUR",
      "amount": 150,
      "settledAt": "2024-07-15",
      "createdAt": "2024-07-13T09:30:00Z",
      "updatedAt": "2024-07-13T09:30:00Z"
    }
  ],
  "total": 2
}

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.

Query Parameters

​
status
enum<string>

Filter savings orders by status

Available options:
Pending,
Matched,
Rejected,
Settled,
Cancelled
​
side
enum<string>

Filter savings orders by side (top up or withdrawal)

Available options:
buy,
sell
​
currency
string

Filter savings orders by currency code

​
limit
integer
default:50

Maximum number of savings orders to return

Required range: x <= 100
​
offset
integer
default:0

Number of savings orders to skip for pagination

Response

List of savings orders retrieved successfully

​
orders
object[]
​
total
integer

Total number of savings orders matching the query