Objects definition

Todo :

• Explain in detail each element of each object

User

{
    "_id" : ObjectId,
    "customId" : String,
    "phone" : String,
    "email" : String,
    "firstName" : String,
    "lastName" : String,
    "createdAt" : Date,
    "updatedAt" : Date,
    "rib" : String,
    "sexe" : Gender,
    "birthday" : Date,
    "address" : {
        "route" : String,
        "postalCode": String,
        "locality" : String,
        "country" : String
    },
    "professionalSituation" : String,
    "professional" : String,
    "naf" : String,
    "revenue" : String,
    "patrimoine" : String,
    "kyc" : {
        "front" : String,
        "back" : String,
        "other" : [String]
    },
    "kycState" : KycState
}

Thematic

{
        "_id": String,
        "name": { 
            "fr" : String,
            "en" : String,
        },
        "description" : {
            "fr" : String,
            "en" : String,
        }
        "longDescription" : {
            "fr" : String,
            "en" : String
        },
        "nextRebalance": Date, //Next date of rebalancing
        "lastRebalance": Date,
        "riskLevel": 2,
        "tokens": [
             {
                 "token" :Token,
                 "percent" : Number //Target percent
             }, ...
         ],
        "tokensCurrent": [
            {
                "id": String,
                "name": String,
                "percent": Number, //Currrent percent 
            }, ...
        ],
        "createdAt": Date,
        "updatedAt": Date,
}

Token

{
                    "_id": String,
                    "name": String,
                    "longName": String,
                    "price": Number,
                    "picture": String,
                    "createdAt": Date,
                    "updatedAt": Date,
}

TokenHistory

{
    "date" : Date,
    "price" : Number
}

Transactions

{
    "_id" : String,
    "amount" : Number
    "user" : String
    "transactions" : [ 
        {
            "amount" : String
            "thematics" : String
        }, ...
    ],
    "state" : TransactionState,
    "type" : TransactionType,
    "reference" : String,
    "createdAt" : Date,
    "updatedAt" : Date
}

History

{
    "_id" : String,
    "user" : String,
    "thematic" : String | null, //If thematic is null, it's FIAT history
    "type" : UserHistoryType,
    "feeType" : null,
    "amount" : Number,
    "data" : {
        "transaction" : Transaction, //TransactionId
        "result" : [ 
            {
                "token" : Token,
                "amountToUser" : Number
            }, ...
        ]
    },
    "date" : Date,
}

Webhook

{
    "url" : String,
    "type" : WebhookType,
}

Enum

Gender

enum Gender {
  MALE = "H",
  FEMALE = "F"
}

HistoryType

enum HistoryType {
    DAY = "day",
    WEEK = "week",
    MONTH = "month",
    YEAR = "year",
    ALL = "all"
}

TransactionState

enum TransactionState {
    PENDING = "PENDING",
    COMPLETED = "COMPLETED",
    CANCELED = "CANCELED"
}

TransactionType

enum TransactionType {
    ONE_SHOT = "ONE_SHOT",
    MONTHLY = "MONTHLY",
    WITHDRAW = "WITHDRAW",
}

UserHistoryType

enum UserHistoryType {
    DEPOSIT = "DEPOSIT",
    WITHDRAWAL = "WITHDRAWAL",
    FEES = "FEES",
}

WebhookType

enum WebhookType {
    USER = "USER",
    TRANSACTION = "TRANSACTION"
}

KycState

enum KycState {
    WAITING = "WAITING",
    ACCEPTED = "ACCEPTED",
    DENIED = "DENIED",
    LEVEL_UP = "LEVEL_UP"
}