Skip to main content
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

Attributes

string
required
Transfer ID.
number
required
Transfer amount.
string
required
When the transfer was created.
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

string
required
User ID.
string | null
User display name.
string
required
User’s username.
string
required
Transfer currency.
object
required
Account or user receiving funds.
string
required
Destination ledger account ID.
number | null
Fee charged for the transfer.
object | null
Custom metadata attached to the transfer.
string | null
Transfer note.
string
required
The object type. Discriminates the create response from a send or a claim link.
object
required
Account or user sending funds.
string
required
Source ledger account ID.
string
required
Transfer status. processing means the on-chain leg is still executing — poll the transfer until it resolves to succeeded or failed.Available options: processing, succeeded, failed
Transfer