Web3 pool API

Learn to leverage our Web3 Pool API for secure and decentralized crypto payment solutions, streamlining your operations with advanced tools.

Claim

Add a balance to the specified wallet

POST /Claim/AddUserClaimable

Request Body

Name	Type	Description
userAddress*	String	User Wallet
token*	String	Withdrawal currency
amount*	Number($double)	Withdrawal amount

200: OK Success

{
  "requestId": 0
}

400: Bad Request Bad Request

Reduce balance to the specified purse

POST /Claim/DecreaseUserClaimable

Request Body

Name	Type	Description
userAddress*	String	User Wallet
token*	String	Withdrawal currency
amount*	Number($double)	Withdrawal amount

200: OK Success

{
  "requestId": 0
}

400: Bad Request Bad Request

ContractSettings

Add a token to the contract whitelist

POST /ContractSettings/AddTokenToWhitelist

Request Body

Name	Type	Description
token*	String	Currency to add to whitelist

200: OK Success

{
  "requestId": 0
}

400: Bad Request Bad Request

Info

Get information about the contract

GET /Info/Contract

200: OK Success

{
  "address": "string",
  "feePercent": 0,
  "whiteListedTokens": [
    "string"
  ],
  "balances": [
    {
      "currency": "string",
      "total": 0,
      "reserved": 0,
      "free": 0,
      "fee": 0
    }
  ]
}

400: Bad Request Bad Request

List of supported tokens

GET /Info/SupportedTokens

200: OK Success

[
  {
    "name": "string",
    "contract": "string"
  }
]

Queue

Get request status

GET /Queue/Status/{queueId}

Path Parameters

Name	Type	Description
queueId*	integer	queueId

200: OK Success

{
  "error": "string",
  "status": "string"
}

400: Bad Request Bad Request

Withdraw

Withdrawing available funds

POST /Withdraw

Request Body

Name	Type	Description
wallet*	string	Recipient's wallet
token*	string	Withdrawal currency
amount*	number($double)	Withdrawal amount

200: OK Success

{
  "requestId": 0
}

400: Bad Request Bad Request

Schemas

AddTokenToWhitelistModel

{
userAddress*	string
User Wallet

token*	string
Withdrawal currency

amount*	number($double)
Withdrawal amount

}

AddUserClaimbleModel

{
userAddress*	string
User Wallet

token*	string
Withdrawal currency

amount*	number($double)
Withdrawal amount

}

ApiBadRequestResponse

{
errors	{...}
nullable: true
}

Bep20Contract

{
name	string
nullable: true
contract	string
nullable: true
}

ContractBalanceModel

{
currency	string
nullable: true
Currency

total	number($double)
Total contract balance

reserved	number($double)
Reserved for users

free	number($double)
Available balance for withdrawal or reservation

fee	number($double)
Commission from free balance

}

ContractInfoModel

{
address	string
nullable: true
Contract Address

feePercent	number($double)
Commission

whiteListedTokens	[...]
balances	[...]
}

QueryResult

{
requestId	integer($int32)
Request Id

}

QueueResult

{
error	string
nullable: true
Error description

status	string
nullable: true
Request Status

}

WithdrawModel

{
wallet*	string
Recipient's wallet

token*	string
Withdrawal currency

amount*	number($double)
minimum: 0
Withdrawal amount

}