LogoLogo
  • Home Page
  • Documentation
    • API Overview
    • Partner API Authentication
    • Onboarding
    • Partner Webhooks
    • Status Codes for Financial Operations
    • Prices
  • WEBSOCKETS
    • Websocket Prices
      • Prices
      • Schemas
  • API REFERENCE
    • Authorization
      • Schemas
    • User Management
      • Users
      • Schemas
    • Customers
      • General
      • Legal Entities
      • Natural Persons
      • Customer Labels
      • Search Nace Sectors
      • Onboarding Wizard
      • Schemas
    • Documents
      • Documents
      • Schemas
    • Onboardings
      • Onboarding
      • Offboarding
      • Schemas
    • Products
      • General
      • Schemas
    • Asset Management
      • Trading
        • Assets
        • Schemas
      • Digital assets
        • Create Order
        • General
        • Assets
        • Schemas
      • Strategy
        • Schemas
    • Transaction History
      • Schemas
    • Transfers
      • General
      • Create Incoming Test Transfer
      • Schemas
    • Partner Documents
      • Schemas
    • Webhooks
      • Schemas
  • PARTNER APIS
    • Partner Webhooks
      • Schemas
Powered by GitBook
On this page
  1. API REFERENCE

Products

Last updated 6 days ago

Get Product Definitions

get

Get product definitions that are already or could be potentially available for partner

Authorizations
Responses
200
OK
application/json
get
GET /products HTTP/1.1
Host: tvda-api.platform-test.tradevest.ai
Accept: */*
200

OK

{
  "data": [
    {
      "name": "text",
      "productType": "CASH",
      "productCode": "CURRENCY_WALLET",
      "description": "text",
      "isActive": true
    }
  ]
}

Get Customer Product

get

Get Customer Product

Authorizations
Path parameters
customerProductIdstring · uuidRequired

the ID of the product instance for the given customer

Responses
200
OK
application/json
400
Bad Request
application/json
404
Not Found
application/json
get
GET /products/{customerProductId} HTTP/1.1
Host: tvda-api.platform-test.tradevest.ai
Accept: */*
{
  "customerProductId": "123e4567-e89b-12d3-a456-426614174000",
  "productCode": "CURRENCY_WALLET",
  "productType": "CASH",
  "currency": "EUR",
  "accountData": {
    "iban": "text",
    "bic": "text",
    "availableBalance": 1,
    "withdrawableBalance": 1,
    "modifiedOn": "2025-05-23T01:07:18.397Z"
  },
  "cryptoAssets": [
    {
      "cryptoSymbol": "text",
      "quantity": 1,
      "availableQuantity": 1,
      "modifiedOn": "2025-05-23T01:07:18.397Z"
    }
  ],
  "traditionalAssets": [
    {
      "isin": "text",
      "quantity": 1,
      "availableQuantity": 1,
      "modifiedOn": "2025-05-23T01:07:18.397Z"
    }
  ],
  "status": "RECEIVED",
  "proxyIds": [
    "123e4567-e89b-12d3-a456-426614174000"
  ],
  "createdOn": "2025-05-23T01:07:18.397Z",
  "modifiedOn": "2025-05-23T01:07:18.397Z"
}

Get Product Fee Configurations

get

Get fee configurations for products. If productCode is not provided, returns fees for all products.

Authorizations
Query parameters
productCodestring · enumOptional

Product code

Possible values:
Responses
200
OK
application/json
400
Bad Request
application/json
get
GET /products/fees HTTP/1.1
Host: tvda-api.platform-test.tradevest.ai
Accept: */*
[
  {
    "partnerFeeId": "123e4567-e89b-12d3-a456-426614174000",
    "productCode": "CURRENCY_WALLET",
    "partnerFeeCategory": "ACCOUNT",
    "partnerFeeStatus": "ACTIVE",
    "partnerFeeCurrency": "EUR",
    "partnerFeeType": "FIXED",
    "partnerFeeTrigger": "EVENT_BASED",
    "partnerFeeFrequency": "MONTHLY",
    "partnerFeeCollection": "MONTHLY",
    "partnerId": "123e4567-e89b-12d3-a456-426614174000",
    "partnerFeeTriggerEvent": "IDENTIFICATION",
    "partnerFixedFeeAmount": 1,
    "partnerFeeRatio": 1,
    "partnerMinFeeAmount": 1,
    "partnerMaxFeeAmount": 1,
    "validFrom": "2025-05-23",
    "validUntil": "2025-05-23",
    "createdOn": "2025-05-23T01:07:18.397Z",
    "modifiedOn": "2025-05-23T01:07:18.397Z"
  }
]
  • GETGet Customer Products
  • POSTCreate Customer Product
  • GETGet Product Definitions
  • GETGet Customer Product
  • PATCHUpdate customer product
  • GETGet Product Fee Configurations

Get Customer Products

get

Get Customer Products

Authorizations
Path parameters
customerIdstring · uuidRequired

Customer ID

Query parameters
productTypestring · enumOptional

Product type

Possible values:
productCodestring · enumOptional

Product code

Possible values:
statusstring · enumOptional

The status of the account

Possible values:
ibanstringOptional

The IBAN of a cash account

Responses
200
OK
application/json
400
Bad Request
application/json
get
GET /customers/{customerId}/products HTTP/1.1
Host: tvda-api.platform-test.tradevest.ai
Accept: */*
[
  {
    "customerProductId": "123e4567-e89b-12d3-a456-426614174000",
    "productCode": "CURRENCY_WALLET",
    "productType": "CASH",
    "currency": "EUR",
    "accountData": {
      "iban": "text",
      "bic": "text",
      "availableBalance": 1,
      "withdrawableBalance": 1,
      "modifiedOn": "2025-05-23T01:07:18.397Z"
    },
    "cryptoAssets": [
      {
        "cryptoSymbol": "text",
        "quantity": 1,
        "availableQuantity": 1,
        "modifiedOn": "2025-05-23T01:07:18.397Z"
      }
    ],
    "traditionalAssets": [
      {
        "isin": "text",
        "quantity": 1,
        "availableQuantity": 1,
        "modifiedOn": "2025-05-23T01:07:18.397Z"
      }
    ],
    "status": "RECEIVED",
    "proxyIds": [
      "123e4567-e89b-12d3-a456-426614174000"
    ],
    "createdOn": "2025-05-23T01:07:18.397Z",
    "modifiedOn": "2025-05-23T01:07:18.397Z"
  }
]

Create Customer Product

post

Create Customer Product

Authorizations
Path parameters
customerIdstring · uuidRequired

customer ID the partner is creating a product for

Header parameters
Requestor-IDstring · uuidRequired

Unique requestor identification in UUID format

Body
productCodestring · enumRequired

Product code

Possible values:
Responses
200
OK
application/json
400
Bad Request
application/json
post
POST /customers/{customerId}/products HTTP/1.1
Host: tvda-api.platform-test.tradevest.ai
Requestor-ID: 123e4567-e89b-12d3-a456-426614174000
Content-Type: application/json
Accept: */*
Content-Length: 33

{
  "productCode": "CURRENCY_WALLET"
}
{
  "customerProductId": "123e4567-e89b-12d3-a456-426614174000"
}

Update customer product

patch

Update customer product. It is used to close the customer product.

Authorizations
Path parameters
customerProductIdstring · uuidRequired

the ID of the product instance for the given customer

Header parameters
Requestor-IDstring · uuidRequired

Unique requestor identification in UUID format

Body
statusstring · enumRequiredPossible values:
Responses
200
OK
400
Bad Request
application/json
404
Not Found
application/json
patch
PATCH /products/{customerProductId} HTTP/1.1
Host: tvda-api.platform-test.tradevest.ai
Requestor-ID: 123e4567-e89b-12d3-a456-426614174000
Content-Type: application/json
Accept: */*
Content-Length: 19

{
  "status": "CLOSED"
}

No content