Transfers

Transfers move value between identities on Whop. They are used for account-to-account money movement, user payouts inside Whop, crypto transfers, and claim links depending on the destination type.

Use the Transfers API to create a transfer, list previous transfers, and retrieve a transfer by ID when reconciling money movement between accounts or users.

Endpoints

Endpoint	Request
List Transfers	GET /transfers
Create Transfer	POST /transfers
Retrieve Transfer	GET /transfers/{id}
List Transfer Recipients	GET /transfers/recipients

Attributes

id · string · required

Transfer ID.

amount · number · required

Transfer amount.

created_at · string · required

When the transfer was created.

created_by_user · object | null · required

The user who initiated the transfer, such as the team member who sent a manual payout. Null if the creator is unavailable.

Properties

id · string · required

User ID.

name · string | null

User display name.

username · string · required

User’s username.

currency · string · required

Transfer currency.

destination · object · required

Account or user receiving funds.

destination_ledger_account_id · string · required

Destination ledger account ID.

failed_at · string | null

When the transfer failed, as an ISO 8601 timestamp. Null unless the transfer has failed.

failure_code · string | null

Machine-readable code for why the transfer failed. Null unless the transfer has failed.

failure_reason · string | null

Human-readable explanation of why the transfer failed. Null unless the transfer has failed.

fee_amount · number | null

Fee charged for the transfer.

metadata · object | null

Custom metadata attached to the transfer.

notes · string | null

Transfer note.

object · string · required

The object type. Discriminates the create response from a send or a claim link.

origin · object · required

Account or user sending funds.

origin_ledger_account_id · string · required

Source ledger account ID.

status · string · required

Transfer status. processing means the on-chain leg is still executing — poll the transfer until it resolves to succeeded or failed. A failed transfer may be retried under the same ID and later resolve to succeeded.

Available options: processing, succeeded, failed

Transfer

{
	"id": "tr_xxxxxxxxxxxxx",
	"amount": 50,
	"created_at": "2026-06-01T12:00:00Z",
	"created_by_user": {
		"id": "user_xxxxxxxxxxxxx",
		"name": "Jordan Lee",
		"username": "jordan"
	},
	"currency": "usd",
	"destination": {
		"id": "user_xxxxxxxxxxxxx",
		"name": "Alex Rivera",
		"typename": "User",
		"username": "alex"
	},
	"destination_ledger_account_id": "la_destxxxxxxxx",
	"fee_amount": null,
	"metadata": {
		"external_transfer_id": "transfer_123"
	},
	"notes": "Creator bonus",
	"object": "transfer",
	"origin": {
		"id": "biz_xxxxxxxxxxxxxx",
		"route": "pickaxe",
		"title": "Pickaxe",
		"typename": "Company"
	},
	"origin_ledger_account_id": "la_originxxxxxx",
	"status": "succeeded"
}