Skip to main content
POST
/
v1
/
sandbox
/
sub-wallet
/
deposit
Simulate Sub-wallet Deposit event
curl --request POST \
  --url https://api.openxswitch.com/v1/sandbox/sub-wallet/deposit \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "destination": "on_chain",
  "coin": "<string>",
  "amount": "<string>",
  "chain": "<string>",
  "status": "pending",
  "fromAddress": "<string>",
  "toAddress": "<string>",
  "fromWalletId": "<string>",
  "toWalletId": "<string>"
}
'
{
  "success": true,
  "data": {
    "depositId": "wd_001"
  }
}

Documentation Index

Fetch the complete documentation index at: https://docs.openxswitch.com/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json
destination
enum<string>
required

Destination type for the deposit

Available options:
on_chain,
internal_transfer
Example:

"on_chain"

coin
string
required

The token name. Only rechargeable currencies are accepted.

Refer to the Get Recharge Currencies endpoint for the list of supported currencies.

amount
string
required

Receive Amount

chain
string
required

The token name

status
enum<string>
required

Status of the deposit, supported status(pending, updated, success)

Available options:
success,
pending
Example:

"pending"

fromAddress
string

Source address for the deposit; required when the destination type is "on_chain"

toAddress
string

Destination address for the deposit; required when the destination type is "on_chain"

fromWalletId
string

The unique id of source the wallet/sub-wallet; required when the destination type is "internal_transfer"

toWalletId
string

The unique id of destination the wallet/sub-wallet; required when the destination type is "internal_transfer"

Response

success
boolean
required
Example:

true

data
object
required