Submit Payer Details for a Received Deposit

POST /v1/wallet/deposit-whitelist/transactions/{transactionId}/submit

The payer's source address must be registered and reviewed before the deposit can reach the
available balance of the receiving wallet. See the guide: Guides · Wallet · Deposit whitelist.

Supplies payer details for a deposit that already arrived. Use it when you did not know the payer address in
advance.

Call it for transactions whose whiteListStatus is init (never submitted) or rejected (resubmit
required). Find them with GET /v1/wallet/transaction/list?whiteListStatus=init / ...=rejected.

Changed: GET /v1/wallet/deposit-whitelist/pending-list was removed. Use
GET /v1/wallet/transaction/list with the whiteListStatus filter instead.

Never send walletAddress, network, memo, symbol or txHash. Those come from the on-chain
transaction; supplying or altering them is rejected with 10000106.

Several pending deposits from the same source address can be covered in one call via transactionIds. The
path transactionId must appear in that array.

Reading the response

status 200 means the submission was accepted, not that the whitelist passed — the channel may have
rejected it on the spot and still answer 200. Read whiteListStatus and failMessage; never the outer
status alone.

`whiteListStatus`	What it means	What to do
`pending`	Submitted, under review	Wait for the order webhook, or poll
`approved`	Cleared. The funds enter the available balance of the receiving wallet; the order may still be `PROCESSING` while auto-collection runs	Nothing
`rejected`	Rejected. The funds stay in the unavailable balance	Fix what `failMessage` names, then submit again
`init`	Rare — the gate did not move	Poll before resubmitting

failMessage carries a reason only when whiteListStatus is rejected; otherwise it is an empty string,
never null. A gateway rejection reads like G20011: Invalid IP address — the channel code and its message.
When the review is rejected without a reason the platform falls back to whitelist rejected.

When one call covers several transactions, whiteListStatus is pending unless one of them came back
rejected, in which case it is rejected and failMessage carries the first reason found. Read the
per-transaction outcome with GET /v1/wallet/deposit-whitelist/cases/{transactionId}.

A parameter or business failure is a different shape: status 500, an outer code and msg, and no
data at all — so there is no data.failMessage to read. Incomplete payer details give 10000102,
supplying the source address gives 10000106, an unknown transaction gives 10000100.

None of this is announced by a webhook of its own. The order webhook you already consume carries
whiteListStatus: COLLECT_ORDER_UPDATED for a collection order, DEPOSIT_ORDER_NOTIFICATION for a plain
wallet deposit. A fresh rejected there is your signal to submit again.

Send the Idempotency-Key header. Do not edit the payer details and immediately retry after 10000104;
poll GET /v1/wallet/transaction/detail first.

Payer field rules

`correspondentType`	Mandatory fields	Must NOT be sent
`ENTITY`	`fullName`, `countryCode`, `companyAddress`	`firstName`, `lastName`, `birthday`, `residentialAddress`
`INDIVIDUAL`	`firstName`, `lastName`, `birthday` (`yyyy-MM-dd`), `countryCode`, `residentialAddress`	`fullName`

`walletType`	Also mandatory
`VASP`	`provider` — value must come from `GET /v1/wallet/deposit-whitelist/options`
`OTHERS`	`othersPleaseSpecify` (max 255 characters)
`SELF_HOSTED`	—

countryCode is an ISO 3166-1 alpha-2 code such as SG. countryInfo was withdrawn — the platform derives
the country name server-side. Sending it is unnecessary.

Error codes

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

`code`	Meaning
`10000100`	Transaction not found, or it does not belong to the caller
`10000101`	Deposit-whitelist review already completed for this deposit
`10000102`	Payer details incomplete
`10000103`	Field value not accepted, including an invalid `countryCode` or an unknown `provider`
`10000104`	Cannot submit right now — poll the status instead of editing and retrying immediately
`10000105`	Duplicate request
`10000106`	Source address cannot be supplied or changed when submitting for a received deposit

Request

Authorization

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: ********************

Path Params

Header Params

Body Params application/json

Example

{
    "requestId": "b0f4c6a2-7d51-4c0e-9a2f-6f7c1e2d3b40",
    "transactionIds": [
        "20573580428712136704"
    ],
    "walletLabel": "Payport Limited",
    "addressType": "STANDARD",
    "walletType": "VASP",
    "provider": "Binance",
    "othersPleaseSpecify": "",
    "correspondentType": "ENTITY",
    "fullName": "Payport Limited",
    "firstName": "Alex",
    "lastName": "Tan",
    "birthday": "1990-01-31",
    "countryCode": "SG",
    "companyAddress": "Tampines Blk67, Singapore",
    "residentialAddress": "12 Bedok North Ave 4, Singapore"
}

Request Code Samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

Responses

🟢200OK

application/json

Bodyapplication/json

Examples

Accepted — under reviewAccepted — rejected on the spotFailure — source address supplied

{
  "status": 200,
  "code": null,
  "msg": "OK",
  "traceId": "Auto:bf288b9af2e04dff88e943f2dcaf2b03",
  "data": {
    "requestNo": "b0f4c6a2-7d51-4c0e-9a2f-6f7c1e2d3b40",
    "status": "PROCESSING",
    "whiteListStatus": "pending",
    "failMessage": "",
    "transactionIds": [
      "20573580428712136704"
    ]
  }
}

Submit Payer Details for a Received Deposit