List supported networks

curl --request GET \
  --url https://sandbox-api.polygon.technology/v0.13/networks \
  --header 'Authorization: Bearer <token>'

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://sandbox-api.polygon.technology/v0.13/networks', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://sandbox-api.polygon.technology/v0.13/networks",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://sandbox-api.polygon.technology/v0.13/networks"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://sandbox-api.polygon.technology/v0.13/networks")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

{
  "data": [
    {
      "network": "<string>",
      "category": "crypto",
      "type": "blockchain",
      "displayName": "<string>",
      "assets": [
        {
          "asset": "<string>",
          "contractAddress": "<string>",
          "decimals": 123
        }
      ],
      "supportedBy": {
        "externalAccount": {
          "asSource": [
            "<string>"
          ],
          "asDestination": [
            "<string>"
          ]
        },
        "depositAddress": {
          "asSource": true,
          "asDestination": true
        },
        "virtualAccount": {
          "asSource": true,
          "asDestination": true
        },
        "cashIn": {
          "asSource": true,
          "asDestination": true
        },
        "wallet": {
          "asSource": true,
          "asDestination": true
        }
      },
      "chainId": 123,
      "networkFamily": "evm"
    }
  ],
  "object": "list"
}

{
  "error": "InvalidParameter",
  "code": 10006,
  "msg": "latitude must be between -90 and 90",
  "cause": "<string>"
}

Reference

List supported networks

Lists every network OMS supports, with its identifiers, available assets, and which OMS resources can use it in which direction. Availability is derived from live route configuration, so a network absent from this list is not routable; the fiat-rail availability and the crypto deposit-address signal both reflect your own project’s provider configuration.

A project can hold more than one payment provider. Omit vendor and the response is the union of every provider the project holds, which over-reports for a caller that already knows which provider a given customer belongs to. Pass vendor to scope the response to exactly that one. It must be a provider the project actually holds, and one of coinme or erebor; anything else is rejected with 400 (error InvalidParameter, code 10006) rather than falling back to the union.

“Network” here means any rail, not only a blockchain: category (crypto | fiatAccount | cash) and type (blockchain | bankRail | card | physical) are what distinguish them, and chainId / networkFamily are absent on everything that is not a blockchain.

GET

networks

List supported networks

curl --request GET \
  --url https://sandbox-api.polygon.technology/v0.13/networks \
  --header 'Authorization: Bearer <token>'

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://sandbox-api.polygon.technology/v0.13/networks', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://sandbox-api.polygon.technology/v0.13/networks",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://sandbox-api.polygon.technology/v0.13/networks"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://sandbox-api.polygon.technology/v0.13/networks")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

{
  "data": [
    {
      "network": "<string>",
      "category": "crypto",
      "type": "blockchain",
      "displayName": "<string>",
      "assets": [
        {
          "asset": "<string>",
          "contractAddress": "<string>",
          "decimals": 123
        }
      ],
      "supportedBy": {
        "externalAccount": {
          "asSource": [
            "<string>"
          ],
          "asDestination": [
            "<string>"
          ]
        },
        "depositAddress": {
          "asSource": true,
          "asDestination": true
        },
        "virtualAccount": {
          "asSource": true,
          "asDestination": true
        },
        "cashIn": {
          "asSource": true,
          "asDestination": true
        },
        "wallet": {
          "asSource": true,
          "asDestination": true
        }
      },
      "chainId": 123,
      "networkFamily": "evm"
    }
  ],
  "object": "list"
}

{
  "error": "InvalidParameter",
  "code": 10006,
  "msg": "latitude must be between -90 and 90",
  "cause": "<string>"
}

Authorizations

Authorization

string

header

required

Token from POST /auth/token

Query Parameters

vendor

enum<string>

Scope the response to one vendor the calling project holds. Omit to get the union of every vendor the project has. The payment provider a project routes through: coinme is Coinme Inc., erebor is Erebor Bank, N.A. Pass it as vendor on GET /networks to scope that response's supportedBy signals to one provider; omit it and the response is the union of every provider your project holds.

Available options:

coinme,

erebor

Response

The request has succeeded.

data

object[]

required

Hide child attributes

data.network

string

required

Partner-facing network token — the value to send in a request network field. Always a camelCase public token (for example swift), never a snake_case internal code. achSameDay and local are also contract-legal request values with no distinct entry here: routes are validated against the coarser ach / swift rail respectively, so achSameDay availability is reported under ach and local under swift rather than as their own network.

data.category

enum<string>

required

Which broad class of network this is.

Available options:

crypto,

fiatAccount,

cash

data.type

enum<string>

required

The transport a network uses.

Available options:

blockchain,

bankRail,

card,

physical

data.displayName

string

required

Human-readable label, e.g. "Polygon PoS".

data.assets

object[]

required

Hide child attributes

data.assets.asset

string

required

Lowercase canonical asset code, e.g. usdc.

data.assets.contractAddress

string | null

Token contract address. OMITTED — the JSON key is absent, not sent as an explicit null — for a native asset and for any asset with no on-chain identity record. "Key absent" and "explicit null" are equivalent here; no case needs telling the two apart.

data.assets.decimals

integer<int32> | null

Count of decimal places in the on-chain smallest unit. OMITTED (key absent, not explicit null) — see contractAddress for why absent and null are equivalent here — when there is no on-chain identity record for this (asset, network): the scale is then genuinely unknown, not zero. A partner must not assume a default scale and must not format an amount in this asset while decimals is absent — the same "absent means unproven, not false" convention supportedBy.wallet uses for a capability instead of a scale.

data.supportedBy

object

required

Which OMS resources can use this network, and in which direction.

Every property is optional, and absence is meaningful: it means the answer is not established, NOT that the answer is no. A client must not treat a missing property as false. wallet is the field this applies to in practice — see its own description.

Hide child attributes

data.supportedBy.externalAccount

object

External-account types usable on this network, per direction — e.g. ["walletExternal"] on a chain, ["bankUs"] on ach.

Hide child attributes

data.supportedBy.externalAccount.asSource

string[]

required

data.supportedBy.externalAccount.asDestination

string[]

required

data.supportedBy.depositAddress

object

Whether a resource can use a network as a transaction source, a destination, or both. Both flags are always present; false means checked-and-no.

Hide child attributes

data.supportedBy.depositAddress.asSource

boolean

required

data.supportedBy.depositAddress.asDestination

boolean

required

data.supportedBy.virtualAccount

object

Whether a resource can use a network as a transaction source, a destination, or both. Both flags are always present; false means checked-and-no.

Hide child attributes

data.supportedBy.virtualAccount.asSource

boolean

required

data.supportedBy.virtualAccount.asDestination

boolean

required

data.supportedBy.cashIn

object

Whether a resource can use a network as a transaction source, a destination, or both. Both flags are always present; false means checked-and-no.

Hide child attributes

data.supportedBy.cashIn.asSource

boolean

required

data.supportedBy.cashIn.asDestination

boolean

required

data.supportedBy.wallet

object

Whether an OMS-custodied wallet can hold value on this network and use it as a source or destination.

ABSENT means unproven, not false: wallet custody is only reported for networks where it is established. A network that omits this property may gain it later as a data change, not a contract change.

Hide child attributes

data.supportedBy.wallet.asSource

boolean

required

data.supportedBy.wallet.asDestination

boolean

required

data.chainId

integer<int64> | null

EVM chain id. OMITTED (key absent, not explicit null) for a non-EVM network — see contractAddress for why absent and null are equivalent here. A network whose chain identifier is not an integer (for example Solana, identified by a base58 genesis hash) omits the key.

data.networkFamily

enum<string> | null

OMITTED (key absent, not explicit null) for non-blockchain networks — see contractAddress for why absent and null are equivalent here.

Available options:

evm,

solana,

tron

object

enum<string>

Available options:

list

Overview

Move money

Routes

External Payment Methods

Platform

List supported networks

Authorizations

Query Parameters

Response