Ceffu OpenAPI Documentation Platform
  • ChangeLog
  • Getting Started
  • System Endpoints
  • Wallet Endpoints
  • Sub-Wallet Endpoints
    • Get Sub-Wallet List (V2)GET
    • Get Sub-Wallet Asset DetailsGET
    • Get Sub-Wallet Asset SummaryGET
    • Get Sub-Wallet Deposit AddressGET
    • Get Deposit History under Sub-WalletGET
    • Get Deposit Address List under Prime Wallet GET
    • Get Sub-Wallet Deposit History By Prime WalletGET
    • Get Transfer History between Sub-Wallet and Prime WalletGET
    • Get Transaction Details of Prime Wallet Internal TransferGET
    • Create Sub-WalletPOST
    • Update Sub-Wallet DetailsPOST
    • Transfer between Sub Wallet and Prime WalletPOST
  • MirrorX Endpoints
  • Webhook
  • Archive
logoPowered by Apifox
  1. Sub-Wallet Endpoints

Update Sub-Wallet Details

POST/open-api/v1/subwallet/updateSubWallet

This method allows to update sub wallet attributes.

API Key permission group : Enable Wallet Management

Request

Header Params
open-apikey
string 
required

OpenAPI key string

signature
string 
required

Signature of the request

Body Params application/json
autoCollection
enum<integer> 
optional

Enable auto sweeping to parent wallet

Allowed values:
01
requestId
integer <int64>
optional

Client provided Unique Identifier

Example:
1640995200000
timestamp
integer <int64>
required

Current Timestamp in millisecond

Example:
1640995200000
walletId
string 
required

Wallet id

walletName
string 
optional

Wallet Name (Max 20 Characters)

Example:
Shared Wallet Example
Example
{
  "autoCollection": 0,
  "requestId": 1640995200000,
  "timestamp": 1640995200000,
  "walletId": "string",
  "walletName": "Shared Wallet Example"
}

Request samples

Responses

The operation succeeded(200)
Business error(200)
The client request is invalid(400)
Authentication failed (e.g., invalid token specified by the Authorization header)(401)
Authentication failed, but the operation is not allowed(403)
Requested resource does not exist(404)
Client request rate exceeded the limit(429)
System error(500)
The operation succeeded
HTTP Code: 200
Content Type : JSONapplication/json
Data Schema
data
optional

response data, maybe null

Any of
walletId
integer 
required
walletName
string  | null 
required
walletType
enum<integer> 
WalletType
required
Allowed values:
1011122021
autoCollection
required
parentWalletId
null 
required
code
string 
required

'000000' indicates success, while any others indicate failure.

message
string 
required

When the code is '000000' (success), it represents the details of the response. Otherwise, it represents the details of the error.

Example
{
  "data": {
    "walletId": 377611257643147260,
    "walletName": null,
    "walletType": 21,
    "autoCollection": 1,
    "parentWalletId": null
  },
  "code": "000000",
  "message": "Success"
}
Last modified: a year ago