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

# Paiement

> Un paiement représente un débit effectué ou tenté. Les paiements suivent le montant, le statut, la devise et le moyen de paiement utilisé.

> [!NOTE]
>
> Cette ressource a un successeur dans l'[API Whop](https://docs.whop.com/fr/api-reference/payments/retrieve-payment-status.md). Cette page reste entièrement prise en charge.

```json Example theme={null}
{
	"amount_after_fees": 6.9,
	"application_fee": {
		"amount": 6.9,
		"amount_captured": 6.9,
		"amount_refunded": 6.9,
		"created_at": "2023-12-01T05:00:00.401Z",
		"currency": "usd",
		"id": "apfee_xxxxxxxxxxxx"
	},
	"auto_refunded": true,
	"billing_address": {
		"city": "<string>",
		"country": "<string>",
		"line1": "<string>",
		"line2": "<string>",
		"name": "<string>",
		"postal_code": "<string>",
		"state": "<string>"
	},
	"billing_reason": "subscription_create",
	"card_brand": "mastercard",
	"card_exp_month": 6,
	"card_exp_year": 2027,
	"card_last4": "4242",
	"checkout_configuration_id": "ch_xxxxxxxxxxxxxxx",
	"company": {
		"id": "biz_xxxxxxxxxxxxxx",
		"route": "<string>",
		"title": "<string>"
	},
	"created_at": "2023-12-01T05:00:00.401Z",
	"currency": "usd",
	"customer_phone": "<string>",
	"decline_code": "insufficient_funds",
	"dispute_alerted_at": "2023-12-01T05:00:00.401Z",
	"disputes": [
		{
			"amount": 6.9,
			"currency": "usd",
			"editable": true,
			"id": "dspt_xxxxxxxxxxxxx",
			"needs_response_by": "2023-12-01T05:00:00.401Z",
			"notes": "Customer used the product for 3 months before disputing.",
			"reason": "Product Not Received",
			"status": "warning_needs_response"
		}
	],
	"failure_message": "<string>",
	"fees": [
		{
			"amount": 6.9,
			"currency": "usd",
			"name": "<string>",
			"type": "payment_processing_percentage_fee"
		}
	],
	"financing_installments_count": 42,
	"financing_transactions": [
		{
			"amount": 6.9,
			"created_at": "2023-12-01T05:00:00.401Z",
			"id": "ptx_xxxxxxxxxxxxxx",
			"status": "succeeded",
			"transaction_type": "purchase"
		}
	],
	"id": "pay_xxxxxxxxxxxxxx",
	"last_payment_attempt": "2023-12-01T05:00:00.401Z",
	"member": {
		"id": "<string>",
		"phone": "<string>"
	},
	"membership": {
		"id": "mem_xxxxxxxxxxxxxx",
		"phone_number": "<string>",
		"status": "trialing"
	},
	"metadata": {},
	"needs_tracking": true,
	"next_payment_attempt": "2023-12-01T05:00:00.401Z",
	"paid_at": "2023-12-01T05:00:00.401Z",
	"payment_instrument": {
		"card": {
			"brand": "<string>",
			"last4": "<string>"
		},
		"display_name": "<string>",
		"icons": {
			"card": {
				"dark": {
					"png_1x": "<string>",
					"png_2x": "<string>",
					"png_4x": "<string>",
					"svg": "<string>"
				},
				"light": {
					"png_1x": "<string>",
					"png_2x": "<string>",
					"png_4x": "<string>",
					"svg": "<string>"
				}
			},
			"square": {
				"dark": {
					"png_1x": "<string>",
					"png_2x": "<string>",
					"png_4x": "<string>",
					"svg": "<string>"
				},
				"light": {
					"png_1x": "<string>",
					"png_2x": "<string>",
					"png_4x": "<string>",
					"svg": "<string>"
				}
			}
		},
		"installment_count": 42,
		"payment_method_type": "<string>"
	},
	"payment_method": {
		"card": {
			"brand": "mastercard",
			"exp_month": 42,
			"exp_year": 42,
			"fingerprint": "<string>",
			"last4": "4242"
		},
		"created_at": "2023-12-01T05:00:00.401Z",
		"id": "payt_xxxxxxxxxxxxx",
		"payment_method_type": "acss_debit"
	},
	"payment_method_type": "acss_debit",
	"payments_failed": 42,
	"plan": {
		"id": "plan_xxxxxxxxxxxxx",
		"internal_notes": "<string>",
		"metadata": {}
	},
	"product": {
		"id": "prod_xxxxxxxxxxxxx",
		"metadata": {},
		"route": "pickaxe-analytics",
		"title": "Pickaxe Analytics"
	},
	"promo_code": {
		"amount_off": 6.9,
		"base_currency": "usd",
		"code": "<string>",
		"id": "promo_xxxxxxxxxxxx",
		"number_of_intervals": 42,
		"promo_type": "percentage"
	},
	"recovery_url": "<string>",
	"refundable": true,
	"refunded_amount": 6.9,
	"refunded_at": "2023-12-01T05:00:00.401Z",
	"refunds": [
		{
			"amount": 6.9,
			"created_at": "2023-12-01T05:00:00.401Z",
			"currency": "usd",
			"id": "rf_xxxxxxxxxxxxxxx",
			"status": "pending"
		}
	],
	"resolutions": [
		{
			"customer_appealed": true,
			"customer_response_actions": ["respond"],
			"due_date": "2023-12-01T05:00:00.401Z",
			"id": "reso_xxxxxxxxxxxxx",
			"issue": "forgot_to_cancel",
			"merchant_appealed": true,
			"merchant_response_actions": ["accept"],
			"platform_response_actions": ["request_buyer_info"],
			"status": "merchant_response_needed"
		}
	],
	"retryable": true,
	"risk_score": 42,
	"risk_signals": {},
	"settlement_amount": 6.9,
	"settlement_currency": "usd",
	"settlement_exchange_rate": 6.9,
	"settlement_time_at": "2023-12-01T05:00:00.401Z",
	"shipment": {
		"carrier": "usps",
		"id": "ship_xxxxxxxxxxxxx",
		"status": "unknown",
		"tracking_number": "9400111899223456789012",
		"tracking_url": "https://track.aftership.com/9400111899223456789012"
	},
	"shipping_address": {
		"city": "<string>",
		"country": "<string>",
		"line1": "<string>",
		"line2": "<string>",
		"name": "<string>",
		"postal_code": "<string>",
		"state": "<string>"
	},
	"sku": "<string>",
	"status": "draft",
	"substatus": "succeeded",
	"subtotal": 6.9,
	"tax_amount": 6.9,
	"tax_behavior": "exclusive",
	"tax_refunded_amount": 6.9,
	"three_ds_verified": true,
	"total": 6.9,
	"updated_at": "2023-12-01T05:00:00.401Z",
	"usd_total": 6.9,
	"user": {
		"email": "john.doe@example.com",
		"id": "user_xxxxxxxxxxxxx",
		"name": "John Doe",
		"username": "johndoe42"
	},
	"verification_checks": {
		"address_line1": "<string>",
		"authorization_code": "<string>",
		"card_holder_name": "<string>",
		"card_security_code": "<string>",
		"zip_code": "<string>"
	},
	"voidable": true
}
```

**amount\_after\_fees** `number` *required*

Le montant du paiement après déduction des frais

Exemple : `6.9`

**application\_fee** `object | null` *required*

Les frais d'application prélevés sur ce paiement.

**attributs enfants**

**amount** `number` *required*

Le montant des frais d'application.

Exemple : `6.9`

**amount\_captured** `number` *required*

Le montant des frais d'application qui a été capturé.

Exemple : `6.9`

**amount\_refunded** `number` *required*

Le montant des frais d'application qui a été remboursé.

Exemple : `6.9`

**created\_at** `string\<date-time\>` *required*

La date et l'heure de création des frais d'application.

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

**currency** `Currencies` *required*

La devise des frais d'application.

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`

**id** `string` *required*

L'identifiant unique des frais d'application.

Exemple : `apfee_xxxxxxxxxxxx`

**auto\_refunded** `boolean` *required*

Indique si ce paiement a été remboursé automatiquement ou non

**billing\_address** `object | null` *required*

L'adresse de l'utilisateur qui a effectué le paiement.

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

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

Le nom du client.

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

Le code postal de l'adresse.

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

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

**billing\_reason** `BillingReasons | null` *required*

La raison, lisible par une machine, pour laquelle ce débit a été créé, comme un achat d'abonnement initial, un cycle de renouvellement ou un paiement unique.

Options disponibles : `subscription_create`, `subscription_cycle`, `subscription_update`, `one_time`, `manual`, `subscription`

**card\_brand** `CardBrands | null` *required*

Réseau de carte indiqué par le processeur (par ex. 'visa', 'mastercard', 'amex'). Présent uniquement lorsque le type de moyen de paiement est 'card'.

Options disponibles : `mastercard`, `visa`, `amex`, `discover`, `unionpay`, `jcb`, `diners`, `link`, `troy`, `visadankort`, `visabancontact`, `china_union_pay`, `rupay`, `jcbrupay`, `elo`, `maestro`, `tarjeta_naranja`, `cirrus`, `nspk_mir`, `verve`, `ebt`, `private_label`, `local_brand`, `uatp`, `wexcard`, `uzcard`, `meeza`, `hrg_store_card`, `girocard`, `fuel_card`, `dankort`, `carnet`, `atm_card`, `china_union_payuzcard`, `codensa`, `cabal`, `hipercard`, `jcblankapay`, `cmi`, `aura`, `accel`, `culiance`, `nyce`, `pulse`, `star`, `eftpos`, `alelo`, `edenred`, `sodexo`, `unknown`

**card\_exp\_month** `integer | null` *required*

Le mois d'expiration (1-12) de la carte utilisée pour ce paiement. Se rabat sur la carte refusée pour les paiements échoués sans carte enregistrée. Null lorsque le paiement n'a pas été effectué par carte ou que la date d'expiration n'est pas disponible.

Exemple : `6`

**card\_exp\_year** `integer | null` *required*

L'année d'expiration à quatre chiffres de la carte utilisée pour ce paiement. Se rabat sur la carte refusée pour les paiements échoués sans carte enregistrée. Null lorsque le paiement n'a pas été effectué par carte ou que la date d'expiration n'est pas disponible.

Exemple : `2027`

**card\_last4** `string | null` *required*

Les quatre derniers chiffres de la carte utilisée pour effectuer ce paiement. Null si le paiement n'a pas été effectué par carte.

Exemple : `4242`

**checkout\_configuration\_id** `string | null` *required*

L'ID de la session/configuration de checkout qui a produit ce paiement, le cas échéant. Utilisez-le pour rattacher les paiements à la configuration de checkout qui les a créés.

Exemple : `ch_xxxxxxxxxxxxxxx`

**company** `object | null` *required*

L'entreprise associée au paiement.

**attributs enfants**

**id** `string` *required*

L'identifiant unique de l'entreprise.

Exemple : `biz_xxxxxxxxxxxxxx`

**route** `string` *required*

Le slug/la route de l'entreprise sur le site Whop.

**title** `string` *required*

Le nom écrit de l'entreprise.

**created\_at** `string\<date-time\>` *required*

La date et l'heure de création du paiement.

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

**currency** `Currencies` *required*

Le code de devise ISO à trois lettres de ce paiement (par ex. 'usd', 'eur').

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`

**customer\_phone** `string | null` *required*

Numéro de téléphone fourni par le client lors du checkout, ou son numéro de téléphone vérifié lorsque votre checkout exige une vérification du téléphone. `null` lorsqu'aucun numéro de téléphone n'a été collecté.

**decline\_code** `PaymentDeclineCodes | null` *required*

La raison pour laquelle le paiement a été refusé. Null si le paiement n'a pas échoué.

Options disponibles : `insufficient_funds`, `lost_card`, `stolen_card`, `expired_card`, `suspected_fraud`, `invalid_card_number`, `invalid_cvc`, `invalid_cvc_or_expiration`, `incorrect_pin`, `authentication_required`, `card_not_supported`, `currency_not_supported`, `duplicate_transaction`, `generic_decline`, `invalid_account`, `invalid_amount`, `processing_error`, `restricted_card`, `card_velocity_exceeded`, `contact_issuer`, `card_declined_by_issuer`, `bank_declined`, `regulatory_blocked`, `transaction_not_permitted`, `transaction_stopped`, `card_type_not_supported`, `issuer_not_found`, `closed_account`, `issuer_unavailable`, `invalid_zip`, `invalid_expiry_month`, `invalid_expiry_year`, `invalid_expiry`, `invalid_transaction`, `cannot_authorize`, `pin_required`, `pin_try_exceeded`, `provider_declined`, `high_risk`, `test_mode_decline`, `merchant_blacklist`, `reenter_transaction`, `invalid_pin`, `pin_required_as`, `withdrawal_count_limit_exceeded`, `invalid_country`, `issuer_error`, `invalid_card_holder_name`, `no_accounts`, `transaction_cancelled`, `three_d_secure_success`, `three_d_secure_canceled`, `three_d_secure_invalid_card_number`, `three_d_secure_generic_error`, `three_d_secure_timeout`, `three_d_secure_failed`, `three_d_secure_card_not_enrolled`, `three_d_secure_fraud`, `three_d_secure_too_many_attempts`, `three_d_secure_rejected_by_bank`, `three_d_secure_reported_lost_or_stolen`, `blocked_by_cardholder`, `test_mode_test_card`, `try_again_later`, `transaction_not_allowed`, `bank_insufficient_funds`, `bank_account_not_found`, `bank_account_closed`, `bank_account_frozen`, `bank_invalid_routing_number`, `bank_non_transaction_account`, `bank_authorization_revoked`, `bank_payment_stopped`, `bank_not_authorized`, `bank_account_holder_deceased`, `bank_duplicate`, `bank_amount_error`, `bank_regulatory_blocked`, `bank_details_invalid`, `bank_processing_error`, `bank_generic_decline`, `sepa_invalid_iban`, `sepa_no_mandate`, `sepa_mandate_data_invalid`, `sepa_disputed`, `sepa_refused_by_customer`, `sepa_generic_decline`

**dispute\_alerted\_at** `string\<date-time\> | null` *required*

Moment où une alerte a signalé que cette transaction allait faire l'objet d'un litige

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

**disputes** `array\<object\> | null` *required*

Les litiges rattachés à ce paiement. Null si l'acteur dans le contexte ne dispose pas de la permission payment:dispute:read.

**attributs enfants**

**amount** `number` *required*

Le montant contesté dans la devise spécifiée, formaté en décimal.

Exemple : `6.9`

**currency** `Currencies` *required*

Le code de devise ISO à trois lettres du montant contesté.

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`

**editable** `boolean | null` *required*

Indique si les preuves du litige peuvent encore être modifiées et soumises.

**id** `string` *required*

L'identifiant unique du litige.

Exemple : `dspt_xxxxxxxxxxxxx`

**needs\_response\_by** `string\<date-time\> | null` *required*

La date limite à laquelle les preuves du litige doivent être soumises. Null si aucune date limite de réponse n'est définie.

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

**notes** `string | null` *required*

Notes libres supplémentaires soumises par l'entreprise dans le cadre des preuves du litige.

Exemple : `Customer used the product for 3 months before disputing.`

**reason** `string | null` *required*

Une raison lisible du litige.

Exemple : `Product Not Received`

**status** `DisputeStatuses` *required*

Le statut actuel du cycle de vie du litige, comme needs\_response, under\_review, won ou lost.

Options disponibles : `warning_needs_response`, `warning_under_review`, `warning_closed`, `needs_response`, `under_review`, `won`, `lost`, `closed`, `other`

**failure\_message** `string | null` *required*

Si le paiement a échoué, la raison de l'échec.

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

Les frais associés à ce paiement spécifique.

**attributs enfants**

**amount** `number` *required*

La valeur ou le montant à afficher pour les frais.

Exemple : `6.9`

**currency** `Currencies` *required*

La devise des frais.

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`

**name** `string` *required*

Le libellé à afficher pour les frais.

**type** `SpecificFeeOrigins` *required*

L'origine spécifique des frais, le cas échéant.

Options disponibles : `stripe_domestic_processing_fee`, `stripe_international_processing_fee`, `stripe_fixed_processing_fee`, `stripe_billing_fee`, `stripe_radar_fee`, `sales_tax_remittance`, `sales_tax_remittance_reversal`, `stripe_sales_tax_fee`, `whop_processing_fee`, `marketplace_affiliate_fee`, `affiliate_fee`, `crypto_fee`, `stripe_standard_processing_fee`, `paypal_fee`, `stripe_payout_fee`, `dispute_fee`, `dispute_alert_fee`, `dispute_representment_fee`, `apple_processing_fee`, `buyer_fee`, `sezzle_processing_fee`, `splitit_processing_fee`, `platform_balance_processing_fee`, `payment_processing_percentage_fee`, `payment_processing_fixed_fee`, `cross_border_percentage_fee`, `fx_percentage_fee`, `orchestration_percentage_fee`, `three_ds_fixed_fee`, `billing_percentage_fee`, `revshare_percentage_fee`, `application_fee`, `high_risk_merchant_fee`, `economic_intelligence_percentage_fee`, `payment_return_fee`

Exemple : `payment_processing_percentage_fee`

**financing\_installments\_count** `integer | null` *required*

Le nombre d'échéances de financement du paiement. Présent si le paiement est un paiement financé (par ex. Splitit, Klarna, etc.).

Exemple : `42`

**financing\_transactions** `array\<object\>` *required*

Les transactions de financement rattachées à ce paiement. Présent si le paiement est un paiement financé (par ex. Splitit, Klarna, etc.).

**attributs enfants**

**amount** `number` *required*

Le montant de la transaction de paiement.

Exemple : `6.9`

**created\_at** `string\<date-time\>` *required*

La date et l'heure de création de la transaction de paiement.

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

**id** `string` *required*

L'identifiant unique de la transaction de paiement.

Exemple : `ptx_xxxxxxxxxxxxxx`

**status** `PaymentTransactionStatuses` *required*

Le statut de la transaction de paiement.

Options disponibles : `succeeded`, `declined`, `error`, `pending`, `created`, `expired`, `won`, `rejected`, `lost`, `prevented`, `canceled`

**transaction\_type** `PaymentTransactionTypes` *required*

Le type de la transaction de paiement.

Options disponibles : `purchase`, `authorize`, `capture`, `refund`, `canceled`, `verify`, `chargeback`, `pre_chargeback`, `three_d_secure`, `fraud_screening`, `authorization`, `installment`, `deposit`

**id** `string` *required*

L'identifiant unique du paiement.

Exemple : `pay_xxxxxxxxxxxxxx`

**last\_payment\_attempt** `string\<date-time\> | null` *required*

L'heure de la dernière tentative de paiement.

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

**member** `object | null` *required*

Le membre rattaché à ce paiement.

**attributs enfants**

**id** `string` *required*

L'identifiant unique du membre de l'entreprise.

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

Le numéro de téléphone du membre, s'il est disponible.

**membership** `object | null` *required*

L'abonnement rattaché à ce paiement.

**attributs enfants**

**id** `string` *required*

L'identifiant unique de l'abonnement.

Exemple : `mem_xxxxxxxxxxxxxx`

**phone\_number** `string | null` *required*

Le numéro de téléphone associé à cet abonnement.

**status** `MembershipStatus` *required*

L'état de l'abonnement.

Options disponibles : `trialing`, `active`, `past_due`, `completed`, `canceled`, `expired`, `unresolved`, `drafted`, `canceling`

**metadata** `object | null` *required*

Les métadonnées personnalisées stockées sur ce paiement. Elles seront copiées dans la configuration de checkout pour laquelle ce paiement a été effectué

**needs\_tracking** `boolean | null` *required*

Indique si ce paiement retient les fonds jusqu'à l'expédition de la commande et n'a pas encore de numéro de suivi.

**next\_payment\_attempt** `string\<date-time\> | null` *required*

L'heure de la prochaine nouvelle tentative de paiement planifiée.

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

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

Le moment où ce paiement a été encaissé avec succès. Null si le paiement n'a pas encore abouti. Sous forme de timestamp Unix.

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

**payment\_instrument** `object | null` *required*

L'instrument avec lequel ce paiement a été effectué, mis en forme pour l'affichage : le type de moyen de paiement, un nom destiné à l'acheteur, le jeu d'icônes standard et les informations de la carte lorsqu'il s'agissait d'une carte. Null lorsque le reçu ne mentionne aucun moyen de paiement.

**attributs enfants**

**card** `object | null` *required*

Paiements par carte uniquement : le réseau de la carte et ses quatre derniers chiffres.

**attributs enfants**

**brand** `string` *required*

L'identifiant du réseau (`visa`, `amex`, …), correspondant aux entrées `card.networks` et aux moyens de paiement par carte enregistrés.

**last4** `string | null` *required*

Les quatre derniers chiffres de la carte, lorsqu'ils ont été capturés.

**display\_name** `string` *required*

Nom de l'instrument destiné à l'acheteur — "Visa •••• 4242" lorsque la carte est connue, sinon le nom propre du moyen de paiement ("Klarna").

**icons** `object` *required*

Le jeu d'icônes standard : formes carrée et carte, chacune en variantes claire et sombre.

**attributs enfants**

**card** `object` *required*

La vignette aux proportions d'une carte bancaire (48x30).

**attributs enfants**

**dark** `object` *required*

La variante de couleurs pour les surfaces sombres.

**attributs enfants**

**png\_1x** `string` *required*

Image matricielle de secours à la taille native de la forme.

**png\_2x** `string` *required*

Image matricielle de secours en double densité.

**png\_4x** `string` *required*

Image matricielle de secours en quadruple densité.

**svg** `string` *required*

Le fichier vectoriel. À privilégier partout où le SVG s'affiche.

**light** `object` *required*

La variante de couleurs pour les surfaces claires.

**attributs enfants**

**png\_1x** `string` *required*

Image matricielle de secours à la taille native de la forme.

**png\_2x** `string` *required*

Image matricielle de secours en double densité.

**png\_4x** `string` *required*

Image matricielle de secours en quadruple densité.

**svg** `string` *required*

Le fichier vectoriel. À privilégier partout où le SVG s'affiche.

**square** `object` *required*

La vignette carrée (32x32).

**attributs enfants**

**dark** `object` *required*

La variante de couleurs pour les surfaces sombres.

**attributs enfants**

**png\_1x** `string` *required*

Image matricielle de secours à la taille native de la forme.

**png\_2x** `string` *required*

Image matricielle de secours en double densité.

**png\_4x** `string` *required*

Image matricielle de secours en quadruple densité.

**svg** `string` *required*

Le fichier vectoriel. À privilégier partout où le SVG s'affiche.

**light** `object` *required*

La variante de couleurs pour les surfaces claires.

**attributs enfants**

**png\_1x** `string` *required*

Image matricielle de secours à la taille native de la forme.

**png\_2x** `string` *required*

Image matricielle de secours en double densité.

**png\_4x** `string` *required*

Image matricielle de secours en quadruple densité.

**svg** `string` *required*

Le fichier vectoriel. À privilégier partout où le SVG s'affiche.

**installment\_count** `integer | null` *required*

Moyens de paiement échelonnés uniquement : le nombre de paiements en lesquels le prélèvement est divisé. Il s'agit d'une donnée, pas d'un texte — composez et traduisez le libellé côté client.

Exemple : `42`

**payment\_method\_type** `string` *required*

L'identifiant du type de moyen de paiement, par ex. `card`, `klarna`, `apple_pay`.

**payment\_method** `object | null` *required*

La référence tokenisée du moyen de paiement utilisée pour ce paiement. Null si aucun token n'a été utilisé.

**attributs enfants**

**card** `object | null` *required*

Les données de carte associées au moyen de paiement, s'il s'agit d'une carte de débit ou de crédit.

**attributs enfants**

**brand** `CardBrands | null` *required*

Le réseau de la carte (par ex. visa, mastercard, amex). Null si la marque n'a pas pu être déterminée.

Options disponibles : `mastercard`, `visa`, `amex`, `discover`, `unionpay`, `jcb`, `diners`, `link`, `troy`, `visadankort`, `visabancontact`, `china_union_pay`, `rupay`, `jcbrupay`, `elo`, `maestro`, `tarjeta_naranja`, `cirrus`, `nspk_mir`, `verve`, `ebt`, `private_label`, `local_brand`, `uatp`, `wexcard`, `uzcard`, `meeza`, `hrg_store_card`, `girocard`, `fuel_card`, `dankort`, `carnet`, `atm_card`, `china_union_payuzcard`, `codensa`, `cabal`, `hipercard`, `jcblankapay`, `cmi`, `aura`, `accel`, `culiance`, `nyce`, `pulse`, `star`, `eftpos`, `alelo`, `edenred`, `sodexo`, `unknown`

**exp\_month** `integer | null` *required*

Le mois d'expiration à deux chiffres de la carte (1-12). Null si non disponible.

Exemple : `42`

**exp\_year** `integer | null` *required*

L'année d'expiration à deux chiffres de la carte (par ex. 27 pour 2027). Null si non disponible.

Exemple : `42`

**fingerprint** `string | null` *required*

Un identifiant stable de la carte sous-jacente. Deux moyens de paiement ayant la même empreinte correspondent à la même carte. Null si non disponible.

**last4** `string | null` *required*

Les quatre derniers chiffres du numéro de carte. Null si non disponible.

Exemple : `4242`

**created\_at** `string\<date-time\>` *required*

La date et l'heure de création du token de paiement.

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

**id** `string` *required*

L'identifiant unique du token de paiement.

Exemple : `payt_xxxxxxxxxxxxx`

**payment\_method\_type** `PaymentMethodTypes` *required*

Le type de moyen de paiement du moyen de paiement

Options disponibles : `acss_debit`, `addi`, `affirm`, `afterpay_clearpay`, `alipay`, `alipayhk`, `alma`, `amazon_pay`, `apple`, `apple_pay`, `au_bank_transfer`, `au_becs_debit`, `bacs_debit`, `bancolombia`, `bancontact`, `bank_wire`, `billie`, `blik`, `boleto`, `bre_b`, `ca_bank_transfer`, `capchase_pay`, `card`, `card_present`, `card_installments_three`, `card_installments_six`, `card_installments_twelve`, `cashapp`, `claritypay`, `coinbase`, `crypto`, `crypto_subscription`, `custom`, `customer_balance`, `demo_pay`, `duitnow_qr`, `efecty`, `eps`, `eu_bank_transfer`, `fpx`, `flex_pay`, `gb_bank_transfer`, `gcash`, `giropay`, `google_pay`, `gopay`, `grabpay`, `id_bank_transfer`, `ideal`, `interac`, `international_bank_wire`, `kakao_pay`, `klarna`, `klarna_pay_now`, `konbini`, `kr_card`, `kr_market`, `kriya`, `kueski`, `link`, `mb_way`, `m_pesa`, `mercado_pago`, `mercado_pago_ar`, `mercado_pago_mx`, `mobilepay`, `modo`, `mondu`, `multibanco`, `naver_pay`, `nequi`, `netbanking`, `ng_bank`, `ng_bank_transfer`, `ng_card`, `ng_market`, `ng_ussd`, `ng_wallet`, `nupay`, `nz_bank_account`, `oney`, `oney_3x`, `oney_4x`, `opay`, `oxxo`, `p24`, `pago_efectivo`, `pse`, `pay_by_bank`, `payco`, `paynow`, `paypal`, `paypal_express`, `paypay`, `payto`, `payto_email`, `payto_phone`, `payto_bank_account`, `pix`, `pix_automatico`, `platform_balance`, `promptpay`, `qris`, `rapipago`, `rechnung`, `revolut_pay`, `samsung_pay`, `satispay`, `scalapay`, `sencillito`, `sepa_debit`, `sequra`, `servipag`, `sezzle`, `shop_pay`, `shopeepay`, `sofort`, `south_korea_market`, `spei`, `splitit`, `sunbit`, `swish`, `tabby`, `tamara`, `touch_n_go`, `twint`, `upi`, `us_bank_account`, `us_bank_transfer`, `venmo`, `verve`, `vipps`, `webpay`, `wechat_pay`, `whop_pay`, `yape`, `zip`, `coinflow`, `unknown`

**payment\_method\_type** `PaymentMethodTypes | null` *required*

Le type d'instrument de paiement utilisé pour ce paiement (par ex. carte, Cash App, iDEAL, Klarna, crypto). Null lorsque le processeur ne fournit pas de type.

Options disponibles : `acss_debit`, `addi`, `affirm`, `afterpay_clearpay`, `alipay`, `alipayhk`, `alma`, `amazon_pay`, `apple`, `apple_pay`, `au_bank_transfer`, `au_becs_debit`, `bacs_debit`, `bancolombia`, `bancontact`, `bank_wire`, `billie`, `blik`, `boleto`, `bre_b`, `ca_bank_transfer`, `capchase_pay`, `card`, `card_present`, `card_installments_three`, `card_installments_six`, `card_installments_twelve`, `cashapp`, `claritypay`, `coinbase`, `crypto`, `crypto_subscription`, `custom`, `customer_balance`, `demo_pay`, `duitnow_qr`, `efecty`, `eps`, `eu_bank_transfer`, `fpx`, `flex_pay`, `gb_bank_transfer`, `gcash`, `giropay`, `google_pay`, `gopay`, `grabpay`, `id_bank_transfer`, `ideal`, `interac`, `international_bank_wire`, `kakao_pay`, `klarna`, `klarna_pay_now`, `konbini`, `kr_card`, `kr_market`, `kriya`, `kueski`, `link`, `mb_way`, `m_pesa`, `mercado_pago`, `mercado_pago_ar`, `mercado_pago_mx`, `mobilepay`, `modo`, `mondu`, `multibanco`, `naver_pay`, `nequi`, `netbanking`, `ng_bank`, `ng_bank_transfer`, `ng_card`, `ng_market`, `ng_ussd`, `ng_wallet`, `nupay`, `nz_bank_account`, `oney`, `oney_3x`, `oney_4x`, `opay`, `oxxo`, `p24`, `pago_efectivo`, `pse`, `pay_by_bank`, `payco`, `paynow`, `paypal`, `paypal_express`, `paypay`, `payto`, `payto_email`, `payto_phone`, `payto_bank_account`, `pix`, `pix_automatico`, `platform_balance`, `promptpay`, `qris`, `rapipago`, `rechnung`, `revolut_pay`, `samsung_pay`, `satispay`, `scalapay`, `sencillito`, `sepa_debit`, `sequra`, `servipag`, `sezzle`, `shop_pay`, `shopeepay`, `sofort`, `south_korea_market`, `spei`, `splitit`, `sunbit`, `swish`, `tabby`, `tamara`, `touch_n_go`, `twint`, `upi`, `us_bank_account`, `us_bank_transfer`, `venmo`, `verve`, `vipps`, `webpay`, `wechat_pay`, `whop_pay`, `yape`, `zip`, `coinflow`, `unknown`

**payments\_failed** `integer | null` *required*

Le nombre de tentatives de paiement échouées pour le paiement.

Exemple : `42`

**plan** `object | null` *required*

Le plan rattaché à ce paiement.

**attributs enfants**

**id** `string` *required*

L'identifiant unique du plan.

Exemple : `plan_xxxxxxxxxxxxx`

**internal\_notes** `string | null` *required*

Une description personnelle ou une section de notes pour l'entreprise.

**metadata** `object | null` *required*

Paires clé-valeur personnalisées stockées sur le plan. Incluses dans les payloads de webhook des événements de paiement et d'abonnement. 50 clés maximum, 100 caractères par clé, 500 caractères par valeur de type chaîne. Les clés réservées `custom_cta` et `custom_cta_url`, lorsqu'elles sont définies, remplacent l'appel à l'action de checkout du produit pour ce plan.

**product** `object | null` *required*

Le produit pour lequel ce paiement a été effectué

**attributs enfants**

**id** `string` *required*

L'identifiant unique du produit.

Exemple : `prod_xxxxxxxxxxxxx`

**metadata** `object | null` *required*

Paires clé-valeur personnalisées stockées sur le produit et incluses dans les payloads de webhook de paiement et d'abonnement. 50 clés maximum, 100 caractères par clé, 500 caractères par valeur de type chaîne.

**route** `string` *required*

Slug d'URL dans le lien public du produit, par ex. `pickaxe-analytics` dans whop.com/company/pickaxe-analytics.

Exemple : `pickaxe-analytics`

**title** `string` *required*

Le nom d'affichage du produit présenté aux clients sur la page produit et dans les résultats de recherche.

Exemple : `Pickaxe Analytics`

**promo\_code** `object | null` *required*

Le code promo utilisé pour ce paiement.

**attributs enfants**

**amount\_off** `number` *required*

Le montant de la remise. L'interprétation dépend de promo\_type : si 'percentage', il s'agit du pourcentage (par ex. 20 signifie 20 % de réduction) ; si 'flat\_amount', il s'agit d'une réduction en dollars (par ex. 10.00 signifie 10,00 \$ de réduction).

Exemple : `6.9`

**base\_currency** `Currencies` *required*

La devise monétaire du code promo.

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`

**code** `string | null` *required*

Le code spécifique utilisé pour appliquer la promotion lors du checkout.

**id** `string` *required*

L'identifiant unique du code promo.

Exemple : `promo_xxxxxxxxxxxx`

**number\_of\_intervals** `integer | null` *required*

Le nombre de mois pendant lesquels la promotion est appliquée.

Exemple : `42`

**promo\_type** `PromoTypes` *required*

Le type (% ou montant fixe) de la promotion.

Options disponibles : `percentage`, `flat_amount`

**recovery\_url** `string | null` *required*

URL hébergée par Whop où l'acheteur peut se connecter et effectuer l'authentification 3D Secure pour un débit hors session contesté par la banque — un renouvellement d'abonnement ou un paiement par carte enregistrée. `null` lorsque la récupération n'est pas disponible ou que vous n'avez pas `member:basic:read`.

**refundable** `boolean` *required*

True uniquement pour les paiements qui sont `paid`, n'ont pas été entièrement remboursés et ont été traités par un processeur de paiement qui autorise les remboursements.

**refunded\_amount** `number | null` *required*

Le montant remboursé du paiement (le cas échéant).

Exemple : `6.9`

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

Le moment où le paiement a été remboursé (le cas échéant).

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

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

Les remboursements émis sur ce paiement, du plus récent au plus ancien, y compris les tentatives de remboursement échouées et annulées. Limité aux 100 plus récents.

**attributs enfants**

**amount** `number` *required*

Le montant remboursé sous forme décimale dans la devise spécifiée, par exemple 10.43 pour 10,43 USD.

Exemple : `6.9`

**created\_at** `string\<date-time\>` *required*

La date et l'heure de création du remboursement.

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

**currency** `Currencies` *required*

Le code de devise ISO à trois lettres du montant remboursé.

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`

**id** `string` *required*

L'identifiant unique du remboursement.

Exemple : `rf_xxxxxxxxxxxxxxx`

**status** `RefundStatuses` *required*

Le statut de traitement actuel du remboursement, comme pending, succeeded ou failed.

Options disponibles : `pending`, `requires_action`, `succeeded`, `failed`, `canceled`

**resolutions** `array\<object\> | null` *required*

Les dossiers du centre de résolution ouverts par le client sur ce paiement. Null si l'acteur dans le contexte ne dispose pas de la permission payment:resolution\_center\_case:read.

**attributs enfants**

**customer\_appealed** `boolean` *required*

Indique si le client a fait appel après la décision de résolution initiale.

**customer\_response\_actions** `array\<ResolutionCenterCaseCustomerResponses\>` *required*

La liste des actions actuellement disponibles pour le client.

Options disponibles : `respond`, `appeal`, `withdraw`

**due\_date** `string\<date-time\> | null` *required*

La date limite à laquelle la prochaine réponse est requise. Null si aucune date limite n'est actuellement active. Sous forme de timestamp Unix.

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

**id** `string` *required*

L'identifiant unique de la résolution.

Exemple : `reso_xxxxxxxxxxxxx`

**issue** `ResolutionCenterCaseIssueTypes` *required*

La catégorie du litige.

Options disponibles : `forgot_to_cancel`, `item_not_received`, `significantly_not_as_described`, `unauthorized_transaction`, `product_unacceptable`

**merchant\_appealed** `boolean` *required*

Indique si le marchand a fait appel après la décision de résolution initiale.

**merchant\_response\_actions** `array\<ResolutionCenterCaseMerchantResponses\>` *required*

La liste des actions actuellement disponibles pour le marchand.

Options disponibles : `accept`, `deny`, `request_more_info`, `appeal`, `respond`

**platform\_response\_actions** `array\<ResolutionCenterCasePlatformResponses\>` *required*

La liste des actions actuellement disponibles pour la plateforme Whop afin de modérer cette résolution.

Options disponibles : `request_buyer_info`, `request_merchant_info`, `merchant_wins`, `merchant_refund`

**status** `ResolutionCenterCaseStatuses` *required*

Le statut actuel du dossier de résolution, indiquant quelle partie doit répondre ou si le dossier est clôturé.

Options disponibles : `merchant_response_needed`, `customer_response_needed`, `merchant_info_needed`, `customer_info_needed`, `under_platform_review`, `customer_won`, `merchant_won`, `customer_withdrew`

**retryable** `boolean` *required*

True lorsque le paiement est `open`, que son processeur peut être débité à nouveau, que son abonnement est `active`, `trialing` ou `past_due` (ou qu'il s'agit d'un paiement initial échoué sur un abonnement `drafted`), qu'il n'est pas payé via un lien de facture et que son unique nouvelle tentative manuelle n'a pas été utilisée. Sert à déterminer si le paiement peut être retenté manuellement. Une nouvelle tentative peut tout de même être refusée lorsque l'entreprise ne peut pas accepter de paiements.

**risk\_score** `integer | null` *required*

Le score de risque de fraude interne de Whop pour ce paiement, de 0 (risque le plus faible) à 100 (risque le plus élevé). Null lorsque le paiement n'a pas été évalué ou que l'évaluation n'est pas encore terminée.

Exemple : `42`

**risk\_signals** `object | null` *required*

Obsolète. Toujours null.

**settlement\_amount** `number` *required*

Le montant total débité au client pour ce paiement, taxes comprises et après application des remises. Dans la devise spécifiée par le champ currency.

Exemple : `6.9`

**settlement\_currency** `Currencies` *required*

Le code de devise ISO à trois lettres de ce paiement (par ex. 'usd', 'eur').

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`

**settlement\_exchange\_rate** `number | null` *required*

Obsolète. Renvoie toujours null.

Exemple : `6.9`

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

Moment où les fonds de ce paiement sont crédités sur le solde disponible de l'entreprise, à minuit UTC. Connu au moment du paiement et ne change jamais. Le champ `posted_at` du webhook `financial_activity.funds_available` porte la même valeur lorsque le règlement qui les libère est comptabilisé — faites-les correspondre pour savoir que ces fonds peuvent désormais être retirés.

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

**shipment** `object | null` *required*

L'expédition rattachée à ce paiement.

**attributs enfants**

**carrier** `string | null` *required*

Le transporteur détecté pour cette expédition. Null jusqu'à ce qu'une mise à jour de suivi l'identifie.

Exemple : `usps`

**id** `string` *required*

L'identifiant unique de l'expédition.

Exemple : `ship_xxxxxxxxxxxxx`

**status** `ShipmentStatuses` *required*

Le statut de livraison actuel de cette expédition.

Options disponibles : `unknown`, `pre_transit`, `in_transit`, `out_for_delivery`, `delivered`, `available_for_pickup`, `return_to_sender`, `failure`, `cancelled`, `error`

**tracking\_number** `string` *required*

Le numéro de suivi attribué par le transporteur, utilisé pour consulter la progression de l'expédition.

Exemple : `9400111899223456789012`

**tracking\_url** `string` *required*

Une URL destinée au client pour suivre la progression de cette expédition.

Exemple : `https://track.aftership.com/9400111899223456789012`

**shipping\_address** `object | null` *required*

L'adresse de livraison fournie par le client pour les biens physiques. Null si aucune adresse de livraison n'a été collectée.

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

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

Le nom du client.

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

Le code postal de l'adresse.

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

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

**sku** `string | null` *required*

Le SKU (unité de gestion de stock) de la variante facturée par ce paiement (le premier article, dans le cas d'un panier), tel que défini par le vendeur. Les comptes pour lesquels les suffixes de SKU selon le motif de facturation sont activés le reçoivent suffixé selon la raison du débit : `-S` pour un premier débit d'abonnement, `-R` pour un renouvellement, `-C` pour un achat unique, `-U` lorsque les métadonnées du paiement lui-même contiennent `upsell: true`, `-F` lorsque rien n'a été débité. Les autres motifs de facturation portent le SKU brut. Null lorsque la variante n'a pas de SKU.

**status** `ReceiptStatus | null` *required*

L'état actuel du cycle de vie de ce paiement (par ex. 'draft', 'open', 'paid', 'void').

Options disponibles : `draft`, `open`, `authorized`, `paid`, `pending`, `uncollectible`, `unresolved`, `void`

**substatus** `FriendlyReceiptStatus` *required*

Le statut lisible du paiement.

Options disponibles : `succeeded`, `requires_capture`, `pending`, `failed`, `blocked`, `past_due`, `canceled`, `price_too_low`, `uncollectible`, `refunded`, `auto_refunded`, `partially_refunded`, `dispute_warning`, `dispute_needs_response`, `dispute_warning_needs_response`, `resolution_needs_response`, `dispute_under_review`, `dispute_warning_under_review`, `resolution_under_review`, `dispute_won`, `dispute_warning_closed`, `resolution_won`, `dispute_lost`, `dispute_closed`, `resolution_lost`, `drafted`, `incomplete`, `unresolved`, `open_dispute`, `open_resolution`

**subtotal** `number | null` *required*

Le sous-total à afficher au créateur (hors frais acheteur).

Exemple : `6.9`

**tax\_amount** `number | null` *required*

Le montant calculé de la taxe de vente/TVA (le cas échéant).

Exemple : `6.9`

**tax\_behavior** `ReceiptTaxBehaviors | null` *required*

Le type d'inclusion de taxe appliqué au paiement, permettant de déterminer si la taxe est incluse dans le prix final ou payée en sus.

Options disponibles : `exclusive`, `inclusive`, `unspecified`, `unable_to_collect`

**tax\_refunded\_amount** `number | null` *required*

Le montant de taxe qui a été remboursé (le cas échéant).

Exemple : `6.9`

**three\_ds\_verified** `boolean` *required*

Indique si l'authentification 3D Secure a été effectuée pour ce paiement.

**total** `number | null` *required*

Le total à afficher au créateur (hors frais acheteur).

Exemple : `6.9`

**updated\_at** `string\<date-time\>` *required*

La date et l'heure de la dernière mise à jour du paiement.

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

**usd\_total** `number | null` *required*

Le total en USD à afficher au créateur (hors frais acheteur).

Exemple : `6.9`

**user** `object | null` *required*

L'utilisateur qui a effectué ce paiement.

**attributs enfants**

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

L'adresse e-mail de l'utilisateur. Nécessite la permission member:email:read. Null si non autorisé.

Exemple : `john.doe@example.com`

**id** `string` *required*

L'identifiant unique de l'utilisateur.

Exemple : `user_xxxxxxxxxxxxx`

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

Le nom d'affichage de l'utilisateur présenté sur son profil public.

Exemple : `John Doe`

**username** `string` *required*

Le nom d'utilisateur unique de l'utilisateur présenté sur son profil public.

Exemple : `johndoe42`

**verification\_checks** `object | null` *required*

Les résultats des vérifications de l'adresse et du code de sécurité de la carte par l'émetteur pour ce paiement. Null lorsque le processeur n'en a renvoyé aucun.

**attributs enfants**

**address\_line1** `string | null` *required*

Indique si l'adresse de facturation saisie par le client correspond à l'adresse enregistrée par l'émetteur.

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

Le code d'autorisation de l'émetteur de la carte pour ce débit. Null lorsque le processeur n'en a pas renvoyé.

**card\_holder\_name** `string | null` *required*

Indique si le nom du titulaire saisi par le client correspond au nom enregistré par l'émetteur.

**card\_security\_code** `string | null` *required*

Indique si le CVV / CVC saisi par le client correspond à la carte.

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

Indique si le code postal de facturation saisi par le client correspond au code postal enregistré par l'émetteur.

**voidable** `boolean` *required*

True lorsque le paiement peut être annulé. La requête est rejetée si le paiement n'est plus éligible.


## Related topics

- [Accepter des paiements](https://docs.whop.com/fr/developer/guides/accept-payments.md)
- [Moyen de paiement](https://docs.whop.com/fr/api-reference/legacy/payment-methods/payment-method.md)
- [Accepter des paiements ponctuels](https://docs.whop.com/fr/developer/guides/ios/accept-one-time-payments.md)
