Admin API
Admin API used to control the economy token and the user funds.
With the admin API the developer can mint, burn and transfer tokens between the wallets.
It is possible to use the Admin API only in the custody mode (see Wallet API).

Burn tokens

Start async job of burning tokens
1
POST /api/v2/admin/tokens/burn
Copied!

Headers

Name
Type
Description
Authorization
String
JWT Authorization in a format "Bearer {jwtToken}"

Parameter Parameters

Name
Type
Description
tokenAddress
String
Token address to burn (body parameter)
networkType
String
Token's network (must be Fuse)
amount
String
Token amount to burn
from
String
account to burn from (optional)

Query Parameters

Name
Type
Description
apiKey
String
API key is used to access the API

Examples

Burn 1.1 tokens on Fuse network
1
POST /api/v2/admin/tokens/burn
2
body: { tokenAddress: '0xbAa75ecD3Ea911c78A23D7cD16961Eadc5867d2b', networkType: 'fuse', amount: '1.1' }
Copied!

Success 200

Name
Type
Description
Started
String
job data

Get burn events

Get burn events created by admin
1
POST /api/v2/admin/tokens/burnEvents
Copied!

Headers

Name
Type
Description
Authorization
String
JWT Authorization in a format "Bearer {jwtToken}"

Parameter Parameters

Name
Type
Description
fromWallet
String
startTime
String
endTime
String
networkType
String
Token's network (must be Fuse)

Query Parameters

Name
Type
Description
apiKey
String
API key is used to access the API

Examples

GET /api/v2/admin/tokens/burnEvents
1
GET /api/v2/admin/tokens/burnEvents
2
body: { fromWallet: '0x755c33BE69dD2baB7286E7a2010fc8591AF15a1e', networkType: 'fuse' }
Copied!

Create token

Start async job of creating a token
1
POST /api/v2/admin/tokens/create
Copied!

Headers

Name
Type
Description
Authorization
String
JWT Authorization in a format "Bearer {jwtToken}"

Parameter Parameters

Name
Type
Description
name
String
Token name
symbol
String
Token symbol
initialSupply
String
Token initial supply (in ETH)
uri
String
Token URI (metadata)
expiryTimestamp
String
Token expiry timestamp after which cannot transfer (Unix epoch time - in seconds)
spendabilityIds
String
Token spendability ids (comma-seperated list)
networkType
String
Token's network (must be Fuse)

Query Parameters

Name
Type
Description
apiKey
String
API key is used to access the API

Examples

Create a token on Fuse network
1
POST /api/v2/admin/tokens/create
2
body: { name: 'MyCoolToken', symbol: 'MCT', initialSupply: '100', uri: 'ipfs://hash', expiryTimestamp: 1585036857, spendabilityIds: 'a,b,c', networkType: 'fuse' }
Copied!

Success 200

Name
Type
Description
Started
String
job data

Create wallet for phone number

Start async job of creating a wallet for phone number (owned by the community admin)
1
POST /api/v2/admin/wallets/create
Copied!

Headers

Name
Type
Description
Authorization
String
JWT Authorization in a format "Bearer {jwtToken}"

Parameter Parameters

Name
Type
Description
phoneNumber
String
phone number to create a wallet for (body parameter)

Query Parameters

Name
Type
Description
apiKey
String
API key is used to access the API

Examples

Create wallet for the provided phone number
1
POST /api/v2/admin/wallets/create
2
body: { phoneNumber: '+972546123321' }
Copied!

Success 200

Name
Type
Description
Started
String
job data

Get expired by wallet/token/spendabilityId

Get expired balance for one/multiple wallets by token or spendabilityId
1
POST /api/v2/admin/tokens/expired
Copied!

Headers

Name
Type
Description
Authorization
String
JWT Authorization in a format "Bearer {jwtToken}"

Parameter Parameters

Name
Type
Description
walletAddress
String
tokenAddress
String
spendabilityId
String
networkType
String
Token's network (must be Fuse)

Query Parameters

Name
Type
Description
apiKey
String
API key is used to access the API

Examples

GET /api/v2/admin/tokens/expired
1
GET /api/v2/admin/tokens/expired
2
body: { walletAddress: '0x755c33BE69dD2baB7286E7a2010fc8591AF15a1e', tokenAddress: '0xbAa75ecD3Ea911c78A23D7cD16961Eadc5867d2b', networkType: 'fuse' }
Copied!

Get token jobs by address on fuse

Get token transfer events by address on fuse
1
GET api/v2/admin/wallets/transfers/tokentx/:walletAddress
Copied!

Headers

Name
Type
Description
Authorization
String
JWT Authorization in a format "Bearer {jwtToken}"

Parameter Parameters

Name
Type
Description
tokenAddress
String
Address of the token
fromBlockNumer
String
The block number to start fetch from

Query Parameters

Name
Type
Description
apiKey
String
API key is used to access the API

Success 200

Name
Type
Description
data
Object
Array of jobs

Mint tokens

Start async job of minting tokens
1
POST /api/v2/admin/tokens/mint
Copied!

Headers

Name
Type
Description
Authorization
String
JWT Authorization in a format "Bearer {jwtToken}"

Parameter Parameters

Name
Type
Description
tokenAddress
String
Token address to mint (body parameter)
networkType
String
Token's network (must be Fuse)
amount
String
Token amount to mint
toAddress
String
account to transfer to

Query Parameters

Name
Type
Description
apiKey
String
API key is used to access the API

Examples

Minting 1.1 tokens on Fuse network
1
POST /api/v2/admin/tokens/mint
2
body: { tokenAddress: '0xbAa75ecD3Ea911c78A23D7cD16961Eadc5867d2b', networkType: 'fuse', amount: '1.1' }
Copied!

Success 200

Name
Type
Description
Started
String
job data

Transfer tokens from account

Start async job of transferring tokens from account (owned by community admin)
1
POST /api/v2/admin/tokens/transfer
Copied!

Headers

Name
Type
Description
Authorization
String
JWT Authorization in a format "Bearer {jwtToken}"

Parameter Parameters

Name
Type
Description
tokenAddress
String
Token address to transfer (body parameter)
spendabilityIds
String
Token spendability ids (comma-seperated list) - if sent, no need for tokenAddress
spendabilityOrder
String
Token spendability order (asc/desc) - mandatory if using spendabilityIds
networkType
String
Token's network (must be Fuse)
amount
String
Token amount to transfer
from
String
account to transfer from
to
String
address to transfer to

Query Parameters

Name
Type
Description
apiKey
String
API key is used to access the API

Examples

Transfer 1.1 tokens on Fuse network
1
POST /api/v2/admin/tokens/transfer
2
body: { tokenAddress: '0xbAa75ecD3Ea911c78A23D7cD16961Eadc5867d2b', networkType: 'fuse', amount: '1.1', from: '0x755c33BE69dD2baB7286E7a2010fc8591AF15a1e', to: '0x5d651E34B6694A8778839441dA954Ece0EA733D8' }
Copied!

Success 200

Name
Type
Description
Started
String
job data