Get Deposit Whitelist Case

GET /v1/wallet/deposit-whitelist/cases/{transactionId}

The whitelist gate of one deposit, in a single call: the gate's own status, the receiving wallet the deposit landed in, and the payer's Travel Rule record behind it.

Reach for this when you need the payer side of a gated deposit — who the payer is, which source address was used, and why a submission was sent back. GET /v1/wallet/transaction/detail gives you the transaction and its whiteListStatus, but not the payer's whitelist record.

transactionId is the deposit transaction id. On a collection order it is the same value as the order's orderId — data.orderId on COLLECT_ORDER_UPDATED, or orderId on GET /v2/stable/collect/order-status.

What comes back

Field	Meaning
`orderStatus`	`PROCESSING` while the deposit is in flight, `SUCCESS` once it completes
`whiteListStatus`	`init` / `pending` / `approved` / `rejected` — the gate itself
`creditStatus`	`PENDING` / `CREDITED` / `BLOCKED` — whether the funds reached the available balance
`failMessage`	Gate-side reason, populated when `whiteListStatus` is `rejected`
`fromAddress`, `network`, `memo`, `amount`, `currency`, `txHash`	The deposit itself. `fromAddress`, `network` and `memo` are frozen and cannot be changed by a submission
`walletId`, `walletName`, `walletType`, `autoCollection`, `walletStatus`	The receiving sub-wallet
`payerWhitelist`	The payer's Travel Rule record. `null` when no payer details have been submitted or matched yet
`completeTime`	Completion time of the deposit; `null` until it reaches a final state

payerWhitelist.status is the same three-value address status used everywhere else — PROCESSING under review, ACTIVE approved, FAILED rejected — and payerWhitelist.failMessage carries the address-side reason. Correcting a rejected address is always disable + register again, never an edit in place.

Error codes

Business failures return status 500 and an 8-digit code (WalletErrorCode).

`code`	Meaning
`10000046`	`transactionId` is missing, or the caller's identity could not be resolved from the authentication headers.
`10000100`	No whitelist case exists for this transaction, or it does not belong to the caller. A deposit that never went through the whitelist gate has no case — read that one with `GET /v1/wallet/transaction/detail` instead.

API Key

Add parameter in header

API-KEY

Example:

API-KEY: ********************

API Key

Add parameter in header

API-SIGNATURE

Example:

API-SIGNATURE: ********************

API Key

Add parameter in header

API-TIMESTAMP

Example:

API-TIMESTAMP: ********************

Request Code Samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

Responses

🟢200OK

application/json

Bodyapplication/json

Example

{
  "status": 200,
  "msg": "OK",
  "code": null,
  "traceId": "Auto:bf288b9af2e04dff88e943f2dcaf2b03",
  "data": {
    "transactionId": "20573580428712136704",
    "orderStatus": "PROCESSING",
    "whiteListStatus": "rejected",
    "creditStatus": "PENDING",
    "failMessage": "whitelist rejected",
    "fromAddress": "0x3a1F8C4e2b6C8c9D7fE2B8b5a1d3C9A0bE12F345",
    "network": "BSC",
    "memo": "",
    "amount": "100.00",
    "currency": "USDC",
    "txHash": "0x9c1a...f3",
    "walletId": 123,
    "walletName": "Sub Wallet A",
    "walletType": "SUB",
    "autoCollection": true,
    "walletStatus": "ACTIVE",
    "completeTime": null,
    "payerWhitelist": {
      "id": 1001,
      "status": "FAILED",
      "walletLabel": "Payport Limited",
      "network": "BSC",
      "walletAddress": "0x3a1F8C4e2b6C8c9D7fE2B8b5a1d3C9A0bE12F345",
      "memo": "",
      "symbol": "USDC",
      "addressType": "STANDARD",
      "walletType": "VASP",
      "provider": "Binance",
      "correspondentType": "ENTITY",
      "fullName": "Payport Limited",
      "countryCode": "SG",
      "countryInfo": "Singapore",
      "companyAddress": "Tampines Blk67, Singapore",
      "failMessage": "whitelist rejected"
    }
  }
}

Get Deposit Whitelist Case