Skip to main content
POST
/
automations
curl --request POST \
  --url https://{host}/automations \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'x-user-id: <x-user-id>' \
  --data '
{
  "category": "TopUpAutomation",
  "bankAccountId": "7501d8537fb3fc001234ijkl",
  "orderAmount": 100,
  "dayOfMonth": 15
}
'
{
  "id": "7501d8537fb3fc001234abcd",
  "category": "TopUpAutomation",
  "status": "Active",
  "frequency": "monthly",
  "dayOfMonth": 15,
  "currency": "EUR",
  "amount": 100,
  "allocationMethod": "holdings",
  "mandate": {
    "id": "7501d8537fb3fc001234efgh",
    "status": "Pending",
    "bankAccountId": "7501d8537fb3fc001234ijkl"
  }
}

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
​
category
enum<string>
required

Type of automation to create. Supports:

  • TopUpAutomation: Recurring investments into the user's investment portfolio
  • SavingsTopUpAutomation: Recurring top-ups into a savings product (money market fund)
Available options:
TopUpAutomation,
SavingsTopUpAutomation
​
bankAccountId
string
required

ID of the bank account to use for direct debit payments. A mandate will be created automatically if one doesn't exist.

​
orderAmount
number<double>
required

Amount to invest or save each month in the user's currency. Must be within the allowed minimum and maximum recurring investment limits.

Required range: x >= 10
​
dayOfMonth
integer
required

Day of the month when the recurring investment should be collected. Valid values are 1-28 or -1 (for last day of the month). Value 0 is not allowed.

Required range: -1 <= x <= 28

Response

Automation created successfully

  • Option 1
  • Option 2
​
id
string
required

Automation identifier.

​
category
enum<string>
required
Available options:
TopUpAutomation
​
status
enum<string>
required

Current status of the automation:

  • Active: Automation is active and will execute on schedule
  • Inactive: Automation has been cancelled
  • Pending: Automation is waiting to be activated
Available options:
Active,
Inactive,
Pending
​
frequency
enum<string>
required

How often the automation runs. Currently only monthly is supported.

Available options:
monthly
​
dayOfMonth
integer
required

Day of the month when the recurring investment is collected.

​
currency
string
required

ISO 4217 currency code for the recurring investment.

​
amount
number<double>
required

Amount invested each month.

​
allocationMethod
enum<string>
required

How funds are allocated. In B2B, this is always holdings (proportional to existing holdings).

Available options:
holdings
​
mandate
object
required

Direct debit mandate information linked to the automation.