BPN OpenAPI
  1. Wallet
BPN OpenAPI
  • Getting Started
    • Introduction to BPN
    • Key Concepts & Terminology
    • Architecture Overview
  • Onboarding & Prerequisites
    • Product Demo
    • Sandbox & Test Environment
    • Signature Authentication Mechanism
  • Use Case
    • Transfer
    • Vault
    • On/Off Ramp
    • Compliance (Travel Rule Information Submission)
    • Fiat Collection(BRL PIX for example)
  • API Reference
    • Account Management
      • Inquiry Master VA Balance
      • Create Virtaul Account
      • Get Virtual Account Detail
      • List Virtual Account
      • Send Email Verify Code
      • Query bank info by account number
      • Payout via Virtual Account
      • Refund Virtual Account Order
      • Get Virtual Account Order Detail
      • List Virtual Account Orders
      • Submit Invoice
      • Get Invoice list Status
      • List Banks
      • Add Bank Account
      • List Bank Account
      • List RFI Sub Virtual Account
      • Get Sub Virtual Account RFI Template Info
      • Sub Virtual Account Submit RFI
    • Wallet
      • List Wallets
        GET
      • List Sub Account
        GET
      • Create Sub Account
        POST
      • Wallet Internal Transfer
        POST
      • Get Asset Balance
        GET
      • Get Deposit Address
        GET
      • Add Deposit Sender
        POST
      • Add Withdraw Whitelist
        POST
      • Delete Withdraw Whiltelist
        POST
      • Request Withdraw
        POST
      • Query Transaction History
        GET
    • FX
      • Inquery FX Rate
    • BPN Transactions
      • Get Stablecoin Quote
      • Create Stable Order
      • Get Order (Single) Detail
      • List Orders(Batch)
    • Reconciliation
      • Get Reconciliation Order List By Page
    • Crypto Payment Link
      • Create Payment Link
      • List Payment links
      • Get Curreny Network Config
    • Mock
      • Mock Virtual account Payin Order
  • Webhooks & Events
    • 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
  • Appendix
    • Enum
    • Virtual Account(VA) Support List & KYB requirement
  • Release Notes & Changelog
    • Version History
  • Schemas
    • walletBalance
    • walletAddress
    • transactionRecord
  1. Wallet

Add Withdraw Whitelist

POST
/v1/wallet/add-withdraw-whitelist
Before withdrawing, you must add it to the whitelist.

Request

Body Params application/json

Example
{
    "merchantAccountId": "ex_8f7a2c1d90",
    "addressType": "standard",
    "address": "0x4cbe58c50480...",
    "currency": "USDC",
    "network": "ETH",
    "memo": "",
    "correspondentDetail": {
        "firstName": "Amina",
        "lastName": "Khan",
        "birthday": "1990-04-12",
        "country": "AE",
        "toFromType": 1,
        "correspondentType": 1,
        "othersPleaseSpecify": ""
    },
    "sanction": false,
    "timestamp": "2025-08-08T14:23:11Z"
}

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 --request POST '/v1/wallet/add-withdraw-whitelist' \
--header 'Content-Type: application/json' \
--data-raw '{
    "merchantAccountId": "ex_8f7a2c1d90",
    "addressType": "standard",
    "address": "0x4cbe58c50480...",
    "currency": "USDC",
    "network": "ETH",
    "memo": "",
    "correspondentDetail": {
        "firstName": "Amina",
        "lastName": "Khan",
        "birthday": "1990-04-12",
        "country": "AE",
        "toFromType": 1,
        "correspondentType": 1,
        "othersPleaseSpecify": ""
    },
    "sanction": false,
    "timestamp": "2025-08-08T14:23:11Z"
}'

Responses

🟢200OK
application/json
Body

Example
{
    "status": 200,
    "code": null,
    "msg": "OK",
    "traceId": "Auto:bf288b9af2e04dff88e943f2dcaf2b03",
    "data": {
        "accountId": "acc1d1fkhwa",
        "status": "active",
        "merchantAccountId": "merchant_accwdwaf1e21"
    }
}
Previous
Add Deposit Sender
Next
Delete Withdraw Whiltelist
Built with