> ## 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.

> ## Agent Instructions
> Treat these docs and the Whop MCP server as the source of truth for Whop API behavior. Don't infer endpoint behavior from marketing pages.
> MCP server: connect https://mcp.whop.com/mcp (streamable HTTP, browser sign-in, no API key in the client config) to search these docs and read or change live Whop data. Setup: https://docs.whop.com/developer/guides/ai_and_mcp.md
> Whop CLI: install with `curl -fsSL https://whop.com/install.sh | sh` to scaffold, run, and deploy Whop apps and websites. It acts on production, not the sandbox. Overview: https://docs.whop.com/cli/overview.md Agent mode: https://docs.whop.com/cli/agent-mode.md
> Hosting: Whop serves a site or app from the build `whop apps deploy` uploads, with rollbacks, secrets, and server logs. Guide: https://docs.whop.com/developer/websites/hosting.md
> Plugins: in Claude Code, run `/plugin marketplace add whopio/plugins`, then `/plugin install whop@whop`. Guide: https://docs.whop.com/developer/guides/plugins/claude-code.md Every agent tool: https://docs.whop.com/developer/ai/overview.md
> Environments: build and test in the sandbox (API `https://sandbox-api.whop.com/api/v1`, keys at https://sandbox.whop.com/dashboard/developer, SDK environment `Sandbox`; no real money). Production (API `https://api.whop.com/api/v1`, keys at https://whop.com/dashboard/developer, SDK environment `Production`, the SDK default) moves real money, so use it only at launch. The two share no accounts, keys, products, or webhooks, and their keys look identical: never mix them. Sandbox guide: https://docs.whop.com/developer/guides/sandbox.md Comparison: https://docs.whop.com/developer/quickstart.md
> API: send `Authorization: Bearer <API_KEY>` from your server only, and pin a dated version with the `Api-Version-Date` header. OpenAPI spec: https://api.whop.com/api/v1/openapi.json
> Which API: build on the Current API, whose pages live under https://docs.whop.com/api-reference/ (start at https://docs.whop.com/api-reference/overview.md). Pages under /api-reference/legacy/ are the Legacy API. Use one only when https://docs.whop.com/api-reference/stability.md lists the resource as Legacy-only.

# Compte de grand livre

> Un compte de grand livre représente un compte financier sur Whop pouvant contenir plusieurs soldes.

```json Example theme={null}
{
	"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"
	},
	"payout_quote_required": true,
	"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
	}
}
```

**balances** `array\<object\>` *required*

Les soldes associés au compte.

**attributs enfants**

**balance** `number` *required*

Le montant du solde.

Exemple : `6.9`

**currency** `Currencies` *required*

La devise du solde.

Options disponibles : `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`, `hnl`

**pending\_balance** `number` *required*

La part du solde en attente.

Exemple : `6.9`

**reserve\_balance** `number` *required*

La part du solde réservée.

Exemple : `6.9`

**id** `string` *required*

L'identifiant unique du compte de grand livre.

Exemple : `ldgr_xxxxxxxxxxxxx`

**ledger\_type** `LedgerTypes` *required*

Le type de compte de grand livre.

Options disponibles : `primary`, `pool`

**owner** `User or Company | null` *required*

Le propriétaire du compte de grand livre.

**Utilisateur**

**id** `string` *required*

L'identifiant unique de l'utilisateur.

Exemple : `user_xxxxxxxxxxxxx`

**name** `string | null` *required*

Le nom d'affichage de l'utilisateur visible sur son profil public.

Exemple : `John Doe`

**typename** `string` *required*

Le nom de type de cet objet

**username** `string` *required*

Le nom d'utilisateur unique de l'utilisateur visible sur son profil public.

Exemple : `johndoe42`

**Entreprise**

**id** `string` *required*

L'identifiant unique de l'entreprise.

Exemple : `biz_xxxxxxxxxxxxxx`

**route** `string` *required*

Slug d'URL de la page boutique du compte. Par exemple, `pickaxe` dans whop.com/pickaxe.

Exemple : `pickaxe`

**title** `string` *required*

Le nom d'affichage de l'entreprise présenté aux clients.

Exemple : `Pickaxe`

**typename** `string` *required*

Le nom de type de cet objet

**payments\_approval\_status** `PaymentsApprovalStatuses | null` *required*

Le statut d'approbation des paiements pour le compte de grand livre.

Options disponibles : `pending`, `approved`, `monitoring`, `rejected`

**payout\_account\_details** `object | null` *required*

Le compte de versement associé au LedgerAccount, le cas échéant.

**attributs enfants**

**address** `object | null` *required*

L'adresse physique associée à ce compte de versement

**attributs enfants**

**city** `string | null` *required*

La ville de l'adresse.

**country** `string | null` *required*

Le pays de l'adresse.

**line1** `string | null` *required*

La ligne 1 de l'adresse.

**line2** `string | null` *required*

La ligne 2 de l'adresse.

**postal\_code** `string | null` *required*

Le code postal de l'adresse.

**state** `string | null` *required*

L'État ou la région de l'adresse.

**business\_name** `string | null` *required*

La raison sociale de l'entreprise

**business\_representative** `object | null` *required*

Le représentant de l'entreprise pour ce compte de versement

**attributs enfants**

**date\_of\_birth** `string | null` *required*

La date de naissance du représentant de l'entreprise au format ISO 8601 (YYYY-MM-DD).

**first\_name** `string | null` *required*

Le prénom du représentant de l'entreprise.

**last\_name** `string | null` *required*

Le nom de famille du représentant de l'entreprise.

**middle\_name** `string | null` *required*

Le deuxième prénom du représentant de l'entreprise.

**email** `string | null` *required*

L'adresse e-mail du représentant

**id** `string` *required*

L'identifiant unique du compte de versement.

Exemple : `poact_xxxxxxxxxxxx`

**latest\_verification** `object | null` *required*

La dernière vérification du compte connecté.

**attributs enfants**

**id** `string` *required*

L'identifiant numérique de l'enregistrement de vérification.

Exemple : `verf_xxxxxxxxxxxxx`

**last\_error\_code** `VerificationErrorCodes | null` *required*

Le code d'erreur le plus récent renvoyé lors de la vérification. Null si aucune erreur ne s'est produite.

Options disponibles : `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`

**last\_error\_reason** `string | null` *required*

Une explication lisible par un humain de l'erreur de vérification la plus récente. Null si aucune erreur ne s'est produite.

Exemple : `Document image was too blurry to read.`

**status** `VerificationStatuses` *required*

Le statut actuel de cette session de vérification.

Options disponibles : `requires_input`, `processing`, `verified`, `canceled`, `created`, `started`, `submitted`, `approved`, `declined`, `resubmission_requested`, `expired`, `abandoned`, `review`, `action_required`, `manual_review`

**phone** `string | null` *required*

Le téléphone du représentant de l'entreprise

**status** `PayoutAccountCalculatedStatuses | null` *required*

Le statut calculé détaillé du compte de versement, reflétant son état actuel de KYC et de capacité à recevoir des versements.

Options disponibles : `connected`, `disabled`, `action_required`, `pending_verification`, `verification_failed`, `manual_review`, `denied`, `not_started`, `blocked_by_parent`

**payout\_quote\_required** `boolean` *required*

Indique si les anciens clients de versement doivent confirmer un devis fourni par le prestataire pour ce compte. REST POST /payouts sur la version d'API 2026-11-03 ou ultérieure exige toujours un quote\_token issu de POST /payouts/quotes, quelle que soit la valeur de cet indicateur.

**settlement\_time\_at** `string\<date-time\> | null` *required*

Le lot de règlement le plus récemment comptabilisé dans le solde disponible de ce compte, à minuit UTC. Chaque paiement réglé dans ce lot porte le même `settlement_time_at`.

Exemple : `2023-12-01T05:00:00.401Z`

**transfer\_fee** `number | null` *required*

Les frais de transfert, le cas échéant.

Exemple : `6.9`

**treasury\_balance** `object | null` *required*

Le cache de soldes associé au compte, par devise.

**attributs enfants**

**balance** `number` *required*

Le montant du solde.

Exemple : `6.9`

**balance\_usd** `number` *required*

Le solde converti en USD.

Exemple : `6.9`

**currency** `Currencies` *required*

La devise du solde.

Options disponibles : `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`, `hnl`

**pending\_balance** `number` *required*

La part du solde en attente.

Exemple : `6.9`

**reserve\_balance** `number` *required*

La part du solde réservée.

Exemple : `6.9`

**total\_withdrawable\_balance** `number` *required*

La part du solde pouvant être retirée.

Exemple : `6.9`


## Related topics

- [Concepts clés de l'API Whop](https://docs.whop.com/fr/developer/concepts.md)
- [Versions de l'API](https://docs.whop.com/fr/developer/api/versioning.md)
- [Versements et flux d'argent](https://docs.whop.com/fr/developer/payouts/overview.md)
