Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.whop.com/llms.txt

Use this file to discover all available pages before exploring further.

There are two ways to collect payments for connected accounts:
  1. Direct charges: Create a checkout for the connected account and collect an application fee.
  2. Transfers: Collect payment to your platform account and transfer funds to connected accounts later.

​
Direct charges

Create a checkout configuration with a connected account’s company ID to charge customers directly on the connected account. The connected account is responsible for Whop fees, refunds, and disputes.

​
How it works

  1. Create a checkout configuration for your connected account with an application_fee_amount
  2. When a customer purchases, the charge is created directly on the connected account
  3. Your platform collects the application fee, and the remaining amount goes to the connected account
  4. The connected account handles any disputes or refunds for the transaction

​
Example

import Whop from "@whop/sdk";

const client = new Whop({
	apiKey: "Company API Key",
});

const checkoutConfig = await client.checkoutConfigurations.create({
	company_id: "biz_xxxxxxxxxxxxx", // Connected account's company ID
	plan: {
		initial_price: 10.0,
		plan_type: "one_time",
		application_fee_amount: 1.23,
	},
});

console.log(checkoutConfig.purchase_url);
In this example:
  • company_id is the connected account’s company ID where the charge will be created
  • plan.initial_price is the total payment amount (10.00 USD)
  • plan.application_fee_amount is the fee your platform collects (1.23 USD)
  • The connected account receives 8.77 USD (10.00 - 1.23)

​
Limitations

  • The application_fee_amount must be positive and less than the total payment amount
  • The application fee collected is capped at the captured amount of the payment

​
Transfers

Use transfers when your platform collects the payment first, or when your backend decides how much and when each connected account should be paid.

​
Before you transfer

  • Origin company: the company sending funds must complete KYC and have enough balance for the transfer. You can top up the balance from the dashboard or via Add funds to your balance.
  • Destination company: the recipient must already have a Whop company. If they do not, onboard them first with Enroll connected accounts.
  • Settlement ownership: with transfers, your platform is the merchant of record for the original payment. Your platform handles fees, disputes, and refunds on that payment.

​
Example

Collect payment to your platform company, then transfer the connected account’s share: 
import Whop from "@whop/sdk";

const client = new Whop({
	apiKey: "Company API Key",
});

const transfer = await client.transfers.create({
	amount: 90.0,
	currency: "usd",
	origin_id: "biz_yyyyyyyyyyyyy", // Platform's company ID
	destination_id: "biz_xxxxxxxxxxxxx", // Connected account's company ID
	metadata: {
		order_id: "order_12345",
	},
});

console.log(transfer.id);
In this example:
  • origin_id is your platform’s company ID (where funds are deducted from)
  • destination_id is the connected account’s company ID (where funds are credited to)
  • amount is the amount to transfer
  • metadata stores custom data for your reference

​
Handle transfer failures

Transfers fail if the origin company is not verified, the origin balance is too low, or the destination company cannot receive funds yet. Fix the underlying cause before retrying. Do not blindly retry failed transfers.

​
Common uses

  • Scheduled creator payouts
  • Affiliate payouts
  • Marketplace splits after an order settles

​
Which flow should I use?

Direct chargesTransfers
FeesConnected account pays Whop feesPlatform pays Whop fees
DisputesConnected account handles disputesPlatform handles disputes
RefundsConnected account handles refundsPlatform handles refunds
Use transfers when your backend controls payout timing and amount. Use direct charges when the connected account should own fees, disputes, and refunds from the original purchase.

​
API Reference

Create Checkout Configuration

Create checkout configurations with application fees

Create Transfer

Transfer funds between accounts

Accept payments

Learn about checkout links and embedded checkout

Enroll connected accounts

Create recipient companies and finish onboarding before paying them