Query Withdrawal Whitelist Configuration

Query the whitelist configuration of the withdrawal wallet.

Request

VIEW

GET /v1/sofa/wallets/{WALLET_ID}/sender/whitelist/config

Response Body

Field Type Description
effective_latency int64 The effective latency of the whitelist entry, 0 means the whitelist entry will take effect immediately.
whitelist_check boolean Indicate whether the withdrawal wallet has enabled whitelist checking.

Error Code

HTTP Code Error Code Error Message Description
403 - Forbidden. Invalid wallet ID - No wallet ID found
403 - Forbidden. Header not found - Missing X-API-CODE, X-CHECKSUM header or query param t
403 - Forbidden. Invalid timestamp - The timestamp t is not in the valid time range
403 - Forbidden. Invalid checksum - The request is considered a replay request
403 - Forbidden. Invalid API code - X-API-CODE header contains invalid API code
403 - Invalid API code for wallet {WALLET_ID} - The API code mismatched
403 - Forbidden. Checksum unmatch - X-CHECKSUM header contains wrong checksum
403 - Forbidden. Call too frequently ({THROTTLING_COUNT} calls/minute) - Send requests too frequently
403 385 API Secret not valid - Invalid API code permission
404 304 Wallet ID invalid - The wallet is not allowed to perform this request or the {ORDER_ID} is not found

Sample Request

API

/v1/sofa/wallets/55743/sender/whitelist/config

Response Body

{
  "effective_latency": 0,
  "whitelist_check": true
}

Sample cURL Command

curl http://localhost:8889/v1/mock/wallets/{WALLET_ID}/sender/whitelist/config