Save Sub-wallet Payer Profile

POST /v1/wallet/deposit-whitelist/wallets/{walletId}/profile

Stores the payer details that apply to every deposit into this sub-wallet.

When this is the right tool

Use it when one sub-wallet always receives from one payer, and that payer may send from more than one
source address. You store the payer once against the sub-wallet instead of registering every address, or
answering DEPOSIT_WHITELIST_REQUIRED for every new one.

A deposit arriving from an address this sub-wallet has not seen before still goes through review — but
nothing is asked of you, because the details are already on file. No DEPOSIT_WHITELIST_REQUIRED is raised.
You receive DEPOSIT_WHITELIST_CREDITED when the review passes, or DEPOSIT_WHITELIST_FAILED if it does
not. Once an address has been approved this way, later deposits from it skip the whitelist flow entirely,
exactly as if you had registered it up front.

Nothing address-shaped belongs in the body. No walletAddress, network, memo or symbol — the
whole point is that the payer is fixed and the address set is not. The platform pairs the stored payer with
whatever address the money actually came from.

Get the walletId from POST /v1/wallet/create/sub.

A stored profile can be replaced with PUT, but it cannot be switched off. Storing one does not re-submit source addresses that are already approved, and it does not clear deposits that are already init or rejected — handle those one at a time with POST /v1/wallet/deposit-whitelist/transactions/{transactionId}/submit.

Payer fields

`correspondentType`	Mandatory	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` — a `name` 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. Do not send countryInfo.

Errors

`code`	Meaning
`10000102`	Payer details incomplete for the given `correspondentType`
`10000103`	Field value not accepted, including an invalid `countryCode` or unknown `provider`
`10000105`	Duplicate request
`10000107`	Wallet invalid, or the sub-wallet has not been created

Guide: Wallet · Deposit whitelist

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",
    "walletLabel": "Payport Limited",
    "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

Success — entity payerFailure — sub-wallet does not existFailure — payer details incomplete

{
  "status": 200,
  "code": null,
  "msg": "OK",
  "traceId": "Auto:bf288b9af2e04dff88e943f2dcaf2b03",
  "data": {
    "walletId": "3095",
    "walletLabel": "Payport Limited",
    "walletType": "VASP",
    "provider": "Binance",
    "othersPleaseSpecify": null,
    "correspondentType": "ENTITY",
    "fullName": "Payport Limited",
    "firstName": null,
    "lastName": null,
    "birthday": null,
    "countryCode": "SG",
    "companyAddress": "Tampines Blk67, Singapore",
    "residentialAddress": null,
    "createTime": "2026-09-08T09:12:00Z",
    "updateTime": "2026-09-08T09:12:00Z"
  }
}

Save Sub-wallet Payer Profile