{
"balances": [
{
"balance": 6.9,
"currency": "usd",
"pending_balance": 6.9,
"reserve_balance": 6.9
}
],
"id": "ldgr_xxxxxxxxxxxxx",
"ledger_type": "primary",
"owner": {
"id": "user_xxxxxxxxxxxxx",
"name": "John Doe",
"typename": "User",
"username": "johndoe42"
},
"payments_approval_status": "pending",
"payout_account_details": {
"address": {
"city": "<string>",
"country": "<string>",
"line1": "<string>",
"line2": "<string>",
"postal_code": "<string>",
"state": "<string>"
},
"business_name": "<string>",
"business_representative": {
"date_of_birth": "<string>",
"first_name": "<string>",
"last_name": "<string>",
"middle_name": "<string>"
},
"email": "<string>",
"id": "poact_xxxxxxxxxxxx",
"latest_verification": {
"id": "verf_xxxxxxxxxxxxx",
"last_error_code": "abandoned",
"last_error_reason": "Document image was too blurry to read.",
"status": "requires_input"
},
"phone": "<string>",
"status": "connected"
},
"transfer_fee": 6.9,
"treasury_balance": {
"balance": 6.9,
"balance_usd": 6.9,
"currency": "usd",
"pending_balance": 6.9,
"reserve_balance": 6.9,
"total_withdrawable_balance": 6.9
}
}
array<object>
required
The balances associated with the account.
Show child attributes
Show child attributes
number
required
The amount of the balance.Example:
6.9Currencies
required
The currency of the balance.Available options:
usd, sgd, inr, aud, brl, cad, dkk, eur, nok, gbp, sek, chf, hkd, huf, jpy, mxn, myr, pln, czk, nzd, aed, eth, ape, cop, ron, thb, bgn, idr, dop, php, try, krw, twd, vnd, pkr, clp, uyu, ars, zar, dzd, tnd, mad, kes, kwd, jod, all, xcd, amd, bsd, bhd, bob, bam, khr, crc, xof, egp, etb, gmd, ghs, gtq, gyd, ils, jmd, mop, mga, mur, mdl, mnt, nad, ngn, mkd, omr, pyg, pen, qar, rwf, sar, rsd, lkr, tzs, ttd, uzs, rub, btc, cny, usdt, kzt, awg, whop_usd, xaunumber
required
The amount of the balance that is pending.Example:
6.9number
required
The amount of the balance that is reserved.Example:
6.9string
required
The unique identifier for the ledger account.Example:
ldgr_xxxxxxxxxxxxxLedgerTypes
required
The type of ledger account.Available options:
primary, poolUser or Company | null
required
The owner of the ledger account.
Show User
Show User
string
required
The unique identifier for the user.Example:
user_xxxxxxxxxxxxxstring | null
required
The user’s display name shown on their public profile.Example:
John Doestring
required
The typename of this object
string
required
The user’s unique username shown on their public profile.Example:
johndoe42Show Company
Show Company
string
required
The unique identifier for the company.Example:
biz_xxxxxxxxxxxxxxstring
required
URL slug for the account’s store page, e.g.
pickaxe in whop.com/pickaxe.Example: pickaxestring
required
The display name of the company shown to customers.Example:
Pickaxestring
required
The typename of this object
PaymentsApprovalStatuses | null
required
The status of payments approval for the ledger account.Available options:
pending, approved, monitoring, rejectedobject | null
required
The payout account associated with the LedgerAccount, if any.
Show child attributes
Show child attributes
object | null
required
The physical address associated with this payout account
Show child attributes
Show child attributes
string | null
required
The company’s legal name
object | null
required
The business representative for this payout account
Show child attributes
Show child attributes
string | null
required
The date of birth of the business representative in ISO 8601 format
(YYYY-MM-DD).
string | null
required
The first name of the business representative.
string | null
required
The last name of the business representative.
string | null
required
The middle name of the business representative.
string | null
required
The email address of the representative
string
required
The unique identifier for the payout account.Example:
poact_xxxxxxxxxxxxobject | null
required
The latest verification for the connected account.
Show child attributes
Show child attributes
string
required
The numeric id of the verification record.Example:
verf_xxxxxxxxxxxxxVerificationErrorCodes | null
required
The most recent error code returned during verification. Null if no error has occurred.Available options:
abandoned, consent_declined, country_not_supported, device_not_supported, document_expired, document_type_not_supported, document_unverified_other, email_unverified_other, email_verification_declined, id_number_insufficient_document_data, id_number_mismatch, id_number_unverified_other, phone_unverified_other, phone_verification_declined, selfie_document_missing_photo, selfie_face_mismatch, selfie_manipulated, selfie_unverified_other, under_supported_agestring | null
required
A human-readable explanation of the most recent verification error. Null if no error has occurred.Example:
Document image was too blurry to read.VerificationStatuses
required
The current status of this verification session.Available options:
requires_input, processing, verified, canceled, created, started, submitted, approved, declined, resubmission_requested, expired, abandoned, review, action_requiredstring | null
required
The business representative’s phone
PayoutAccountCalculatedStatuses | 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_startednumber | null
required
The fee for transfers, if applicable.Example:
6.9object | null
required
The balance cache associated with the account by currency.
Show child attributes
Show child attributes
number
required
The amount of the balance.Example:
6.9number
required
The balance converted to USD.Example:
6.9Currencies
required
The currency of the balance.Available options:
usd, sgd, inr, aud, brl, cad, dkk, eur, nok, gbp, sek, chf, hkd, huf, jpy, mxn, myr, pln, czk, nzd, aed, eth, ape, cop, ron, thb, bgn, idr, dop, php, try, krw, twd, vnd, pkr, clp, uyu, ars, zar, dzd, tnd, mad, kes, kwd, jod, all, xcd, amd, bsd, bhd, bob, bam, khr, crc, xof, egp, etb, gmd, ghs, gtq, gyd, ils, jmd, mop, mga, mur, mdl, mnt, nad, ngn, mkd, omr, pyg, pen, qar, rwf, sar, rsd, lkr, tzs, ttd, uzs, rub, btc, cny, usdt, kzt, awg, whop_usd, xaunumber
required
The amount of the balance that is pending.Example:
6.9number
required
The amount of the balance that is reserved.Example:
6.9number
required
The amount of the balance that is withdrawable.Example:
6.9