Cregis Developer Docs
POST/api/v1/payout

Create Wallet Payout

Create a payout request to withdraw assets from the wallet address.

If payout external verification is enabled for the project, Cregis first sends a Payout External Verification Notification to the external verification URL configured in the project, and then continues or stops processing based on the returned ok or deny response.

Rate limit: 1000 requests/minute

Request

Request Body

required

application/json
  • noncestringrequired

    6-character random string.

  • timestampinteger<int64>required

    Timestamp.

  • signstringrequired

    Signature.

  • pidinteger<int64>required

    Project ID.

  • currencystringrequired

    Currency identifier.

  • addressstringrequired

    Payout address.

  • amountstringrequired

    Amount.

  • third_party_idstringrequired

    Caller business ID.

  • callback_urlstring

    Callback URL. When this payout is processed, Cregis sends a callback notification to the corresponding callback_url. For callback details, see Payout Notification.

  • remarkstring

    Remark.

  • memostring

    On-chain memo/tag information. Supported only by TON and XRP.

Responses

200Success. Returns the Cregis system transaction ID.
application/json
  • codestring

    Response code.

  • msgstring

    Response message.

  • dataobject

    Response data.

    • cidinteger<int64>

      System serial number.