Skip to main content
POST
JavaScript

Authorizations

Authorization
string
header
required

An Account API key, account-scoped JWT, App API key, or user OAuth token. Prepend the key or token with Bearer, for example Bearer ***************************.

Headers

Idempotency-Key
string

A unique key that makes this request safe to retry. See Idempotent requests.

Maximum string length: 255
Example:

"d9105228-4a08-46b1-8b91-42fed586d383"

Body

application/json
destination
required

Destination account ID or wallet address. Object form is supported for compatibility. Any business resolves by its account ID without authentication; a user account resolves only for that same authenticated user.

amount
number

Amount to prefill on hosted deposit page.

metadata
object

Metadata to include with the deposit response.

network
enum<string> | null

Destination network override. Defaults to the destination wallet's own network.

Available options:
ethereum,
polygon,
base,
solana,
null

Response

deposit created

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.

metadata
object
required

Metadata from the request.

methods
object
required

Available deposit methods for destination.

object
enum<string>
required
Available options:
deposit
amount
string

Requested deposit amount.