Asset Listings By Wallet Holders API

Adding an existing asset

Displaying existing assets

Option 1: You can check all assets within our system.

Get all supported assets configuration that can be imported into a merchant or a user wallet

get

Authorizations

Query parameters

sortBystring · enumOptional

Sort by

Default: createdAtAvailable options:

sortOrderstring · enumOptional

Sort order

Default: DESCAvailable options:

searchstringOptional

Search

fromDatestringOptional

toDatestringOptional

chainNamestring · enumOptionalAvailable options:

symbolstringOptionalExample: ETH

statusstring · enumOptionalAvailable options:

Responses

application/json

objectOptional

get

HTTPcURLJavaScriptPython

GET /api/v1/assets/configurations HTTP/1.1
Host: 
X-API-KEY: YOUR_API_KEY
Accept: */*

200

Get all supported assets configuration

{
  "pagination": {},
  "assets": [
    {
      "chainId": "text",
      "merchantId": "text",
      "chainName": "text",
      "name": "ALGORAND",
      "symbol": "ALGO",
      "verified": true,
      "isOffChain": true,
      "type": "COIN",
      "tokenStandard": "ERC_20",
      "assetIndex": 1,
      "description": "text",
      "ownershipType": "text",
      "multisigVersion": 1,
      "multisigSignerThreshold": 1,
      "status": "active",
      "createdByUserId": "text",
      "createdByMerchantId": "text",
      "chain": {
        "id": "6e464058-67c1-4273-a6a4-8aae522e34be",
        "name": "ALGORAND",
        "derivationPath": "m/84'/0'/0'/0/0",
        "addressRegex": "/^0x[a-fA-F0-9]{40}$/",
        "slip44": 1,
        "status": "UP",
        "indexUrl": "text",
        "chainId": 1
      },
      "createdByMerchant": {
        "name": "Republic",
        "nameSlugify": "republic",
        "verified": true,
        "contactEmail": "[email protected]",
        "contactPhoneNumber": "text",
        "usersCount": 1,
        "assetsCount": 1,
        "tokensCount": 1,
        "coinsCount": 1,
        "walletsCount": 1,
        "status": "active",
        "createdAt": "2025-04-24T06:59:16.167Z",
        "updatedAt": "2025-04-24T06:59:16.167Z",
        "createdAssets": [
          []
        ]
      },
      "createdByUser": {
        "id": "text",
        "externalUserId": "6e464058-67c1-4273-a6a4-8aae522e34be",
        "merchantId": "6e464058-67c1-4273-a6a4-8aae522e34be",
        "role": "republic_admin",
        "firstName": "Bryan",
        "walletsCount": 2,
        "latestWallabyAuthPubKey": "4ecb720b1392468c75803d6252ac987c113206955070b96df1208c1c480338168e1407cec4b5af2f91d12af9b725cbd85af994b29c6364971a7ef8d955be83dc",
        "latestWallabyAuthPubKeyVersion": "1",
        "hasFullPermissions": true
      }
    }
  ]
}

Option 2: Filter it down to check only assets that you have added.

Get merchant assets by merchant id

get

Authorizations

Path parameters

merchantIdstringRequiredExample: 180b0a0f-6935-4047-a32d-b2a4d50acfc9

Query parameters

sortBystring · enumOptional

Sort by

Default: createdAtAvailable options:

sortOrderstring · enumOptional

Sort order

Default: DESCAvailable options:

searchstringOptional

Search

fromDatestringOptional

toDatestringOptional

chainNamestring · enumOptionalAvailable options:

symbolstringOptionalExample: ETH

isVisiblebooleanOptional

Asset visibility status

Responses

application/json

objectOptional

get

HTTPcURLJavaScriptPython

GET /api/v1/merchants/{merchantId}/assets HTTP/1.1
Host: 
X-API-KEY: YOUR_API_KEY
Accept: */*

200Success

{
  "pagination": {},
  "merchant": {
    "name": "Republic",
    "nameSlugify": "republic",
    "verified": true,
    "contactEmail": "[email protected]",
    "contactPhoneNumber": "text",
    "usersCount": 1,
    "assetsCount": 1,
    "tokensCount": 1,
    "coinsCount": 1,
    "walletsCount": 1,
    "status": "active",
    "createdAt": "2025-04-24T06:59:16.167Z",
    "updatedAt": "2025-04-24T06:59:16.167Z",
    "createdAssets": [
      []
    ]
  },
  "assets": [
    {
      "merchantId": "text",
      "configId": "text",
      "chainId": "text",
      "chainName": "text",
      "assetName": "text",
      "assetSymbol": "text",
      "isVisible": true
    }
  ],
  "merchantAssets": [
    {
      "merchantId": "text",
      "configId": "text",
      "chainId": "text",
      "chainName": "text",
      "assetName": "text",
      "assetSymbol": "text",
      "isVisible": true
    }
  ]
}

Adding an existing asset

Using the config retrieved from above, you can add the asset

Add a new asset to the user's wallet based on the asset configuration

post

Authorizations

Body

assetConfigIdstringRequired

Asset Config ID

walletIdstringRequired

User Wallet ID

userIdstringRequired

User ID

configobjectOptional

Responses

application/json

objectOptional

post

HTTPcURLJavaScriptPython

POST /api/v1/users/assets/add HTTP/1.1
Host: 
X-API-KEY: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 1372

{
  "assetConfigId": "text",
  "walletId": "text",
  "userId": "text",
  "config": {
    "chainId": "text",
    "merchantId": "text",
    "chainName": "text",
    "name": "ALGORAND",
    "symbol": "ALGO",
    "verified": true,
    "isOffChain": true,
    "type": "COIN",
    "tokenStandard": "ERC_20",
    "assetIndex": 1,
    "description": "text",
    "ownershipType": "text",
    "multisigVersion": 1,
    "multisigSignerThreshold": 1,
    "status": "active",
    "createdByUserId": "text",
    "createdByMerchantId": "text",
    "chain": {
      "id": "6e464058-67c1-4273-a6a4-8aae522e34be",
      "name": "ALGORAND",
      "derivationPath": "m/84'/0'/0'/0/0",
      "addressRegex": "/^0x[a-fA-F0-9]{40}$/",
      "slip44": 1,
      "status": "UP",
      "indexUrl": "text",
      "chainId": 1
    },
    "createdByMerchant": {
      "name": "Republic",
      "nameSlugify": "republic",
      "verified": true,
      "contactEmail": "[email protected]",
      "contactPhoneNumber": "text",
      "usersCount": 1,
      "assetsCount": 1,
      "tokensCount": 1,
      "coinsCount": 1,
      "walletsCount": 1,
      "status": "active",
      "createdAt": "2025-04-24T06:59:16.167Z",
      "updatedAt": "2025-04-24T06:59:16.167Z",
      "createdAssets": [
        []
      ]
    },
    "createdByUser": {
      "id": "text",
      "externalUserId": "6e464058-67c1-4273-a6a4-8aae522e34be",
      "merchantId": "6e464058-67c1-4273-a6a4-8aae522e34be",
      "role": "republic_admin",
      "firstName": "Bryan",
      "walletsCount": 2,
      "latestWallabyAuthPubKey": "4ecb720b1392468c75803d6252ac987c113206955070b96df1208c1c480338168e1407cec4b5af2f91d12af9b725cbd85af994b29c6364971a7ef8d955be83dc",
      "latestWallabyAuthPubKeyVersion": "1",
      "hasFullPermissions": true
    }
  }
}

201

Returns newly added asset

{
  "pagination": {},
  "assets": [
    {
      "userId": "text",
      "merchantId": "text",
      "chainId": "text",
      "userAssetAddress": "text",
      "walletId": "text",
      "configId": "text",
      "assetName": "text",
      "assetSymbol": "text",
      "balance": "text",
      "balanceUpdatedAt": {},
      "defaultAddress": "text",
      "isVisible": true,
      "source": "merchant",
      "addresses": [
        "text"
      ],
      "ownershipType": "text"
    }
  ]
}

Adding a new asset

(Optional) Fetch info offchain to prefill config data

Used for prefilling the token name, decimals, and symbol once the user inputs a contract address when adding a new asset to the system. Please note this will only work for EVM chains. I.

Fetching this info to prefill config data is only available for EVM chains. To see other APIs which are only availa

Request EVM token asset info like decimals, name and symbol

get

Authorizations

Query parameters

chainNamestring · enumRequiredAvailable options:

tokenContractAddressstringRequired

EVM token contract address on chain

Example: 0x28aef3b18daec312860dd030102a427ed43dac71

Responses

application/json

objectOptional

get

HTTPcURLJavaScriptPython

GET /api/v1/query/fetch-token-info?chainName=BITCOIN&tokenContractAddress=text HTTP/1.1
Host: 
X-API-KEY: YOUR_API_KEY
Accept: */*

200

EVM token asset info returned successfully

{
  "decimals": 18,
  "symbol": "USDC",
  "name": "USD Coin",
  "tokenContractAddress": "0x28aef3b18daec312860dd030102a427ed43dac71"
}

Create a new config

Create new asset configuration that can be imported later into a merchant or a user wallet. This endpoint is only available for super admin and republic admin

post

Authorizations

Body

chainIdstringRequired

namestringRequiredExample: ALGORAND

symbolstringRequiredExample: ALGO

verifiedbooleanRequired

isOffChainbooleanRequired

decimalsnumberRequired

typestring · enumRequiredAvailable options:

tokenStandardstring · enumOptional

Optional value only used when dealing with non native assets (aka tokens), it can be ERC_20, BEP_20, ALGO_STANDARD, ALGO_APP. If native asset, keep the field empty

Example: ERC_20Available options:

assetIndexnumberRequiredExample: 1

contractAddressstringOptional

Only required for Non-native assets (aka tokens)

descriptionstringOptional

createdByUserIdstringOptional

createdByMerchantIdstringOptional

Responses

application/json

objectOptional

post

HTTPcURLJavaScriptPython

POST /api/v1/assets/configurations HTTP/1.1
Host: 
X-API-KEY: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 253

{
  "chainId": "text",
  "name": "ALGORAND",
  "symbol": "ALGO",
  "verified": true,
  "isOffChain": true,
  "decimals": 1,
  "type": "COIN",
  "tokenStandard": "ERC_20",
  "assetIndex": 1,
  "contractAddress": "text",
  "description": "text",
  "createdByUserId": "text",
  "createdByMerchantId": "text"
}

201

Add new asset configuration by the admin so that it can be listed for merchant and user import

{
  "asset": {
    "chainId": "text",
    "merchantId": "text",
    "chainName": "text",
    "name": "ALGORAND",
    "symbol": "ALGO",
    "verified": true,
    "isOffChain": true,
    "type": "COIN",
    "tokenStandard": "ERC_20",
    "assetIndex": 1,
    "description": "text",
    "ownershipType": "text",
    "multisigVersion": 1,
    "multisigSignerThreshold": 1,
    "status": "active",
    "createdByUserId": "text",
    "createdByMerchantId": "text",
    "chain": {
      "id": "6e464058-67c1-4273-a6a4-8aae522e34be",
      "name": "ALGORAND",
      "derivationPath": "m/84'/0'/0'/0/0",
      "addressRegex": "/^0x[a-fA-F0-9]{40}$/",
      "slip44": 1,
      "status": "UP",
      "indexUrl": "text",
      "chainId": 1
    },
    "createdByMerchant": {
      "name": "Republic",
      "nameSlugify": "republic",
      "verified": true,
      "contactEmail": "[email protected]",
      "contactPhoneNumber": "text",
      "usersCount": 1,
      "assetsCount": 1,
      "tokensCount": 1,
      "coinsCount": 1,
      "walletsCount": 1,
      "status": "active",
      "createdAt": "2025-04-24T06:59:16.167Z",
      "updatedAt": "2025-04-24T06:59:16.167Z",
      "createdAssets": [
        []
      ]
    },
    "createdByUser": {
      "id": "text",
      "externalUserId": "6e464058-67c1-4273-a6a4-8aae522e34be",
      "merchantId": "6e464058-67c1-4273-a6a4-8aae522e34be",
      "role": "republic_admin",
      "firstName": "Bryan",
      "walletsCount": 2,
      "latestWallabyAuthPubKey": "4ecb720b1392468c75803d6252ac987c113206955070b96df1208c1c480338168e1407cec4b5af2f91d12af9b725cbd85af994b29c6364971a7ef8d955be83dc",
      "latestWallabyAuthPubKeyVersion": "1",
      "hasFullPermissions": true
    }
  }
}

Add the new asset

Create new asset configuration that can be imported later into a merchant or a user wallet. This endpoint is only available for super admin and republic admin

post

Authorizations

Body

chainIdstringRequired

namestringRequiredExample: ALGORAND

symbolstringRequiredExample: ALGO

verifiedbooleanRequired

isOffChainbooleanRequired

decimalsnumberRequired

typestring · enumRequiredAvailable options:

tokenStandardstring · enumOptional

Optional value only used when dealing with non native assets (aka tokens), it can be ERC_20, BEP_20, ALGO_STANDARD, ALGO_APP. If native asset, keep the field empty

Example: ERC_20Available options:

assetIndexnumberRequiredExample: 1

contractAddressstringOptional

Only required for Non-native assets (aka tokens)

descriptionstringOptional

createdByUserIdstringOptional

createdByMerchantIdstringOptional

Responses

application/json

objectOptional

post

HTTPcURLJavaScriptPython

POST /api/v1/assets/configurations HTTP/1.1
Host: 
X-API-KEY: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 253

{
  "chainId": "text",
  "name": "ALGORAND",
  "symbol": "ALGO",
  "verified": true,
  "isOffChain": true,
  "decimals": 1,
  "type": "COIN",
  "tokenStandard": "ERC_20",
  "assetIndex": 1,
  "contractAddress": "text",
  "description": "text",
  "createdByUserId": "text",
  "createdByMerchantId": "text"
}

201

Add new asset configuration by the admin so that it can be listed for merchant and user import

{
  "asset": {
    "chainId": "text",
    "merchantId": "text",
    "chainName": "text",
    "name": "ALGORAND",
    "symbol": "ALGO",
    "verified": true,
    "isOffChain": true,
    "type": "COIN",
    "tokenStandard": "ERC_20",
    "assetIndex": 1,
    "description": "text",
    "ownershipType": "text",
    "multisigVersion": 1,
    "multisigSignerThreshold": 1,
    "status": "active",
    "createdByUserId": "text",
    "createdByMerchantId": "text",
    "chain": {
      "id": "6e464058-67c1-4273-a6a4-8aae522e34be",
      "name": "ALGORAND",
      "derivationPath": "m/84'/0'/0'/0/0",
      "addressRegex": "/^0x[a-fA-F0-9]{40}$/",
      "slip44": 1,
      "status": "UP",
      "indexUrl": "text",
      "chainId": 1
    },
    "createdByMerchant": {
      "name": "Republic",
      "nameSlugify": "republic",
      "verified": true,
      "contactEmail": "[email protected]",
      "contactPhoneNumber": "text",
      "usersCount": 1,
      "assetsCount": 1,
      "tokensCount": 1,
      "coinsCount": 1,
      "walletsCount": 1,
      "status": "active",
      "createdAt": "2025-04-24T06:59:16.167Z",
      "updatedAt": "2025-04-24T06:59:16.167Z",
      "createdAssets": [
        []
      ]
    },
    "createdByUser": {
      "id": "text",
      "externalUserId": "6e464058-67c1-4273-a6a4-8aae522e34be",
      "merchantId": "6e464058-67c1-4273-a6a4-8aae522e34be",
      "role": "republic_admin",
      "firstName": "Bryan",
      "walletsCount": 2,
      "latestWallabyAuthPubKey": "4ecb720b1392468c75803d6252ac987c113206955070b96df1208c1c480338168e1407cec4b5af2f91d12af9b725cbd85af994b29c6364971a7ef8d955be83dc",
      "latestWallabyAuthPubKeyVersion": "1",
      "hasFullPermissions": true
    }
  }
}