Vault types

Vault types define internal classifications for vault contracts, distinguishing between different logic structures, yield mechanisms, or operational modes. These types are useful for rendering vault metadata, sorting/filtering in UI, or determining strategy compatibility.

Structure

Each vault type object includes:

  • _id (string) — Unique identifier

  • code (string) — Internal reference code for the vault type

  • name (object) — Multilingual object (e.g., { en: "Fixed Rate" })

  • description (object) — Multilingual description object

  • createdAt, updatedAt (string) — ISO UTC timestamps

  • createdBy, updatedBy (string) — Actor IDs

Endpoints

List all vault types

get
Responses
200
A list of vault types
application/json
get
GET /v1/vault-types HTTP/1.1
Host: api.pareto.credit
Accept: */*
200

A list of vault types

{
  "data": [
    {
      "_id": "text",
      "code": "text",
      "name": {
        "en": "text"
      },
      "description": {
        "en": "text"
      },
      "createdAt": "2025-07-08T21:22:59.338Z",
      "createdBy": "text",
      "updatedAt": "2025-07-08T21:22:59.338Z",
      "updatedBy": "text"
    }
  ],
  "totalCount": 1
}

Get vault type by ID

get
Path parameters
typeIdstringRequired
Responses
200
A single vault type
application/json
get
GET /v1/vault-types/{typeId} HTTP/1.1
Host: api.pareto.credit
Accept: */*
200

A single vault type

{
  "_id": "text",
  "code": "text",
  "name": {
    "en": "text"
  },
  "description": {
    "en": "text"
  },
  "createdAt": "2025-07-08T21:22:59.338Z",
  "createdBy": "text",
  "updatedAt": "2025-07-08T21:22:59.338Z",
  "updatedBy": "text"
}

Last updated