- Getting Started
- Onboarding & Prerequisites
- Use Case
- API Reference
- KYB
- Account Management
- Inquiry Master VA Balance
- List Primary Virtual Accounts
- 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
- FX
- BPN Transactions
- Reconciliation
- Crypto Payment Link
- External Provider
- FE: Create stablecoin collection sub-account link
- 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
- Pay Session
- 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
- Abnormal Fund Notification
- WALLET_TRANSFER_ORDER_UPDATED
- Sub Virtual Account RFI Required
- Sub Wallet Update
- wallet address whitelist Copy
- Crypto Deposit Order Notification
- Collect Order Updated
- Usd Payout Order Updated
- onboard result
- partner order status
- Partner Flow
- Appendix
- Release Notes & Changelog
get user deposit address
GET
/api/v1/users/deposit-address
Request
Authorization
API Key
Add parameter in header
X-BPN-API-KEY
Example:
X-BPN-API-KEY: ********************API Key
Add parameter in header
X-BPN-SIGNATURE
Example:
X-BPN-SIGNATURE: ********************API Key
Add parameter in header
X-BPN-TIMESTAMP
Example:
X-BPN-TIMESTAMP: ********************or
Query 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 '/api/v1/users/deposit-address?partner_user_id=undefined&asset=undefined&network=undefined' \
--header 'X-BPN-API-KEY: <api-key>' \
--header 'X-BPN-SIGNATURE: <api-key>' \
--header 'X-BPN-TIMESTAMP: <api-key>'Responses
🟢200
application/json
Bodyapplication/json
Example
{
"code": "SUCCESS",
"message": "ok",
"data": {
"partner_user_id": "string",
"bpn_user_id": "string",
"asset": "string",
"network": "string",
"address": "string",
"memo": "string",
"address_status": "string",
"allocated_at": "2019-08-24T14:15:22.123Z",
"display_note": "string"
},
"trace_id": "b7c1f0c2-3f0a-4e9b-9c2a-2b1d9d6f0a11"
}