Skip to content
Permalink
main
Switch branches/tags

Name already in use

A tag already exists with the provided branch name. Many Git commands accept both tag and branch names, so creating this branch may cause unexpected behavior. Are you sure you want to create this branch?

coinvestment-be/USAGE.md

Go to file
 
 
Cannot retrieve contributors at this time
API usage ❗ Request failure Note Request failure response User registration, signing in and signing out [POST]/sign-up Request Response [POST]/sign-in Request Reponse [POST]/sign-out Customer profile [GET]/profile/customer-details Request Response [POST]/profile/change-password Request Response [POST]/profile/change-emailaddress Request Response Items available to purchase [GET]/list/all/cryptocurrencies Response [GET]list/all/bundles Response Bundles Customer account [GET]/account/wallets Request Response [GET]/account/bundles Request Response [POST]/account/wallets/wallet-address Request Response [POST]/account/bundles/bundle-address Request Response Purchasing and selling [POST]/account/purchase/wallet Request Response [POST]/account/sell/wallet Request Response [POST]/account/purchase/bundle Request Response [POST]/account/sell/bundle Request Response
570 lines (534 sloc) 14.7 KB
Raw Blame
Open in GitHub Desktop

API usage

❗ Request failure

Note

When a request has failed the response will be formatted as below, with the statusCode key value being FAILURE and the statusMessage key showing the reason for the failure. FAILURE does not mean the request was not received, but the request received could not be completed. These failure messages can be shown in the front-end or be interpreted by the developer as to how to handle the failure and an alternative user-friendly message can be displayed.

Examples of failure could be:

  • Incorrectly formatted request JSON
  • Unauthenticated credentials
  • Attempted access to unauthorized routes
  • Incorrectly formatted data (email address, password length, etc.)

Request failure response

{
    "status": {
        "statusCode": "FAILURE",
        "statusMessage" : The reason for the failure
    }
}

User registration, signing in and signing out

[POST] /sign-up

Request

{
    "emailAddress": email address,
    "password": plain text password,
    "name": name
}

Response

{
    "status": {
        "statusCode": "SUCCESS",
        "statusMessage": "Successfully registered"
    },
    "name": name,
    "emailAddress": email address
}

[POST] /sign-in

Request

{
    "emailddress": email address,
    "password": plain text password
}

Reponse

{
    "status": {
        "statusCode": "SUCCESS",
        "statusMessage": "Successfully signed in"
    },
    "name": customer name,
    "emailAddress": email address,
    "currentSignInDatetime": current sign in datetime,
    "previousSignInDatetime": last sign in datetime
}

[POST] /sign-out

The request uses the token present in the authorization header to end the session. No request JSON is required.

Customer profile

[GET] /profile/customer-details

Request

The token present in the authorization header is the method to confirm access to this route

Response

{
    "status": {
        "statusCode": "SUCCESS",
        "statusMessage": "The customers details"
    },
    "customerID": Customers ID,
    "registerDatetime": datetime of account creation,
    "emailAddress": email address,
    "previousSignInDatetime": last sign in datetime,
    "currentSignInDatetime": current sign in datetime,
    "name": name
}

[POST] /profile/change-password

Request

{
    "currentPassword": current password,
    "newPassword": new password
}

The token present in the authorization header is the method to confirm access to this route

Response

{
    "status": {
        "statusCode": "SUCCESS",
        "statusMessage": "Successfully changed password for customer. You will be signed out. Sign in with new password"
    },
    "customerID": customer ID
}

[POST] /profile/change-emailaddress

Request

{
    "currentPassword": current password,
    "newEmailAddress": new email address
}

The token present in the authorization header is the method to confirm access to this route

Response

{
    "status": {
        "statusCode": "SUCCESS",
        "statusMessage": "Successfully changed email address for customer"
    },
    "customerID": customer ID
}

Items available to purchase

[GET] /list/all/cryptocurrencies

Response

{
    "status": {
        "statusCode": "SUCCESS",
        "statusMessage": "List of all available cryptocurrencies"
    },
    "availableCryptocurrencies": [
        {
            "cryptocurrencyCode": code,
            "cryptocurrencyName": name
        }
    ]
}

Where

  • availableCryptocurrencies is a list of cryptocurrencies

[GET] list/all/bundles

Response

{
    "status": {
        "statusCode": "SUCCESS",
        "statusMessage": "List of all available bundles"
    },
    "availableBundles": [
        {
            "bundleName": name of the bundle,
            "riskLevel": low risk/medium risk/high risk,
            "term": short term/medium term/long term,
            "minimumHoldingPeriod": in months,
            "bundleID": bundle ID,
            "bundleCryptocurrencies": [
                {
                    "cryptocurrencyCode": code,
                    "cryptocurrencyName": name,
                    "percentage": % of the bundle
                }
            ]
        }
    ]
}

Where

  • availableBundles is a list of bundles
  • bundleCryptocurrencies is a list of the cryptocurrencies in that bundle

Bundles

ID code percent minimum holding
1 bitcoin 50 6
1 ethereum 50 6
2 bitcoin-cash 25 12
2 tether 15 12
2 ripple 15 12
2 litecoin 25 12
2 monero 20 12
3 dogecoin 20 12
3 shiba-inu 20 12
3 ethereum-classic 30 12
3 apecoin 30 12
4 chainlink 20 12
4 decentraland 20 12
4 quant-network 20 12
4 wrapped-bitcoin 20 12
4 usd-coin 20 12
5 dai 20 12
5 binancecoin 20 12
5 solana 20 12
6 algorand 20 18
6 binance-usd 20 18
6 flow 20 18
6 filecoin 20 18
6 polkadot 20 18

Customer account

[GET] /account/wallets

Request

The token present in the authorization header is the method to confirm access to this route

Response

{
    "status": {
        "statusCode": "SUCCESS",
        "statusMessage": "All of the customers wallets"
    },
    "wallets": [
        {
            "walletAddress": wallet address,
            "customerID": customer ID,
            "initialBalance": the balance at time of purchase,
            "currentBalance": the current balance,
            "cryptocurrencyCode": the wallets cryptocurrency,
            "holdingPeriod": investment time period
        }
    ]
}

Where

  • wallets is a list of all the customers wallets

[GET] /account/bundles

Request

The token present in the authorization header is the method to confirm access to this route

Response

{
    "status": {
        "statusCode": "SUCCESS",
        "statusMessage": "All of the customers bundles"
    },
    "bundles": [
        {
            "bundleAddress": bundle address,
            "bundleID": bundle ID,
            "customerID": customer ID,
            "amount": amount invested,
            "holdingPeriod": investment time period,
            "purchaseDatetime": datetime of purchase,
            "status": ACTIVE or INACTIVE
        }
    ]
}

Where

  • bundles is a list of all the customers bundles

[POST] /account/wallets/wallet-address

Request

{
    "walletAddress": the wallet address for which details are requested
}

The token present in the authorization header is the method to confirm access to this route

Response

{
    "status": {
        "statusCode": "SUCCESS",
        "statusMessage": "Details for wallet requested"
    },
    "wallet": {
            "walletAddress": wallet address,
            "customerID": customer ID,
            "initialBalance": the balance at time of purchase,
            "currentBalance": the current balance,
            "cryptocurrencyCode": the wallets cryptocurrency,
            "holdingPeriod": investment time period
    },
    "walletTransactions": [
        {
            "transactionID": transaction ID,
            "transactionDateTime": datetime of transaction,
            "chargeApplied": charges applied for selling before holding period expires,
            "amount": amount invested,
            "action": BUY or SELL,
            "cardNumber": card number masked,
            "expiry": expiry date masked,
            "unitsSold": sold cryptocurrency,
            "initialRate": rate at which the cryptocurrency was bought
        }
    ]
}

Where

  • walletTransactions is a list of all transactions carried out on that wallet

[POST] /account/bundles/bundle-address

Request

{
    "bundleAddress": bundle address
}

The token present in the authorization header is the method to confirm access to this route

Response

{
    "status": {
        "statusCode": "SUCCESS",
        "statusMessage": "Details for the bundle requested"
    },
    "bundle": {
        "bundleAddress": bundle address,
        "bundleID": bundle ID,
        "customerID": customer ID,
        "amount": amount invested,
        "holdingPeriod": investment time period,
        "purchaseDatetime": datetime of purchase,
        "status": ACTIVE or INACTIVE
    },
    "bundleTransactions": [ 
        {
            "transactionID": transaction ID,
            "transactionDateTime": datetime of transaction,
            "chargeApplied": charges applied for selling before holding period expires,
            "amount": amount invested,
            "action": BUY or SELL,
            "cardNumber": card number masked,
            "expiry": expiry date masked,
            "initialRate": rate at which the cryptocurrency was bought
        }
    ]
}

Where

  • bundleTransactions is a list of all transactions carried out on that wallet

Purchasing and selling

[POST] /account/purchase/wallet

Request

{
    "initialBalance": initial balance,
    "cryptocurrencyCode": cryptocurrency code,
    "holdingPeriod": holding period,
    "initialRate": initial rate,
    "amount": amount,
    "cardNumber": card number,
    "expiry": expiry
}

The token present in the authorization header is the method to confirm access to this route

Response

{
    "status": {
        "statusCode": "SUCCESS",
        "statusMessage": "Wallet purchased"
    },
    "wallet": {
        "walletAddress": wallet address,
        "customerID": customer ID,
        "initialBalance": the balance at time of purchase,
        "currentBalance": the current balance,
        "cryptocurrencyCode": the wallets cryptocurrency,
        "holdingPeriod": investment time period
    },
    "walletTransaction": {
        "transactionID": transaction ID,
        "transactionDateTime": datetime of transaction,
        "chargeApplied": charges applied for selling before holding period expires,
        "amount": amount invested,
        "action": BUY or SELL,
        "cardNumber": card number masked,
        "expiry": expiry date masked,
        "unitsSold": sold cryptocurrency,
        "initialRate": rate at which the cryptocurrency was bought
    }
}

Where

  • walletTransaction is the details of that particular transaction carried out

[POST] /account/sell/wallet

Request

{
    "walletAddress": wallet address,
    "initialRate": initial rate,
    "amount": amount,
    "cardNumber": card number,
    "expiry": expiry,
    "unitsSold": units sold
}

The token present in the authorization header is the method to confirm access to this route

Response

{
    "status": {
        "statusCode": "SUCCESS",
        "statusMessage": "Successfully sold wallet"
    },
    "wallet": {
        "walletAddress": wallet address,
        "customerID": customer ID,
        "initialBalance": initial balance,
        "currentBalance": current balance,
        "cryptocurrencyCode": cryptocurrency code,
        "holdingPeriod": holdingPeriod
    },
    "walletTransaction": {
        "transactionID": transaction ID,
        "transactionDateTime": transaction datetime,
        "chargeApplied": charge applied,
        "amount": amount,
        "action": action,
        "cardNumber": card number,
        "expiry": expiry,
        "unitsSold": unitsSold,
        "initialRate": initial rate
    }
}

[POST] /account/purchase/bundle

Request

{
    "bundleID": bundle ID,
    "holdingPeriod": holding period,
    "initialRate": initial rate,
    "amount": amount,
    "cardNumber": card number,
    "expiry": expiry
}

The token present in the authorization header is the method to confirm access to this route

Response

{
    "status": {
        "statusCode": "SUCCESS",
        "statusMessage": "Bundle purchased"
    },
    "bundle": {
        "bundleAddress": bundle address,
        "customerID": customer ID,
        "bundleID": bundle ID,
        "purchaseDatetime": purchase datetime,
        "status": status,
        "holdingPeriod": investment time period
    },
    "bundleTransaction": {
        "transactionID": transaction ID,
        "transactionDateTime": datetime of transaction,
        "chargeApplied": charges applied for selling before holding period expires,
        "amount": amount invested,
        "action": BUY or SELL,
        "cardNumber": card number masked,
        "expiry": expiry date masked,
        "initialRate": rate at which the cryptocurrency was bought
    }
}

Where

  • bundleTransaction is the details of that particular transaction carried out

[POST] /account/sell/bundle

Request

{
    "bundleAddress": bundle address,
    "bundleID": bundle ID,
    "initialRate": initial rate,
    "amount": amount,
    "cardNumber": card number,
    "expiry": expiry
}

The token present in the authorization header is the method to confirm access to this route

Response

{
    "status": {
        "statusCode": "SUCCESS",
        "statusMessage": "Successfully sold bundle"
    },
    "bundle": {
        "bundleAddress": bundle address,
        "customerID": customer ID,
        "bundleID": bundle ID,
        "purchaseDatetime": purchase datetime,
        "status": status,
        "holdingPeriod": holdingPeriod
    },
    "bundleTransaction": {
        "transactionID": transaction ID,
        "transactionDateTime": transaction datetime,
        "chargeApplied": charge applied,
        "amount": amount,
        "action": action,
        "cardNumber": card number,
        "expiry": expiry,
        "initialRate": initial rate
    }
}