Ledger accounts

Retrieve ledger account

Changed on

Retrieves the details of an existing ledger account.

Required permissions:

  • company:balance:read
  • payout:account:read
get/ledger_accounts/{id}

Request

  • Base URL: https://api.whop.com/api/v1
  • URL: https://api.whop.com/api/v1/ledger_accounts/{id}
  • Auth: HTTP bearer

Path parameters

idstring required
Example:ldgr_xxxxxxxxxxxxx

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

Response

A successful response

idstring required

The unique identifier for the ledger account.

ledger_type'primary' | 'pool' required

The types of ledgers that can be created.

payments_approval_status'pending' | 'approved' | 'monitoring' | 'rejected' required

The different approval statuses an account can have.

payout_quote_requiredboolean required

Whether a payout from this account must be confirmed against a provider-backed quote first. When true, create a quote with POST /payouts/quotes and send its quote_token when creating the payout.

settlement_time_atstring date-time nullable required

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.

transfer_feenumber nullable required

The fee for transfers, if applicable.

Example response

{
  "balances": [
    {
      "balance": 6.9,
      "currency": "usd",
      "pending_balance": 6.9,
      "reserve_balance": 6.9
    }
  ],
  "id": "ldgr_xxxxxxxxxxxxx",
  "owner": {
    "id": "user_xxxxxxxxxxxxx",
    "name": "John Doe",
    "username": "johndoe42"
  },
  "payout_account_details": {
    "id": "poact_xxxxxxxxxxxx",
    "latest_verification": {
      "id": "verf_xxxxxxxxxxxxx",
      "last_error_reason": "Document image was too blurry to read."
    }
  },
  "settlement_time_at": "2023-12-01T05:00:00.401Z",
  "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
  }
}

Changes

  • 697924df40d1Revision changes
    • info

      added the required property to the response with the status

  • 099fdc3be422Revision changes
    • warning

      added the new blocked_by_parent enum value to the ///// response property for the response status

    • warning

      added the new denied enum value to the ///// response property for the response status

    • warning

      added the new manual_review enum value to the // response property for the response status

    • warning

      added the new manual_review enum value to the ///// response property for the response status

    • info

      added the required property to the response with the status