NovaX Docs
  • ๐Ÿ‘‹Welcome!
  • ๐Ÿ›’Payment Gateway
    • ๐Ÿ’กHow It Works
    • โ„น๏ธGet Started
  • API
    • ๐Ÿš€API Integration Setup
      • ๐Ÿ”Authentication
      • โ†—๏ธRequests
    • ๐Ÿ“ฆAPIs
      • ๐Ÿ“–Swagger Docs
      • ๐ŸฆTenants
      • ๐Ÿ˜„Users
      • โ†”๏ธTransactions
      • ๐ŸงพOrders
  • Admin Portal
    • โชRefunds
      • โฎ๏ธPaid Order Refunds
      • โ—€๏ธPartial Paid Order Refunds
      • โ—€๏ธOverpaid Order Refunds
Powered by GitBook
On this page
  1. API
  2. APIs

Tenants

API's for managing Tenants.

PreviousSwagger DocsNextUsers

Last updated 9 months ago

Production URL:

Create Tenant

Requirement: Request an Auth Code from NovaX Support at support@novax.money to create a Tenant Account.

Get Tenant Wallets

Get Tenant Deposit Addresses

๐Ÿ“ฆ
๐Ÿฆ
https://tenants-v1-api-t3mipd377q-ey.a.run.app

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
409
Permission denied.
500
Internal error.
get
GET /tenant/wallets HTTP/1.1
Host: 
x-api-key: text
x-api-hash: text
Accept: */*
[
  {
    "name": "text",
    "type": "text",
    "balance": 1,
    "totalDeposited": 1,
    "totalDistributed": 1
  }
]

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
409
Permission denied.
500
Internal error.
get
GET /tenant/deposit-addresses HTTP/1.1
Host: 
x-api-key: text
x-api-hash: text
Accept: */*
[
  {
    "name": "text",
    "address": "text",
    "network": "text",
    "supportedTokens": [
      "text"
    ]
  }
]
  • Create Tenant
  • POSTCreate a Tenant.
  • Get Tenant Wallets
  • GETFetches the wallets for a tenant.
  • Get Tenant Deposit Addresses
  • GETFetches the deposit addresses for a tenant.

Create a Tenant.

post
Body
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
409
Permission denied.
500
Internal error.
post
POST /tenant HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 51

{
  "code": "text",
  "name": "text",
  "contactEmail": "text"
}
{
  "apiSecret": "text",
  "apiKey": "text",
  "message": "text"
}