Sign in
latestOpenAPI 3.1.02026-08-163864115.7 MB

c363cb2feb95

Deposits

Create Deposit

Retrieve the deposit methods for an account, including crypto and bank transfer.

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.

network'ethereum' | 'polygon' | 'base' | 'solana' | 'null' nullable

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

Example request

{
  "amount": 50,
  "destination": {
    "account_id": "biz_xxxxxxxxxxxxxx",
    "address": "0x6f1c0a3d5b2e4f8a9c7d1e0b3a5f7c9d2e4b6a80",
    "network": "ethereum"
  },
  "metadata": {
    "invoice": "SHINE-1042"
  },
  "network": "ethereum"
}

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

Example response

{
  "account_id": "biz_xxxxxxxxxxxxxx",
  "amount": "50.00",
  "hosted_url": "https://whop.com/deposit/biz_xxxxxxxxxxxxxx/",
  "metadata": {
    "invoice": "SHINE-1042"
  },
  "methods": {
    "bank": {
      "currencies": [
        {
          "account_number": "8825310472",
          "currency": "USD",
          "deposit_bank_address": "2115 Linwood Avenue, Fort Lee, New Jersey 07024",
          "deposit_bank_name": "Cross River Bank",
          "deposit_beneficiary_name": "Shine Time Auto Detailing",
          "deposit_reference": "SHINE-1042",
          "rails": [
            "wire"
          ],
          "routing_number": "021214891",
          "swift_bic": "CRBAUS33"
        }
      ]
    },
    "crypto": [
      {
        "deposit_address": "soladdr",
        "icon_url": "https://whop.com/crypto/solana.svg",
        "name": "Solana",
        "supported_currencies": [
          {
            "icon_url": "https://whop.com/crypto/ethereum.svg",
            "name": "wETH"
          }
        ]
      }
    ]
  },
  "object": "deposit"
}