Deposits

Create Deposit

Changed on

Returns the deposit methods for an account or user, including crypto addresses, bank transfer instructions, and, for a business, a hosted deposit page. Bitcoin deposits are converted to USDT on Plasma in the destination's wallet. Business destinations require no authentication. Pass payment_method_id to also charge a business's saved payment method for amount in USD and add it to the business's balance; that requires authentication with the payment:charge scope. The charge has no fees or taxes and does not count as revenue.

post/deposits

Request

  • Base URL: https://api.whop.com/api/v1
  • URL: https://api.whop.com/api/v1/deposits
  • Auth: one of:
    • none
    • HTTP bearer
    • HTTP bearer

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. With payment_method_id, the amount in USD to charge, and required.

destinationstring required

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

payment_method_idstring

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 request

{
  "amount": 50,
  "destination": "biz_xxxxxxxxxxxxxx",
  "payment_method_id": "payt_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"
        }
      ]
    },
    "card": {
      "payment_id": "pay_xxxxxxxxxxxxxx",
      "payment_method_id": "payt_xxxxxxxxxxxxxx"
    },
    "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

  • d94adec84933Revision changes
    • info

      the security scope payout:account:read was added to the endpoint's security scheme bearerAuth

    • info

      the security scope payment:charge was removed from the endpoint's security scheme bearerAuth

  • 54dbb42f6781Revision changes
    • info

      the security scope payout:account:read was added to the endpoint's security scheme bearerAuth

    • info

      the security scope payment:charge was removed from the endpoint's security scheme bearerAuth