Skip to main content

​
API URL

POST /api/v1/payout

​
Request

​
Request Parameters

NameTypeRequiredDescription
pidinteger(int64)YesProject ID
currencystringYesCurrency Identifier
addressstringYesAddress
amountstringYesAmount
callback_urlstringNoCallback URL, If funds are successfully received, refer to Payout notify section for callback details.
third_party_idstringYesCaller Customized ID
remarkstringNoRemark
memostringNomemo or tag on blockchain，Only support Ton and Xrp
noncestringYes6-digit random string
timestampinteger(int64)YesTimestamp
signstringYesSignature
Request Example
{
  "pid": 1382528827416576,
  "currency": "195@195",
  "address": "TXsmKpEuW7qWnXzJLGP9eDLvWPR2GRn1FS",
  "amount": "1.1",
  "remark": "payout",
  "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
  }
}