Savings Plans

Create Savings Plan

post
/savings-plans

Create a savings plan for a customer. The operation is asynchronous.

Authorizations
OAuth2clientCredentialsRequired
Body

Savings plan creation model.

instrumentTypeundefined · enumRequired

The type of instrument for the savings plan.

Possible values:
instrumentIdentifierstringRequired

Instrument identifier. For DIGITAL_ASSET this is the crypto symbol (e.g. BTC). For TRADITIONAL_ASSET this is the ISIN (e.g. US38259P5089).

savingsAmountstringRequired

The amount to invest on each savings plan execution. Uses decimal string to avoid floating point precision issues.

Example: 50.00
currencystringRequired

Currency code in ISO 4217 format.

Example: EUR
intervalPeriodundefined · enumRequired

The interval period for savings plan execution.

Possible values:
intervalDaystring · enumRequired

The day of the interval period on which the savings plan executes.

Possible values:
liquidityCustomerProductIdstring · uuidRequired

The customer product ID of the liquidity account (product_id = 8) used to fund the savings plan.

savingsCustomerProductIdstring · uuidRequired

The customer product ID of the savings account. Must be product_id = 2 for DIGITAL_ASSET or product_id = 15 for TRADITIONAL_ASSET.

Responses
post
/savings-plans

Get Savings Plan

get
/savings-plans/{savingPlanId}

Get a savings plan by its ID. Returns 404 if the plan has been deleted.

Authorizations
OAuth2clientCredentialsRequired
Path parameters
savingPlanIdstring · uuidRequired

Unique savings plan identification number in UUID format

Responses
200

OK

application/json

Single savings plan model.

savingPlanIdstring · uuidRequired

Unique identifier of the savings plan.

customerIdstring · uuidRequired

Unique identifier of the customer who owns this savings plan.

statusundefined · enumRequired

The current status of the savings plan.

Possible values:
createdOnstring · date-timeRequired

When this savings plan was created.

modifiedOnstring · date-timeRequired

When this savings plan was last updated.

instrumentTypeundefined · enumRequired

The type of instrument for the savings plan.

Possible values:
instrumentIdentifierstringRequired

Instrument identifier. For DIGITAL_ASSET this is the crypto symbol (e.g. BTC). For TRADITIONAL_ASSET this is the ISIN (e.g. US38259P5089).

savingsAmountstringRequired

The amount to invest on each savings plan execution. Uses decimal string to avoid floating point precision issues.

Example: 50.00
currencystringRequired

Currency code in ISO 4217 format.

Example: EUR
intervalPeriodundefined · enumRequired

The interval period for savings plan execution.

Possible values:
intervalDaystring · enumRequired

The day of the interval period on which the savings plan executes.

Possible values:
liquidityCustomerProductIdstring · uuidRequired

The customer product ID of the liquidity account (product_id = 8) used to fund the savings plan.

savingsCustomerProductIdstring · uuidRequired

The customer product ID of the savings account. Must be product_id = 2 for DIGITAL_ASSET or product_id = 15 for TRADITIONAL_ASSET.

get
/savings-plans/{savingPlanId}

Delete Savings Plan

delete
/savings-plans/{savingPlanId}

Soft delete a savings plan by its ID. Sets deletedAt timestamp. Deleted plans are excluded from GET responses.

Authorizations
OAuth2clientCredentialsRequired
Path parameters
savingPlanIdstring · uuidRequired

Unique savings plan identification number in UUID format

Responses
200

OK

No content

delete
/savings-plans/{savingPlanId}

No content

Update Savings Plan

patch
/savings-plans/{savingPlanId}

Update a savings plan by its ID. Cannot update a deleted savings plan.

Authorizations
OAuth2clientCredentialsRequired
Path parameters
savingPlanIdstring · uuidRequired

Unique savings plan identification number in UUID format

Body

Savings plan update model. Used to toggle between ACTIVE and INACTIVE status.

statusundefined · enumOptional

The target status when toggling a savings plan.

Possible values:
Responses
200

OK

No content

patch
/savings-plans/{savingPlanId}

No content

Get Customer Savings Plans

get
/customers/{customerId}/savings-plans

Get all savings plans for a customer. Deleted plans are excluded.

Authorizations
OAuth2clientCredentialsRequired
Path parameters
customerIdstring · uuidRequired

Unique customer identification number in UUID format

Query parameters
statusundefined · enumOptional

The current status of the savings plan.

Possible values:
instrumentTypeundefined · enumOptional

The type of instrument for the savings plan.

Possible values:
instrumentIdentifierstringOptional

Filter by instrument identifier (ISIN or crypto symbol)

liquidityCustomerProductIdstring · uuidOptional

Filter by liquidity customer product ID

savingsCustomerProductIdstring · uuidOptional

Filter by savings customer product ID

Responses
200

OK

application/json

List of savings plans returned.

get
/customers/{customerId}/savings-plans

Last updated