API documentation
Authentication
Universe Configuration
Users
Savings Vault
Wallets
Daily Summaries
Investment Products
Investment Orders
Learn
Get all automations
Retrieve all recurring investment and savings automations for a user.
curl --request GET \
--url https://{host}/automations \
--header 'Authorization: Bearer <token>' \
--header 'x-user-id: <x-user-id>'{
"data": [
{
"id": "7501d8537fb3fc001234abcd",
"category": "TopUpAutomation",
"status": "Active",
"frequency": "monthly",
"dayOfMonth": 15,
"currency": "EUR",
"amount": 100,
"allocationMethod": "holdings",
"mandate": {
"id": "7501d8537fb3fc001234efgh",
"status": "Active",
"bankAccountId": "7501d8537fb3fc001234ijkl"
}
},
{
"id": "7501d8537fb3fc001234mnop",
"category": "SavingsTopUpAutomation",
"status": "Active",
"frequency": "monthly",
"dayOfMonth": 1,
"currency": "EUR",
"amount": 50,
"savingsProduct": "mmf_dist_eur",
"mandate": {
"id": "7501d8537fb3fc001234qrst",
"status": "Active",
"bankAccountId": "7501d8537fb3fc001234ijkl"
}
}
]
}Authorizations
Auth0-issued access token that includes the scopes listed for the endpoint.
Headers
User identifier for the M2M client to specify which user's data to access.
Response
List of automations retrieved successfully
- Option 1
- Option 2
Show child attributes
Show child attributes
Automation identifier.
TopUpAutomation Current status of the automation:
Active: Automation is active and will execute on scheduleInactive: Automation has been cancelledPending: Automation is waiting to be activated
Active, Inactive, Pending How often the automation runs. Currently only monthly is supported.
monthly Day of the month when the recurring investment is collected.
ISO 4217 currency code for the recurring investment.
Amount invested each month.
How funds are allocated. In B2B, this is always holdings (proportional to
existing holdings).
holdings Direct debit mandate information linked to the automation.
Show child attributes
Show child attributes
Mandate identifier.
Current status of the mandate:
Pending: Mandate is being set up with the payment providerActive: Mandate is active and can be used for paymentsInactive: Mandate has been cancelled or failed
Pending, Active, Inactive ID of the bank account linked to this mandate.
curl --request GET \
--url https://{host}/automations \
--header 'Authorization: Bearer <token>' \
--header 'x-user-id: <x-user-id>'{
"data": [
{
"id": "7501d8537fb3fc001234abcd",
"category": "TopUpAutomation",
"status": "Active",
"frequency": "monthly",
"dayOfMonth": 15,
"currency": "EUR",
"amount": 100,
"allocationMethod": "holdings",
"mandate": {
"id": "7501d8537fb3fc001234efgh",
"status": "Active",
"bankAccountId": "7501d8537fb3fc001234ijkl"
}
},
{
"id": "7501d8537fb3fc001234mnop",
"category": "SavingsTopUpAutomation",
"status": "Active",
"frequency": "monthly",
"dayOfMonth": 1,
"currency": "EUR",
"amount": 50,
"savingsProduct": "mmf_dist_eur",
"mandate": {
"id": "7501d8537fb3fc001234qrst",
"status": "Active",
"bankAccountId": "7501d8537fb3fc001234ijkl"
}
}
]
}