Ceffu OpenAPI Documentation Platform
  • ChangeLog
  • Getting Started
  • System Endpoints
  • Wallet Endpoints
    • Get Prime Wallet supported coins listGET
    • Get Qualified Wallet supported coins listGET
    • Get Cosign Wallet supported coins listGET
    • Get Wallet ListGET
    • Get Asset DetailsGET
    • Get Wallet Asset SummaryGET
    • Get Deposit AddressGET
    • Get Deposit HistoryGET
    • Get Deposit Detail (V2)GET
    • Get Withdrawal Fee (estimated)GET
    • Get Withdrawal History (V2)GET
    • Get Withdrawal Details (V2)GET
    • Get Whitelisted Address ListGET
    • Get Correspondent’s OptionsGET
    • Create WalletPOST
    • Update Wallet DetailsPOST
    • Withdrawal (V2)POST
    • Transaction History ListPOST
    • Add/Edit Whitelisted AddressPOST
  • Sub-Wallet Endpoints
  • MirrorX Endpoints
  • Webhook
  • Archive
logoPowered by Apifox
  1. Wallet Endpoints

Get Whitelisted Address List

GET/open-api/v1/wallet/pageWhitelist

This method allows you to get a whitelisted address list.

API Key permission group : Enable Enquiry

Request

Query Params
pageLimit
integer 
optional

Page limit, min: 1, max: 500

Example:
25
pageNo
integer 
optional

Page number, min: 1

Example:
1
addressType
enum<integer> 
optional

Address type, 1 (standard) or 2 (universal)

Allowed values:
12
Example:
1
address
string 
optional

Blockchain address

label
string 
optional

Custom label of address on system

symbol
string 
optional

Coin symbol

Example:
ETH
network
string 
optional

Network symbol

Example:
ETH
memo
string 
optional

Address memo

whitelistId
string 
optional

Whitelisted address id on system

startTime
integer 
optional

Start time (timestamp in milliseconds)

Example:
1640995200000
endTime
integer 
optional

End time (timestamp in milliseconds)

Example:
1640995200000
timestamp
integer 
required

Current timestamp in millisecond

Example:
1640995200000

Request samples

Responses

OK(200)
HTTP Code: 200
Content Type : JSONapplication/json
Data Schema
data
array[object (WhitelistAddress) {14}] 
required
whitelistId
string 
required

Whitelisted address id on system

addressType
object 
required

Address type, 1 (standard) or 2 (universal)

address
string 
required

Blockchain address

label
string 
required

Custom label of address on system

symbol
string 
required

Coin symbol

network
string 
required

Network symbol

protocol
string 
required

Blockchain protocol

memo
string  | null 
optional

Address memo

institutionId
string 
required

Institution ID

currentAddressStatus
enum<integer> 
required
Allowed values:
10203099
addressStatus
enum<integer> 
required
Allowed values:
10203099
correspondentDetail
optional

Configuration options of the whitelisted address

createTime
number 
required
updateTime
number 
required
code
string 
required
message
string 
required
Example
{
  "data": [
    {
      "whitelistId": "123456789",
      "symbol": "BTC",
      "label": "Satoshi",
      "address": "1A1zP1eP5QGefi2DMPTfTL5SLmv7DivfNa",
      "memo": "",
      "network": "BTC",
      "protocol": "null",
      "institutionId": "123456789",
      "createTime": 1743436800000,
      "updateTime": 1743436800000,
      "currentAddressStatus": 30,
      "addressStatus": null,
      "addressType": 1,
      "correspondentDetail": null
    }
  ]
}
Last modified: 6 days ago