Skip to main content
POST
/
deposits
Create Deposit
curl --request POST \
  --url https://{defaultHost}/deposits \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "amount": 123,
  "destination": "<string>",
  "network": "<string>",
  "metadata": {}
}
'
{
  "object": "deposit",
  "amount": "<string>",
  "destination": {
    "address": "<string>",
    "network": "<string>",
    "currency": "<string>",
    "account_id": "<string>"
  },
  "deposit_address": {
    "evm": "<string>",
    "solana": "<string>"
  },
  "hosted_url": "<string>",
  "metadata": {}
}

Authorizations

Authorization
string
header
required

A company API key, company scoped JWT, app API key, or user OAuth token.

Body

application/json
amount
number
required

Amount to deposit.

destination
required

Destination account ID or wallet address. Object form is supported for compatibility.

network
string | null

Optional destination network override.

metadata
object

Arbitrary metadata echoed in the response.

Response

deposit created

object
enum<string>
required
Available options:
deposit
amount
string
required
destination
object
required
deposit_address
object
required
hosted_url
string | null
required
metadata
object
required