🏦Tenants

API's for managing Tenants.

Production URL: https://tenants-v1-api-t3mipd377q-ey.a.run.app

Create Tenant

Requirement: Request an Auth Code from NovaX Support at [e-mail] to create a Tenant Account.

Create a Tenant.

POST/tenant

Body

application/json

code*string

The Auth Code provided by NovaX to create a new tenant.

name*string

The name of the tenant.

contactEmail*string

The contact email of the tenant - typically the admin contact email.

Response

200409500

User successfully created.

Body

application/json

apiSecretstring

A secret for the new tenant.

apiKeystring

A unique API Key for the new tenant.

messagestring

A friendly message after a new tenant is created.

Request

JavaScriptCurlPython

const response = await fetch('/tenant', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "code": "text",
      "name": "text",
      "contactEmail": "text"
    }),
});
const data = await response.json();

Response

200

{
  "apiSecret": "text",
  "apiKey": "text",
  "message": "text"
}

Get Tenant Wallets

Fetches the wallets for a tenant.

GET/tenant/wallets

Header parameters

Response

200409500

OK

Body

application/json

namestring

The name of the wallet (e.g. "NovaX Wallet").

typestring

The type of wallet (e.g. "distribution_wallet").

balancenumber

The current balance of the wallet.

totalDepositednumber

The total amount deposited into the wallet.

totalDistributednumber

The total amount distributed from the wallet.

Request

JavaScriptCurlPython

const response = await fetch('/tenant/wallets', {
    method: 'GET',
    headers: {
      "x-api-key": "text",
      "x-api-hash": "text"
    },
});
const data = await response.json();

Response

200

[
  {
    "name": "text",
    "type": "text",
    "balance": 0,
    "totalDeposited": 0,
    "totalDistributed": 0
  }
]

Get Tenant Deposit Addresses

Fetches the deposit addresses for a tenant.

GET/tenant/deposit-addresses

Header parameters

Response

200409500

OK

Body

application/json

namestring

The name of the deposit address (e.g. "distribution_wallet").

addressstring

The deposit address for the tenant.

networkstring

The network for the deposit address.

supportedTokensarray of string

The supported tokens for the deposit address.

Request

JavaScriptCurlPython

const response = await fetch('/tenant/deposit-addresses', {
    method: 'GET',
    headers: {
      "x-api-key": "text",
      "x-api-hash": "text"
    },
});
const data = await response.json();

Response

200

[
  {
    "name": "text",
    "address": "text",
    "network": "text",
    "supportedTokens": [
      "text"
    ]
  }
]