🏦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 [email protected] to create a Tenant Account.

Create a Tenant.

post

Body

application/json

codestringRequired

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

namestringRequired

The name of the tenant.

contactEmailstringRequired

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

Responses

200

User successfully created.

application/json

apiSecretstringOptional

A secret for the new tenant.

apiKeystringOptional

A unique API Key for the new tenant.

messagestringOptional

A friendly message after a new tenant is created.

409

Permission denied.

500

Internal error.

post

/tenant

HTTPcURLJavaScriptPython

POST /tenant HTTP/1.1
Host: tenants-v1-api-t3mipd377q-ey.a.run.app
Content-Type: application/json
Accept: */*
Content-Length: 51

{
  "code": "text",
  "name": "text",
  "contactEmail": "text"
}

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

Get Tenant Wallets

Fetches the wallets for a tenant.

get

Header parameters

x-api-keystringRequired

Your unique API Key.

x-api-hashstringRequired

Your API Hash.

Responses

200

OK

application/json

namestringOptional

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

typestringOptional

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

balancenumberOptional

The current balance of the wallet.

totalDepositednumberOptional

The total amount deposited into the wallet.

totalDistributednumberOptional

The total amount distributed from the wallet.

409

Permission denied.

500

Internal error.

get

/tenant/wallets

HTTPcURLJavaScriptPython

GET /tenant/wallets HTTP/1.1
Host: tenants-v1-api-t3mipd377q-ey.a.run.app
x-api-key: text
x-api-hash: text
Accept: */*

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

Get Tenant Deposit Addresses

Fetches the deposit addresses for a tenant.

get

Header parameters

x-api-keystringRequired

Your unique API Key.

x-api-hashstringRequired

Your API Hash.

Responses

200

OK

application/json

namestringOptional

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

addressstringOptional

The deposit address for the tenant.

networkstringOptional

The network for the deposit address.

supportedTokensstring[]Optional

The supported tokens for the deposit address.

409

Permission denied.

500

Internal error.

get

/tenant/deposit-addresses

HTTPcURLJavaScriptPython

GET /tenant/deposit-addresses HTTP/1.1
Host: tenants-v1-api-t3mipd377q-ey.a.run.app
x-api-key: text
x-api-hash: text
Accept: */*

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