Deposits

Create Deposit

Resolves a deposit destination and returns the on-chain addresses that can fund it. No authentication is required; any business can be resolved by its account ID. A caller authenticated as a user can additionally resolve their own user account.

post/deposits

Headers

Idempotency-Keystring
Example:d9105228-4a08-46b1-8b91-42fed586d383

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

Request body

amountnumber

Amount to prefill on hosted deposit page.

metadataobject

Metadata to include with the deposit response.

networkstring nullable

Destination network override.

Response

deposit created

account_idstring nullable required

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

amountstring

Requested deposit amount.

hosted_urlstring nullable required

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

metadataobject required

Metadata from the request.

object'deposit' required

Changes