Sign in
Deposits

Create Deposit

Retrieve the deposit methods for an account, including crypto and bank transfer. Bitcoin deposits are converted by Relay directly to USDT on Plasma in the destination account's wallet. Crypto deposits require a $10 minimum.

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. Crypto deposits require a $10 minimum.

destinationstring required

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

Example request

{
  "amount": 50,
  "destination": "biz_xxxxxxxxxxxxxx"
}

Response

deposit created

account_idstring nullable required

Account ID of the destination owner.

amountstring

Requested deposit amount.

hosted_urlstring nullable required

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

object'deposit' required

Example response

{
  "account_id": "biz_xxxxxxxxxxxxxx",
  "amount": "50.00",
  "hosted_url": "https://whop.com/deposit/biz_xxxxxxxxxxxxxx/",
  "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/_static/images/crypto/solana.svg",
        "name": "Solana",
        "supported_currencies": [
          {
            "icon_url": "https://whop.com/_static/images/crypto/pyusd.svg",
            "name": "PYUSD"
          }
        ]
      }
    ]
  },
  "object": "deposit"
}

Changes

Changed in 7 of the 74 revisions of this API.53815

  • 2d59d2cf94cf2See the full diff
    • ●

      added the new BTC enum value to the ///// response property for the response status

      response-property-enum-value-added

    • ●

      added the new Bitcoin enum value to the /// response property for the response status

      response-property-enum-value-added

  • 697924df40d132See the full diff
    • ▲

      removed subschema #1 subschema #2 from the request property oneOf list

      request-property-one-of-removed

    • ▲

      the request property type changed from no type to string

      request-property-type-changed

    • ▲

      removed the required property from the response with the status

      response-required-property-removed

    • ●

      removed the request property

      request-property-removed

    • ●

      removed the request property

      request-property-removed

    This revision also has 9 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • ae20b30817de1See the full diff
    • ○

      added the non-success response with the status

      response-non-success-status-added

  • f1020c3ecda41See the full diff
    • ○

      added the optional property / to the response with the status

      response-optional-property-added

    This revision also has 9 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • bdd0e2c70d581See the full diff
    • ○

      the endpoint scheme security bearerAuth was added to the API

      api-security-added

    This revision also has 16 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • 099fdc3be4222349See the full diff
    • ▲

      request property // was restricted to a list of enum values

      request-property-became-enum

    • ▲

      request property was restricted to a list of enum values

      request-property-became-enum

    • ●

      added the new ARB enum value to the ///// response property for the response status

      response-property-enum-value-added

    • ●

      added the new Arbitrum enum value to the /// response property for the response status

      response-property-enum-value-added

    • ●

      added the new BNB enum value to the ///// response property for the response status

      response-property-enum-value-added

    • ●

      added the new BNB Smart Chain enum value to the /// response property for the response status

      response-property-enum-value-added

    • ●

      added the new Base enum value to the /// response property for the response status

      response-property-enum-value-added

    • ●

      added the new ETH enum value to the ///// response property for the response status

      response-property-enum-value-added

    • ●

      added the new EURC enum value to the ///// response property for the response status

      response-property-enum-value-added

    • ●

      added the new Ethereum enum value to the /// response property for the response status

      response-property-enum-value-added

    • ●

      added the new HYPE enum value to the ///// response property for the response status

      response-property-enum-value-added

    • ●

      added the new Hypercore enum value to the /// response property for the response status

      response-property-enum-value-added

    • ●

      added the new Hyperliquid enum value to the /// response property for the response status

      response-property-enum-value-added

    • ●

      added the new MegaETH enum value to the /// response property for the response status

      response-property-enum-value-added

    • ●

      added the new PYUSD enum value to the ///// response property for the response status

      response-property-enum-value-added

    • ●

      added the new Plasma enum value to the /// response property for the response status

      response-property-enum-value-added

    • ●

      added the new Polygon enum value to the /// response property for the response status

      response-property-enum-value-added

    • ●

      added the new SOL enum value to the ///// response property for the response status

      response-property-enum-value-added

    • ●

      added the new Solana enum value to the /// response property for the response status

      response-property-enum-value-added

    • ●

      added the new USD1 enum value to the ///// response property for the response status

      response-property-enum-value-added

    • ●

      added the new USDC enum value to the ///// response property for the response status

      response-property-enum-value-added

    • ●

      added the new USDC.e enum value to the ///// response property for the response status

      response-property-enum-value-added

    • ●

      added the new USDG enum value to the ///// response property for the response status

      response-property-enum-value-added

    • ●

      added the new USDT enum value to the ///// response property for the response status

      response-property-enum-value-added

    • ●

      added the new USDT0 enum value to the ///// response property for the response status

      response-property-enum-value-added

    • ●

      added the new USDe enum value to the ///// response property for the response status

      response-property-enum-value-added

    • ●

      added the new USDm enum value to the ///// response property for the response status

      response-property-enum-value-added

    • ●

      added the new XO enum value to the ///// response property for the response status

      response-property-enum-value-added

    • ●

      added the new XPL enum value to the ///// response property for the response status

      response-property-enum-value-added

    • ●

      added the new ach enum value to the ///// response property for the response status

      response-property-enum-value-added

    • ●

      added the new chaps enum value to the ///// response property for the response status

      response-property-enum-value-added

    • ●

      added the new fps enum value to the ///// response property for the response status

      response-property-enum-value-added

    • ●

      added the new pUSD enum value to the ///// response property for the response status

      response-property-enum-value-added

    • ●

      added the new sepa enum value to the ///// response property for the response status

      response-property-enum-value-added

    • ●

      added the new wETH enum value to the ///// response property for the response status

      response-property-enum-value-added

    • ●

      added the new wire enum value to the ///// response property for the response status

      response-property-enum-value-added

    • ○

      added the new base enum value to the request property //

      request-property-enum-value-added

    • ○

      added the new base enum value to the request property

      request-property-enum-value-added

    • ○

      added the new ethereum enum value to the request property //

      request-property-enum-value-added

    • ○

      added the new ethereum enum value to the request property

      request-property-enum-value-added

    • ○

      added the new polygon enum value to the request property //

      request-property-enum-value-added

    • ○

      added the new polygon enum value to the request property

      request-property-enum-value-added

    • ○

      added the new solana enum value to the request property //

      request-property-enum-value-added

    • ○

      added the new solana enum value to the request property

      request-property-enum-value-added

    • ○

      added the new undefined enum value to the request property

      request-property-enum-value-added

    This revision also has 4 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • 60bbb4a6ffbc3See the full diff
    • ○

      added the new optional header request parameter Idempotency-Key

      new-optional-request-parameter

    • ○

      added the required property //// to the response with the status

      response-required-property-added

    • ○

      added the required property //// to the response with the status

      response-required-property-added

    This revision also has 1 change that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

Of the 74 revisions, 1 has no diff computed.