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

# Remboursement

> Un remboursement représente l'annulation totale ou partielle d'un paiement, y compris le montant, le statut et le prestataire de paiement.

```json Example theme={null}
{
	"amount": 6.9,
	"created_at": "2023-12-01T05:00:00.401Z",
	"currency": "usd",
	"id": "rf_xxxxxxxxxxxxxxx",
	"metadata": {},
	"payment": {
		"billing_reason": "subscription_create",
		"card_brand": "mastercard",
		"card_last4": "4242",
		"created_at": "2023-12-01T05:00:00.401Z",
		"currency": "usd",
		"dispute_alerted_at": "2023-12-01T05:00:00.401Z",
		"id": "pay_xxxxxxxxxxxxxx",
		"member": {
			"id": "<string>",
			"phone": "<string>"
		},
		"membership": {
			"id": "mem_xxxxxxxxxxxxxx",
			"status": "trialing"
		},
		"metadata": {},
		"paid_at": "2023-12-01T05:00:00.401Z",
		"payment_method_type": "acss_debit",
		"plan": {
			"id": "plan_xxxxxxxxxxxxx",
			"metadata": {}
		},
		"product": {
			"id": "prod_xxxxxxxxxxxxx",
			"metadata": {}
		},
		"subtotal": 6.9,
		"tax_amount": 6.9,
		"tax_behavior": "exclusive",
		"tax_refunded_amount": 6.9,
		"total": 6.9,
		"usd_total": 6.9,
		"user": {
			"email": "john.doe@example.com",
			"id": "user_xxxxxxxxxxxxx",
			"name": "John Doe",
			"username": "johndoe42"
		}
	},
	"provider": "stripe",
	"provider_created_at": "2023-12-01T05:00:00.401Z",
	"reference_status": "available",
	"reference_type": "acquirer_reference_number",
	"reference_value": "74850120752",
	"status": "pending"
}
```

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

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

Les métadonnées personnalisées jointes lors de la demande de ce remboursement.

**payment** `object | null` *required*

Le paiement d'origine sur lequel ce remboursement a été émis. Null si le paiement n'est plus disponible.

**attributs enfants**

**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\_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`

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

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

**id** `string` *required*

L'identifiant unique du paiement.

Exemple : `pay_xxxxxxxxxxxxxx`

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

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

**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\_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`

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

Le plan rattaché à ce paiement.

**attributs enfants**

**id** `string` *required*

L'identifiant unique du plan.

Exemple : `plan_xxxxxxxxxxxxx`

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

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

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

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

Exemple : `6.9`

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

**provider** `PaymentProviders` *required*

Le prestataire de paiement qui a traité le remboursement.

Options disponibles : `stripe`, `coinbase`, `paypal`, `apple`, `sezzle`, `splitit`, `platform_balance`, `multi_psp`, `adyen`, `claritypay`, `flex_pay`, `checkout_dot_com`, `airwallex`, `coinflow`, `sequra`, `dlocal`, `masspay`, `braintree`

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

L'horodatage de création du remboursement dans le système du prestataire de paiement. Null si non fourni par le prestataire.

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

**reference\_status** `RefundReferenceStatuses | null` *required*

Le statut de disponibilité de la référence de suivi du remboursement fournie par le processeur de paiement. Null si aucune référence n'a été fournie.

Options disponibles : `available`, `pending`, `unavailable`

**reference\_type** `RefundReferenceTypes | null` *required*

Le type de référence de suivi fourni par le processeur de paiement, comme un numéro de référence de l'acquéreur. Null si aucune référence n'a été fournie.

Options disponibles : `acquirer_reference_number`, `retrieval_reference_number`, `system_trace_audit_number`

**reference\_value** `string | null` *required*

La valeur de la référence de suivi fournie par le processeur de paiement, utilisée pour suivre le remboursement à travers les réseaux bancaires. Null si aucune référence n'a été fournie.

Exemple : `74850120752`

**status** `RefundStatuses` *required*

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

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


## Related topics

- [Remboursements et litiges](https://docs.whop.com/fr/developer/guides/refunds-and-disputes.md)
- [API Activité financière](https://docs.whop.com/fr/api-reference/ledgers/ledger-activity.md)
- [Devise de règlement préférée](https://docs.whop.com/fr/developer/payouts/preferred-settlement-currency.md)
