Docs 0xProcessing
  • 💡Basic
    • General
      • Terms and definitions
      • Available assets
      • Transaction Fees
    • Introduction guide
      • Deposit flow
      • Payment form
      • Withdrawal flow
      • VRCS - automatic conversion to stablecoins
      • Webhooks flow
      • Web3 processing
      • 0xProcessing use cases
  • 🔑0xProcessing API
    • Obtaining API Keys
    • Deposits
      • Payment form with fixed amount
      • Payment without fixed amount
      • Static wallet
    • Withdrawals
      • Withdrawal by client
      • Check withdrawal status by Withdrawal ID
    • Webhooks
      • Payment form with fixed amount
      • Payment without fixed amount
      • Static wallet
      • Withdrawals
    • Informational Commands
      • Request for balances
      • Coin info
    • Crypto or Fiat Equivalent
      • Fiat currency conversion
      • Conversion of fiat currencies into cryptocurrency
      • Conversion of cryptocurrencies into fiat currencies
      • List of supported fiat currencies for conversion
    • Errors
  • âš¡Web3 processing API
    • Introduction
    • Web3 pool API
  • 🚀Quick start
    • Account registration
    • API set up
    • Setting up Webhooks
    • Payment confirmation
    • Managing withdrawals
    • Create a Manager role
    • Currency management
    • VRCS setup
    • Balance management
    • Transactions and address tracking
    • Notifications
    • Account security
    • Match Crypto Wallet Addresses
  • 🔄FAQ
Powered by GitBook
On this page
  • Claim
  • Add a balance to the specified wallet
  • Reduce balance to the specified purse
  • ContractSettings
  • Add a token to the contract whitelist
  • Info
  • Get information about the contract
  • List of supported tokens
  • Queue
  • Get request status
  • Withdraw
  • Withdrawing available funds
  • Schemas
  1. Web3 processing API

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

{
  "requestId": 0
}
{
  "errors": {
    "additionalProp1": [
      "string"
    ],
    "additionalProp2": [
      "string"
    ],
    "additionalProp3": [
      "string"
    ]
  }
}

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

{
  "requestId": 0
}
{
  "errors": {
    "additionalProp1": [
      "string"
    ],
    "additionalProp2": [
      "string"
    ],
    "additionalProp3": [
      "string"
    ]
  }
}

ContractSettings

Add a token to the contract whitelist

POST /ContractSettings/AddTokenToWhitelist

Request Body

Name
Type
Description

token*

String

Currency to add to whitelist

{
  "requestId": 0
}
{
  "errors": {
    "additionalProp1": [
      "string"
    ],
    "additionalProp2": [
      "string"
    ],
    "additionalProp3": [
      "string"
    ]
  }
}

Info

Get information about the contract

GET /Info/Contract

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

List of supported tokens

GET /Info/SupportedTokens

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

Queue

Get request status

GET /Queue/Status/{queueId}

Path Parameters

Name
Type
Description

queueId*

integer

queueId

{
  "error": "string",
  "status": "string"
}
{
  "errors": {
    "additionalProp1": [
      "string"
    ],
    "additionalProp2": [
      "string"
    ],
    "additionalProp3": [
      "string"
    ]
  }
}

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

{
  "requestId": 0
}
{
  "errors": {
    "additionalProp1": [
      "string"
    ],
    "additionalProp2": [
      "string"
    ],
    "additionalProp3": [
      "string"
    ]
  }
}

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

}

PreviousIntroductionNextQuick start

Last updated 3 months ago

âš¡