๐ŸฆTenants

API's for managing Tenants.

Create Tenant

Requirement: Request an Auth Code from Tyga Support at support@tygapay.com to create a Tenant Account.

Get Tenant Wallets

Fetches the wallets for a tenant.

GET/tenant/wallets
Header parameters
Response

OK

Body
namestring

The name of the wallet (e.g. "Tyga 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
const response = await fetch('/tenant/wallets', {
    method: 'GET',
    headers: {
      "x-api-key": "text",
      "x-api-hash": "text"
    },
});
const data = await response.json();
Response
[
  {
    "name": "text",
    "type": "text",
    "balance": 1,
    "totalDeposited": 1,
    "totalDistributed": 1
  }
]

Get Tenant Deposit Addresses

Fetches the deposit addresses for a tenant.

GET/tenant/deposit-addresses
Header parameters
Response

OK

Body
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
const response = await fetch('/tenant/deposit-addresses', {
    method: 'GET',
    headers: {
      "x-api-key": "text",
      "x-api-hash": "text"
    },
});
const data = await response.json();
Response
[
  {
    "name": "text",
    "address": "text",
    "network": "text",
    "supportedTokens": [
      "text"
    ]
  }
]

Last updated