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

202

Accepted

application/json

400

Bad Request

application/json

post

/savings-plans

POST /savings-plans HTTP/1.1
Host: tvda-api.platform-test.tradevest.ai
Authorization: Bearer YOUR_OAUTH2_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 279

{
  "instrumentType": "DIGITAL_ASSET",
  "instrumentIdentifier": "BTC",
  "savingsAmount": "50.00",
  "currency": "EUR",
  "intervalPeriod": "MONTH",
  "intervalDay": 1,
  "liquidityCustomerProductId": "3d07c219-0a88-45be-9cfc-91e9d095a1e9",
  "savingsCustomerProductId": "d6e71eff-fbf0-456c-8d31-392631a6b046"
}

{
  "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
}

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

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.

404

Not Found

application/json

get

/savings-plans/{savingPlanId}

GET /savings-plans/{savingPlanId} HTTP/1.1
Host: tvda-api.platform-test.tradevest.ai
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*

{
  "savingPlanId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
  "customerId": "87d8e330-2878-4742-a86f-dbbb3bf522ac",
  "instrumentType": "DIGITAL_ASSET",
  "instrumentIdentifier": "BTC",
  "savingsAmount": "50.00",
  "currency": "EUR",
  "intervalPeriod": "MONTH",
  "intervalDay": 1,
  "liquidityCustomerProductId": "3d07c219-0a88-45be-9cfc-91e9d095a1e9",
  "savingsCustomerProductId": "d6e71eff-fbf0-456c-8d31-392631a6b046",
  "status": "ACTIVE",
  "createdOn": "2024-01-15T10:30:00Z",
  "modifiedOn": "2024-01-15T10:30:00Z"
}

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

No content

400

Bad Request

application/json

404

Not Found

application/json

delete

/savings-plans/{savingPlanId}

DELETE /savings-plans/{savingPlanId} HTTP/1.1
Host: tvda-api.platform-test.tradevest.ai
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*

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

No content

400

Bad Request

application/json

404

Not Found

application/json

patch

/savings-plans/{savingPlanId}

PATCH /savings-plans/{savingPlanId} HTTP/1.1
Host: tvda-api.platform-test.tradevest.ai
Authorization: Bearer YOUR_OAUTH2_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 21

{
  "status": "INACTIVE"
}

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

application/json

List of savings plans returned.

404

Not Found

application/json

get

/customers/{customerId}/savings-plans

GET /customers/{customerId}/savings-plans HTTP/1.1
Host: tvda-api.platform-test.tradevest.ai
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*

{
  "data": [
    {
      "savingPlanId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
      "customerId": "87d8e330-2878-4742-a86f-dbbb3bf522ac",
      "instrumentType": "DIGITAL_ASSET",
      "instrumentIdentifier": "BTC",
      "savingsAmount": "50.00",
      "currency": "EUR",
      "intervalPeriod": "MONTH",
      "intervalDay": 1,
      "liquidityCustomerProductId": "3d07c219-0a88-45be-9cfc-91e9d095a1e9",
      "savingsCustomerProductId": "d6e71eff-fbf0-456c-8d31-392631a6b046",
      "status": "ACTIVE",
      "createdOn": "2024-01-15T10:30:00Z",
      "modifiedOn": "2024-01-15T10:30:00Z"
    }
  ],
  "pagination": {
    "cursor": "string",
    "limit": 20
  }
}

Last updated 21 days ago