Cregis Developer Docs
POST/api/v1/collection

Create Fund Collection

Collect funds from project sub-addresses to the specified wallet address. to_address must be a wallet address of the current team. Disabled addresses cannot be used as collection sources. If amount is omitted, the full balance of the address is collected by default.

Rate limit: 1000 requests/minute

Request

Request Body

required

application/json
  • noncestringrequired

    6-character random string.

  • timestampinteger<int64>required

    Timestamp.

  • signstringrequired

    Signature string.

  • pidinteger<int64>required

    Project ID.

  • currencystringrequired

    Token identifier to query, in chain_id@token_id format.

  • from_addressstringrequired

    Project address to collect from. Disabled addresses cannot be collected from.

  • to_addressstringrequired

    Collection recipient address. It must be an address in the wallet bound to the current project address.

  • amountstring

    Collection amount. If omitted, all funds at the address are collected by default.

Responses

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

    Response code.

  • msgstring

    Response message.

  • dataobject

    Response data.

    • cidinteger<int64>

      Cregis system transaction ID.