Skip to main content
GET
/
ledger_accounts
/
{id}
JavaScript
import Whop from '@whop/sdk';

const client = new Whop({
  appID: 'app_xxxxxxxxxxxxxx',
  apiKey: 'My API Key',
});

const ledgerAccount = await client.ledgerAccounts.retrieve('ldgr_xxxxxxxxxxxxx');

console.log(ledgerAccount.id);
{
  "id": "ldgr_xxxxxxxxxxxxx",
  "balances": [
    {
      "balance": 6.9,
      "currency": "usd",
      "pending_balance": 6.9,
      "reserve_balance": 6.9
    }
  ],
  "transfer_fee": 6.9,
  "ledger_account_audit_status": "pending",
  "payments_approval_status": "pending",
  "ledger_type": "primary",
  "owner": {
    "typename": "<string>",
    "id": "user_xxxxxxxxxxxxx",
    "name": "<string>",
    "username": "<string>"
  }
}

Authorizations

​
Authorization
string
header
required

The app API key from an app from the /dashboard/developer page

Path Parameters

​
id
string
required

Either a User ID, Company ID, or LedgerAccount ID (user_xxx, biz_xxx, or ldgr_xxx)

Example:

"ldgr_xxxxxxxxxxxxx"

Response

A successful response

Represents a LedgerAccount.

​
id
string
required

The ID of the LedgerAccount.

Example:

"ldgr_xxxxxxxxxxxxx"

​
balances
object[]
required

The balances associated with the account.

​
transfer_fee
number | null
required

The fee for transfers, if applicable.

Example:

6.9

​
ledger_account_audit_status
enum<string> | null
required

The most recent audit status for the account. The different statuses a LedgerAccountAudit can be

Available options:
pending,
approved,
reserves_imposed,
suspended,
ignored,
rejected,
requested_more_information,
information_submitted,
requested_tos_violation_correction,
clawback_attempted,
awaiting_sales_review
​
payments_approval_status
enum<string> | null
required

The status of payments approval for the ledger account. The different approval statuses an account can have.

Available options:
pending,
approved,
monitoring,
rejected
​
ledger_type
enum<string>
required

The type of ledger account.

Available options:
primary,
pool
​
owner
object
required

The owner of the ledger account. An object representing a (sanitized) user of the site.

  • User
  • Company