Networks

GET/v1/networks

Lists the networks enabled for your account, how players pay on each and your prices. Use it to show players the right networks and minimums on your own site, then send them to the payment page with the amount and network they chose.

Example

const { body } = await icn("GET", "/v1/networks");

status, body = icn("GET", "/v1/networks")

200 OK

{
  "networks": [
    {
      "asset": "tron:USDT",
      "chain": "tron",
      "token": "USDT",
      "decimals": 6,
      "mode": "standard",
      "payment_page": true,
      "fee_formula": "sum",
      "deposit": { "fee_bps": 100, "min_fee": "0", "min_amount": "10000000" },
      "payout": { "fee_bps": 50, "min_fee": "1500000", "min_amount": "20000000", "fee_mode": "on_top" }
    },
    {
      "asset": "bsc:USDT",
      "chain": "bsc",
      "token": "USDT",
      "decimals": 18,
      "mode": "pro",
      "payment_page": true,
      "fee_formula": "sum",
      "deposit": { "fee_bps": 100, "min_fee": "1000000000000000000", "min_amount": "10000000000000000000" },
      "payout": { "fee_bps": 50, "min_fee": "1000000000000000000", "min_amount": "10000000000000000000", "fee_mode": "on_top" }
    }
  ]
}

Fields

Field	Type	Description
`asset`	string · required	Network and token, for example `tron:USDT`. Use it in `assets` when you create a checkout session.
`mode`	string · required	`standard`: players pay an exact amount through the payment page. `pro`: every player has their own deposit address. See Standard and Pro.
`payment_page`	boolean · required	Whether the network is offered on the payment page.
`fee_formula`	string · required	`sum`: your rate plus the network fee. `max`: the higher of the two (older agreements).
`deposit`	object · required	`fee_bps` (your rate, 100 = 1%), `min_fee` (network fee) and `min_amount`, for deposits made the network's current way.
`payout`	object · required	`fee_bps`, `min_fee`, `min_amount` and `fee_mode` (`on_top` or `deducted`) for payouts.

Amounts are integers in the token's smallest unit (USDT on TRON and Ethereum has 6 decimals, on BSC 18).
Changes in the console (switching a network to Standard or Pro, enabling a new network) show here right away, so read it rather than hard-coding networks.
For the exact fee on one amount, use Quote.

Typical flow (Standard)

Show the networks with payment_page: true and their deposit.min_amount on your site.
The player picks a network, enters the amount and confirms.
Create a checkout session with that amount and assets: ["tron:USDT"] and redirect the player to its url. The page goes straight to the exact amount and address to send.