Skip to main content
POST

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}$

Body

application/json
​
category
enum<string>
required

Recurring investments into the user's investment portfolio.

Available options:
TopUpAutomation
​
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.

Pattern: ^[a-f0-9]{24}$
​
orderAmount
number<double>
required

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

Required range: x >= 10
​
dayOfMonth
integer

Optional and ignored for TopUpAutomation. The server always uses day 1.

Required range: -1 <= x <= 28

Response

Automation created successfully

​
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 for recurring investment scheduling.

​
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.

​
consideration
object

Automation consideration with currency and amount