1. Deposit Whitelist
BPN OpenAPI
  • Get started
    • Introduction to BPN
    • Introduction to API
    • Architecture Overview
    • Authentication
    • Environments
    • Response envelope
    • Idempotency
  • Guides
    • Virtual Account
      • Virtual Account Overview
      • VA · Payin
      • VA · Statuses
      • VA · Currencies & limits
      • VA · Payout
      • VA · RFI
    • Wallet
      • Wallet · Withdraw
      • Wallet · Transfer
      • Wallet · Assets & limits
      • Wallet · Deposit whitelist
      • Wallet Overview
      • Wallet · Deposit
      • Wallet · Statuses
    • Convert
      • Convert Overview
      • Convert · Quote & submit
      • Convert · Business types
      • Convert · Pairs & limits
      • Convert · Statuses
  • API Reference
    • Virtual Account
      • Virtual Account field notes
      • Inquiry Master VA Balance
      • List Primary Virtual Accounts
      • Create Virtual Account
      • Get Virtual Account Detail
      • List Virtual Account
      • List Virtual Account Orders
      • Get Virtual Account Order Detail
      • Refund Virtual Account Order
      • List RFI Sub Virtual Account
      • Get Sub Virtual Account RFI Template Info
      • Sub Virtual Account Submit RFI
      • Add Bank Account
      • List Bank Account
      • List Banks
      • Payout via Virtual Account
      • Send Email Verify Code
    • Wallet
      • Wallet field notes
      • Deposit Whitelist
        • Get Deposit Whitelist Options
          GET
        • Register Deposit Source Address
          POST
        • List Deposit Source Addresses
          GET
        • Get Deposit Source Address
          GET
        • Disable Deposit Source Address
          POST
        • Submit Payer Details for a Received Deposit
          POST
        • Save Sub-wallet Payer Profile
          POST
        • Update Sub-wallet Payer Profile
          PUT
        • Get Sub-wallet Payer Profile
          GET
      • Get Asset Balance
        GET
      • Get Deposit Address
        GET
      • Add Deposit Sender
        POST
      • Add Withdraw Whitelist
        POST
      • Delete Withdraw Whiltelist
        POST
      • Request Withdraw
        POST
      • Query Wallet Internal Transfer Detail
        GET
      • List Wallet Internal Transfer order
        GET
      • Wallet Internal Transfer
        POST
      • Create Sub Account
        POST
      • Query Transaction History
        GET
      • List Wallets
        GET
      • List Sub Account
        GET
      • Get Transaction Detail
        GET
    • Payment Link
      • Abnormal fund
        • Abnormal funds
        • Matchable Payment links
        • Link Order(Abnormal fund)
        • Submit to platform
      • Create Payment Link
      • List Payment links
      • Get Curreny Network Config
    • Convert
      • Convert field notes
      • Inquery FX Rate
      • Get Stablecoin Quote
      • Create Stable Order
      • Get Order (Single) Detail
      • List Orders(Batch)
    • KYB
      • Share KYB/KYC Info For Sub User
      • Get KYB Sub User Status
    • Reconciliation
      • Get Reconciliation Order List By Page
    • External Provider
      • FE: Create stablecoin collection sub-account link
      • FE: Deposit Travel Rule
      • External Provider · Deposit whitelist
      • Create stablecoin collection sub-account link
      • Get sub wallet account
      • List sub wallet accounts
      • Change sub wallet status
      • Query stablecoin collection order list
      • Query stablecoin collection order status
      • Get quote
      • Accept stablecoin collection order
      • Reject stablecoin collection order
      • Query USD balance
      • USD Payout (withdrawal)
      • Query USD Payout order status
      • Query USD Payout order list
    • Mock
      • Mock Virtual account Payin Order
      • Mock wallet deposit transaction
      • Mock Payin Order Refund
      • Mock Payout Order Update Status
    • Pay Session
      • Request Pay Session
  • Webhooks
    • Webhooks Overview
    • KYB notifications
    • Event catalogue
    • Resend Fail Webhook
    • Open Virtual Account Status
    • Virtual Account Payment Status
    • Virtual Account Invoice update
    • Transaction Status Notification
    • KYB Status Notification
    • Deposit Sender Detail Required
    • Abnormal Fund Notification
    • WALLET_TRANSFER_ORDER_UPDATED
    • Sub Virtual Account RFI Required
    • Sub Wallet Update
    • wallet address whitelist Update
    • Crypto Deposit Order Notification
    • Collect Order Updated
    • Usd Payout Order Updated
    • onboard result
    • partner order status
    • PaymentLink Notification
    • Deposit Whitelist Notification
  • Partner Flow
    • inquiry supported currency
    • KYC/KYB Sharing
    • inquiry onboard status
    • get price
    • Create order
    • order list
    • inquiry single order
    • get user deposit address
    • get payment instruction
    • sync fund notification
    • daily settlement records
  • Appendix
    • Enums quick reference
    • Enum
    • Virtual Account(VA) Support List & KYB requirement
  • Release Notes & Changelog
  • Errors
    • Error codes catalogue
  • Change Log
    • 2026-09-21 Virtual Account independent refund orders
    • Wallet deposit source-address whitelist
  1. Deposit Whitelist

Get Sub-wallet Payer Profile

Designing
GET
/v1/wallet/deposit-whitelist/wallets/{walletId}/profile

Get Sub-wallet Payer Profile#

GET /v1/wallet/deposit-whitelist/wallets/{walletId}/profile
Reads the payer details stored against this sub-wallet.
data is null when nothing has been stored yet. That is a normal 200, not an error — do not treat it as a failure. It simply means deposits into this sub-wallet still go through the ordinary flow: DEPOSIT_WHITELIST_REQUIRED, then POST /v1/wallet/deposit-whitelist/transactions/{transactionId}/submit.

Errors#

codeMeaning
10000107Wallet 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: ********************
or
Path Params

Request Code Samples

Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
Request Request Example
Shell
JavaScript
Java
Swift
curl --location '/v1/wallet/deposit-whitelist/wallets/3095/profile' \
--header 'API-KEY: <api-key>' \
--header 'API-SIGNATURE: <api-key>' \
--header 'API-TIMESTAMP: <api-key>'

Responses

🟢200OK
application/json
Bodyapplication/json

Examples
{
  "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"
  }
}
Previous
Update Sub-wallet Payer Profile
Next
Get Asset Balance
Built with