Skip to main content
POST
/
deposits
Create Deposit
curl --request POST \
  --url https://{defaultHost}/deposits \
  --header 'Content-Type: application/json' \
  --data '
{
  "destination": "<string>",
  "amount": 123,
  "network": "<string>",
  "metadata": {}
}
'
{
  "object": "deposit",
  "account_id": "<string>",
  "hosted_url": "<string>",
  "methods": {
    "bank": {
      "currencies": [
        {
          "currency": "<string>",
          "account_number": "<string>",
          "routing_number": "<string>",
          "deposit_bank_name": "<string>",
          "deposit_beneficiary_name": "<string>",
          "deposit_reference": "<string>",
          "rails": [
            "<string>"
          ]
        }
      ]
    },
    "crypto": [
      {
        "name": "<string>",
        "deposit_address": "<string>",
        "icon_url": "<string>",
        "supported_currencies": [
          {
            "name": "<string>",
            "icon_url": "<string>"
          }
        ]
      }
    ]
  },
  "metadata": {},
  "amount": "<string>"
}

Body

application/json
destination
required

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

amount
number

Amount to prefill on hosted deposit page.

network
string | null

Destination network override.

metadata
object

Metadata to include with the deposit response.

Response

deposit created

object
enum<string>
required
Available options:
deposit
account_id
string | null
required

Account ID of the destination owner. Null for raw wallet address destinations.

hosted_url
string | null
required

URL of the hosted deposit page. Only present for business destinations.

methods
object
required

Available deposit methods for destination.

metadata
object
required

Metadata from the request.

amount
string

Requested deposit amount.