> ## 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. # Retrieve ledger account > Retrieves the details of an existing ledger account. Required permissions: - `company:balance:read` - `payout:account:read` ## OpenAPI ````yaml /openapi/api-v1-stable.json get /ledger_accounts/{id} openapi: 3.1.0 info: description: >- The Whop REST API. Please see https://docs.whop.com/developer/api/getting-started for more details. termsOfService: https://whop.com/tos-developer-api/ title: Whop API version: 1.0.0 x-api-version-date: '2026-08-21' servers: - description: Production Whop API url: https://api.whop.com/api/v1 - description: Sandbox Whop API url: https://sandbox-api.whop.com/api/v1 security: [] tags: - description: Products name: Products - description: Payments name: Payments - description: Refunds name: Refunds - description: Disputes name: Disputes - description: Dispute alerts name: Dispute alerts - description: Resolution center cases name: Resolution center cases - description: Checkout configurations name: Checkout configurations - description: Setup intents name: Setup intents - description: Payment methods name: Payment methods - description: Invoices name: Invoices - description: Promo codes name: Promo codes - description: Card transactions name: Card transactions - description: Ledger accounts name: Ledger accounts - description: Withdrawals name: Withdrawals - description: Payout methods name: Payout methods - description: Verifications name: Verifications - description: Identity profiles name: Identity profiles - description: Payout accounts name: Payout accounts - description: Topups name: Topups - description: Companies name: Companies - description: Authorized users name: Authorized users - description: Fee markups name: Fee markups - description: Members name: Members - description: Memberships name: Memberships - description: Leads name: Leads - description: Entries name: Entries - description: Shipments name: Shipments - description: Reviews name: Reviews - description: Company token transactions name: Company token transactions - description: Affiliates name: Affiliates - description: Experiences name: Experiences - description: Forums name: Forums - description: Forum posts name: Forum posts - description: Chat channels name: Chat channels - description: Support channels name: Support channels - description: Messages name: Messages - description: Reactions name: Reactions - description: Dm members name: Dm members - description: Dm channels name: Dm channels - description: Notifications name: Notifications - description: Courses name: Courses - description: Course chapters name: Course chapters - description: Course lessons name: Course lessons - description: Course students name: Course students - description: Course lesson interactions name: Course lesson interactions - description: Apps name: Apps - description: Webhooks name: Webhooks - description: App builds name: App builds - description: Access tokens name: Access tokens - description: Account links name: Account links - description: Files name: Files - description: Ai chats name: Ai chats - description: Bounties name: Bounties - description: Stats name: Stats - description: Conversions name: Conversions - description: Ad reports name: Ad reports paths: /ledger_accounts/{id}: get: tags: - Ledger accounts summary: Retrieve ledger account description: |- Retrieves the details of an existing ledger account. Required permissions: - `company:balance:read` - `payout:account:read` operationId: retrieveLedgerAccount parameters: - description: >- The identifier to look up the ledger account. Accepts a user ID ('user_xxx'), company ID ('biz_xxx'), or ledger account ID ('ldgr_xxx'). in: path name: id required: true schema: example: ldgr_xxxxxxxxxxxxx type: string responses: '200': content: application/json: schema: $ref: '#/components/schemas/LedgerAccount' description: A successful response '400': content: application/json: example: error: code: parameter_missing message: 'Missing required parameter: amount.' param: amount type: invalid_request_error schema: properties: error: properties: code: description: >- A short string indicating the specific error code, e.g. 'parameter_missing', 'parameter_invalid', 'invalid_json' type: - string - 'null' message: type: string param: description: The parameter that caused the error, if applicable type: - string - 'null' type: type: string required: - type - message type: object required: - error type: object description: Bad request '401': content: application/json: example: error: message: Invalid or missing API key type: unauthorized schema: properties: error: properties: code: description: >- A short string indicating the specific error code, e.g. 'parameter_missing', 'parameter_invalid', 'invalid_json' type: - string - 'null' message: type: string param: description: The parameter that caused the error, if applicable type: - string - 'null' type: type: string required: - type - message type: object required: - error type: object description: Unauthorized '403': content: application/json: example: error: message: You do not have permission to access this resource type: forbidden schema: properties: error: properties: code: description: >- A short string indicating the specific error code, e.g. 'parameter_missing', 'parameter_invalid', 'invalid_json' type: - string - 'null' message: type: string param: description: The parameter that caused the error, if applicable type: - string - 'null' type: type: string required: - type - message type: object required: - error type: object description: Forbidden '404': content: application/json: example: error: message: Resource not found type: not_found schema: properties: error: properties: code: description: >- A short string indicating the specific error code, e.g. 'parameter_missing', 'parameter_invalid', 'invalid_json' type: - string - 'null' message: type: string param: description: The parameter that caused the error, if applicable type: - string - 'null' type: type: string required: - type - message type: object required: - error type: object description: Not found '422': content: application/json: example: error: null schema: properties: error: properties: code: description: >- A short string indicating the specific error code, e.g. 'parameter_missing', 'parameter_invalid', 'invalid_json' type: - string - 'null' message: type: string param: description: The parameter that caused the error, if applicable type: - string - 'null' type: type: string required: - type - message type: object required: - error type: object description: Verification required '429': content: application/json: example: error: null schema: properties: error: properties: code: description: >- A short string indicating the specific error code, e.g. 'parameter_missing', 'parameter_invalid', 'invalid_json' type: - string - 'null' message: type: string param: description: The parameter that caused the error, if applicable type: - string - 'null' type: type: string required: - type - message type: object required: - error type: object description: Too many requests '500': content: application/json: example: error: message: An unexpected error occurred type: internal_server_error schema: properties: error: properties: code: description: >- A short string indicating the specific error code, e.g. 'parameter_missing', 'parameter_invalid', 'invalid_json' type: - string - 'null' message: type: string param: description: The parameter that caused the error, if applicable type: - string - 'null' type: type: string required: - type - message type: object required: - error type: object description: Internal server error security: - bearerAuth: - company:balance:read - payout:account:read x-codeSamples: - lang: JavaScript source: >- import Whop from '@whop/sdk'; const client = new Whop({ apiKey: process.env['WHOP_API_KEY'], // This is the default and can be omitted }); const ledgerAccount = await client.ledgerAccounts.retrieve('ldgr_xxxxxxxxxxxxx'); console.log(ledgerAccount.id); components: schemas: LedgerAccount: description: >- A ledger account represents a financial account on Whop that can hold many balances. properties: balances: description: The balances associated with the account. items: description: A cached balance for a LedgerAccount in respect to a currency. properties: balance: description: The amount of the balance. example: 6.9 type: number currency: $ref: '#/components/schemas/Currencies' description: The currency of the balance. pending_balance: description: The amount of the balance that is pending. example: 6.9 type: number reserve_balance: description: The amount of the balance that is reserved. example: 6.9 type: number required: - balance - currency - pending_balance - reserve_balance type: object type: array id: description: The unique identifier for the ledger account. example: ldgr_xxxxxxxxxxxxx type: string ledger_type: $ref: '#/components/schemas/LedgerTypes' description: The type of ledger account. owner: description: The owner of the ledger account. discriminator: propertyName: typename oneOf: - description: >- A user account on Whop. Contains profile information, identity details, and social connections. properties: id: description: The unique identifier for the user. example: user_xxxxxxxxxxxxx type: string name: description: The user's display name shown on their public profile. example: John Doe type: - string - 'null' typename: const: User description: The typename of this object type: string username: description: The user's unique username shown on their public profile. example: johndoe42 type: string required: - typename - id - name - username title: User type: - object - 'null' - description: >- A company is a seller on Whop. Companies own products, manage members, and receive payouts. properties: id: description: The unique identifier for the company. example: biz_xxxxxxxxxxxxxx type: string route: description: >- URL slug for the account's store page, e.g. `pickaxe` in whop.com/pickaxe. example: pickaxe type: string title: description: The display name of the company shown to customers. example: Pickaxe type: string typename: const: Company description: The typename of this object type: string required: - typename - id - route - title title: Company type: - object - 'null' type: object payments_approval_status: description: The status of payments approval for the ledger account. oneOf: - $ref: '#/components/schemas/PaymentsApprovalStatuses' - type: 'null' payout_account_details: description: The payout account associated with the LedgerAccount, if any. properties: address: description: The physical address associated with this payout account properties: city: description: The city of the address. type: - string - 'null' country: description: The country of the address. type: - string - 'null' line1: description: The line 1 of the address. type: - string - 'null' line2: description: The line 2 of the address. type: - string - 'null' postal_code: description: The postal code of the address. type: - string - 'null' state: description: The state of the address. type: - string - 'null' required: - line1 - line2 - city - postal_code - state - country type: - object - 'null' business_name: description: The company's legal name type: - string - 'null' business_representative: description: The business representative for this payout account properties: date_of_birth: description: >- The date of birth of the business representative in ISO 8601 format (YYYY-MM-DD). type: - string - 'null' first_name: description: The first name of the business representative. type: - string - 'null' last_name: description: The last name of the business representative. type: - string - 'null' middle_name: description: The middle name of the business representative. type: - string - 'null' required: - date_of_birth - first_name - middle_name - last_name type: - object - 'null' email: description: The email address of the representative type: - string - 'null' id: description: The unique identifier for the payout account. example: poact_xxxxxxxxxxxx type: string latest_verification: description: The latest verification for the connected account. properties: id: description: The numeric id of the verification record. example: verf_xxxxxxxxxxxxx type: string last_error_code: description: >- The most recent error code returned during verification. Null if no error has occurred. oneOf: - $ref: '#/components/schemas/VerificationErrorCodes' - type: 'null' last_error_reason: description: >- A human-readable explanation of the most recent verification error. Null if no error has occurred. example: Document image was too blurry to read. type: - string - 'null' status: $ref: '#/components/schemas/VerificationStatuses' description: The current status of this verification session. required: - id - status - last_error_code - last_error_reason type: - object - 'null' phone: description: The business representative's phone type: - string - 'null' status: description: >- The granular calculated status of the payout account reflecting its current KYC and withdrawal readiness state. oneOf: - $ref: '#/components/schemas/PayoutAccountCalculatedStatuses' - type: 'null' required: - id - status - business_name - phone - email - business_representative - address - latest_verification type: - object - 'null' settlement_time_at: description: >- 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`. example: '2023-12-01T05:00:00.401Z' format: date-time type: - string - 'null' transfer_fee: description: The fee for transfers, if applicable. example: 6.9 type: - number - 'null' treasury_balance: description: The balance cache associated with the account by currency. properties: balance: description: The amount of the balance. example: 6.9 type: number balance_usd: description: The balance converted to USD. example: 6.9 type: number currency: $ref: '#/components/schemas/Currencies' description: The currency of the balance. pending_balance: description: The amount of the balance that is pending. example: 6.9 type: number reserve_balance: description: The amount of the balance that is reserved. example: 6.9 type: number total_withdrawable_balance: description: The amount of the balance that is withdrawable. example: 6.9 type: number required: - balance - balance_usd - currency - pending_balance - reserve_balance - total_withdrawable_balance type: - object - 'null' required: - id - settlement_time_at - balances - treasury_balance - transfer_fee - payout_account_details - payments_approval_status - ledger_type - owner type: object Currencies: description: The available currencies on the platform enum: - 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 - xau type: string LedgerTypes: description: The types of ledgers that can be created. enum: - primary - pool type: string PaymentsApprovalStatuses: description: The different approval statuses an account can have. enum: - pending - approved - monitoring - rejected type: string VerificationErrorCodes: description: An error code for a verification attempt. enum: - 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_age type: string VerificationStatuses: description: A status for a verification. enum: - requires_input - processing - verified - canceled - created - started - submitted - approved - declined - resubmission_requested - expired - abandoned - review - action_required - manual_review type: string PayoutAccountCalculatedStatuses: description: >- The granular calculated statuses reflecting payout account KYC and withdrawal readiness. enum: - connected - disabled - action_required - pending_verification - verification_failed - manual_review - denied - not_started - blocked_by_parent type: string securitySchemes: bearerAuth: bearerFormat: auth-scheme description: >- An Account API key, account-scoped JWT, App API key, or user OAuth token. Prepend the key or token with `Bearer`, for example `Bearer ***************************`. scheme: bearer type: http ````