Skip to main content

​
API URL

POST /api/v2/payout

​
Request

​
Request Parameters

NameTypeRequiredDescription
pidinteger(int64)YesWaaS Project ID. Navigate to: “Cregis > WaaS > Your Project > Settings > Developer”
wallet_idinteger(int64)NoThe specific payout wallet ID. If empty, use project’s default payout wallet address，You may refer to project creation
currencystringYesToken to withdraw (chain_id and token_id)
from_addressstringNoSender address. If empty, use project’s default payout wallet address
to_addressstringYesRecipient address. Validate address before withdrawal
amountstringYesWithdrawal amount
callback_urlstringNoCallback URL. WaaS will POST notifications here when transaction is processed,You may refer to Payout notify
third_party_idstringYesUnique business ID generated by your system for tracking
remarkstringNoTransaction description (max 256 characters)
memostringNoOn-chain memo/tag (only for Ton, Xrp)
noncestringYes6-character random string
timestampinteger(int64)YesCurrent timestamp (milliseconds)
signstringYesDigital signature to prevent tampering
Request Example
{
  "pid": 1382528827416576,
  "wallet_id": 11434198045401088,
  "currency": "144@144",
  "from_address": "rhAZ673nG6fSXovPAkw3EcrhKyWwXducoi",
  "to_address": "rn5Jyu5J6PG64543KdGvS25rQBYFQo7GLc",
  "amount": "1.1",
  "remark": "payout",
  "memo": "123",
  "third_party_id": "c9231e604da54469a735af3f449c880f",
  "callback_url": "http://xxx.com/payout/callback",
  "nonce": "hwlkk6",
  "timestamp": 1688004243314,
  "sign": "d6eef2de79e39f434a38efb910213ba6"
}

​
Response

​
Response Result

NameTypeDescription
codestringResponse Code
msgstringResponse Message
dataobjectResponse Data Object

​
Response data object

NameTypeDescription
cidinteger(int64)System Sequence Number
Response Example
{
  "code": "00000",
  "msg": "ok",
  "data": {
    "cid": 1382688606330880
  }
}