Skip to main content
POST
TypeScript
Crypto deposits require a $10 minimum.

Authorizations

Authorization
string
header
required

An Account API key, an App API key, an account access token, an account-scoped user token, or a user OAuth token. Prepend the key or token with Bearer, for example Bearer ***************************. See Auth & API keys for how to get each one.

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"

Api-Version-Date
string

Pins the request to a dated API version.

Example:

"2026-10-29-8"

Body

application/json
destination
string
required

Account ID to fund, biz_ or user_. Any business resolves without authentication; a user account resolves only for that same authenticated user.

Example:

"biz_xxxxxxxxxxxxxx"

amount
number

Amount to prefill on hosted deposit page. Crypto deposits require a $10 minimum. With payment_method_id, the amount in USD to charge, and required.

Example:

50

metadata
object | null

Custom metadata to attach to the payment the charge creates. Ignored unless payment_method_id is provided.

Example:
origin_bic
string

SWIFT/BIC of the bank the funds are sent from, 8 or 11 characters. Fills each bank currency's swift_bic with the intermediary bank to route the wire through.

Example:

"DEUTDEFFXXX"

payment_method_id
string

A saved payment method of the business to charge for amount, prefixed payt_. Save one with Create setup intent and owner_id set to the account. Only for a biz_ destination, and requires authentication with the payment:charge scope. A declined charge fails the request with 400.

Example:

"payt_xxxxxxxxxxxxxx"

Response

deposit created

account_id
string | null
required

Account ID of the destination owner.

Example:

"biz_xxxxxxxxxxxxxx"

hosted_url
string | null
required

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

Example:

"https://whop.com/deposit/biz_xxxxxxxxxxxxxx/"

methods
object
required

Available deposit methods for destination.

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

"deposit"

amount
string

Requested deposit amount.

Example:

"50.00"