Skip to main content
GET
Retrieve ledger account
Required permissions:
  • company:balance:read
  • payout:account:read

Yetkilendirmeler

Authorization
string
header
gerekli

An Account API key, account-scoped JWT, App API key, or user OAuth token. Prepend the key or token with Bearer, for example Bearer ***************************.

Scopes

company:balance:read
payout:account:read

Yol Parametreleri

id
string
gerekli

The identifier to look up the ledger account. Accepts a user ID ('user_xxx'), company ID ('biz_xxx'), or ledger account ID ('ldgr_xxx').

Örnek:

"ldgr_xxxxxxxxxxxxx"

Yanıt

A successful response

A ledger account represents a financial account on Whop that can hold many balances.

balances
object[]
gerekli

The balances associated with the account.

id
string
gerekli

The unique identifier for the ledger account.

Örnek:

"ldgr_xxxxxxxxxxxxx"

ledger_type
enum<string>
gerekli

The type of ledger account.

Mevcut seçenekler:
primary,
pool
owner
User · object
gerekli

A user account on Whop. Contains profile information, identity details, and social connections.

payments_approval_status
enum<string> | null
gerekli

The status of payments approval for the ledger account.

Mevcut seçenekler:
pending,
approved,
monitoring,
rejected
payout_account_details
object | null
gerekli

The payout account associated with the LedgerAccount, if any.

payout_quote_required
boolean
gerekli

Whether legacy payout clients should confirm a provider-backed quote for this account. REST POST /payouts on API version 2026-11-03 or later always requires quote_token from POST /payouts/quotes, regardless of this flag.

settlement_time_at
string<date-time> | null
gerekli

The settlement batch most recently posted to this account's available balance, at midnight UTC. Every payment settling in that batch carries the same settlement_time_at.

Örnek:

"2023-12-01T05:00:00.401Z"

transfer_fee
number | null
gerekli

The fee for transfers, if applicable.

Örnek:

6.9

treasury_balance
object | null
gerekli

The balance cache associated with the account by currency.