Retrieve ledger account

JavaScript

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);

{
  "id": "ldgr_xxxxxxxxxxxxx",
  "balances": [
    {
      "balance": 6.9,
      "currency": "usd",
      "pending_balance": 6.9,
      "reserve_balance": 6.9
    }
  ],
  "transfer_fee": 6.9,
  "payout_account_details": {
    "id": "poact_xxxxxxxxxxxx",
    "business_name": "<string>",
    "phone": "<string>",
    "email": "<string>",
    "business_representative": {
      "date_of_birth": "<string>",
      "first_name": "<string>",
      "middle_name": "<string>",
      "last_name": "<string>"
    },
    "address": {
      "line1": "<string>",
      "line2": "<string>",
      "city": "<string>",
      "postal_code": "<string>",
      "state": "<string>",
      "country": "<string>"
    }
  },
  "ledger_account_audit_status": "pending",
  "payments_approval_status": "pending",
  "ledger_type": "primary",
  "owner": {
    "typename": "<string>",
    "id": "user_xxxxxxxxxxxxx",
    "name": "John Doe",
    "username": "johndoe42"
  }
}

GET

ledger_accounts

{id}

JavaScript

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);

{
  "id": "ldgr_xxxxxxxxxxxxx",
  "balances": [
    {
      "balance": 6.9,
      "currency": "usd",
      "pending_balance": 6.9,
      "reserve_balance": 6.9
    }
  ],
  "transfer_fee": 6.9,
  "payout_account_details": {
    "id": "poact_xxxxxxxxxxxx",
    "business_name": "<string>",
    "phone": "<string>",
    "email": "<string>",
    "business_representative": {
      "date_of_birth": "<string>",
      "first_name": "<string>",
      "middle_name": "<string>",
      "last_name": "<string>"
    },
    "address": {
      "line1": "<string>",
      "line2": "<string>",
      "city": "<string>",
      "postal_code": "<string>",
      "state": "<string>",
      "country": "<string>"
    }
  },
  "ledger_account_audit_status": "pending",
  "payments_approval_status": "pending",
  "ledger_type": "primary",
  "owner": {
    "typename": "<string>",
    "id": "user_xxxxxxxxxxxxx",
    "name": "John Doe",
    "username": "johndoe42"
  }
}

Authorizations

Authorization

string

header

required

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

Path Parameters

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.

string

required

The ID of the LedgerAccount.

Example:

"ldgr_xxxxxxxxxxxxx"

balances

object[]

required

The balances associated with the account.

Show child attributes

balances.balance

number

required

The amount of the balance.

Example:

6.9

balances.currency

enum<string>

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

balances.pending_balance

number

required

The amount of the balance that is pending.

Example:

6.9

balances.reserve_balance

number

required

The amount of the balance that is reserved.

Example:

6.9

transfer_fee

number | null

required

The fee for transfers, if applicable.

Example:

6.9

payout_account_details

object

required

The payout account associated with the LedgerAccount, if any.

Show child attributes

payout_account_details.id

string

required

Unique identifier for the object

Example:

"poact_xxxxxxxxxxxx"

payout_account_details.business_name

string | null

required

The company's legal name

payout_account_details.phone

string | null

required

The business representative's phone

payout_account_details.email

string | null

required

The email address of the representative

payout_account_details.business_representative

object

required

The business representative for this payout account

Show child attributes

payout_account_details.business_representative.date_of_birth

string | null

required

The date of birth of the business representative in ISO 8601 format (YYYY-MM-DD).

payout_account_details.business_representative.first_name

string | null

required

The first name of the business representative.

payout_account_details.business_representative.middle_name

string | null

required

The middle name of the business representative.

payout_account_details.business_representative.last_name

string | null

required

The last name of the business representative.

payout_account_details.address

object

required

The physical address associated with this payout account

Show child attributes

payout_account_details.address.line1

string | null

required

The line 1 of the address.

payout_account_details.address.line2

string | null

required

The line 2 of the address.

payout_account_details.address.city

string | null

required

The city of the address.

payout_account_details.address.postal_code

string | null

required

The postal code of the address.

payout_account_details.address.state

string | null

required

The state of the address.

payout_account_details.address.country

string | null

required

The country of the address.

ledger_account_audit_status

enum<string> | null

required

The most recent audit status for the account.

Available options:

pending,

pending_ai_review,

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.

Available options:

pending,

approved,

monitoring,

rejected

ledger_type

enum<string>

required

The type of ledger account.

Available options:

primary,

pool

owner

User · object

required

The owner of the ledger account.

User
Company

Show child attributes

owner.typename

string

required

The typename of this object

Allowed value: "User"

owner.id

string

required

The internal ID of the user.

Example:

"user_xxxxxxxxxxxxx"

owner.name

string | null

required

The name of the user from their Whop account.

Example:

"John Doe"

owner.username

string

required

The username of the user from their Whop account.

Example:

"johndoe42"

Delete promo code List transfers

⌘I

Introduction

Payins

Payouts

Identity

CRM

Engagement

Courses

Developer

Retrieve ledger account

Authorizations

Path Parameters

Response