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.

An object representing an account used for payouts.

id
string
required

The unique identifier for the payout account.

Example:

"poact_xxxxxxxxxxxx"

status
enum<string> | null
required

The granular calculated status of the payout account reflecting its current KYC and withdrawal readiness state.

Available options:
connected,
disabled,
action_required,
pending_verification,
verification_failed,
not_started
business_name
string | null
required

The company's legal name

phone
string | null
required

The business representative's phone

email
string | null
required

The email address of the representative

business_representative
object
required

The business representative for this payout account

address
object
required

The physical address associated with this payout account

latest_verification
object
required

The latest verification for the connected account.