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

# API Refunds

> Un Refund est une annulation totale ou partielle d'un paiement, émise avec Refund Payment. Il enregistre le montant transféré, le prestataire utilisé et si l'opération a réussi.

Un Refund est une annulation totale ou partielle d'un paiement, émise avec [Refund Payment](https://docs.whop.com/fr/api-reference/payments/refund-payment.md). Il enregistre le montant transféré, le prestataire utilisé et si l'opération a réussi.

Utilisez l'API Refunds pour lister les remboursements d'un paiement ou de l'ensemble d'un compte, et pour récupérer un remboursement précis.

## Endpoints

| Endpoint | Requête |
| - | - |
| [Lister les remboursements](https://docs.whop.com/fr/api-reference/refunds/list-refunds.md) | GET `/refunds` |
| [Récupérer un remboursement](https://docs.whop.com/fr/api-reference/refunds/retrieve-refund.md) | GET `/refunds/{id}` |

## Attributs

**id** `string` *required*

ID du remboursement, préfixé par `rf_`.

**account\_id** `string | null` *required*

Le compte qui a émis le remboursement, préfixé par `biz_`.

**amount** `object | null` *required*

Le montant remboursé tel que réglé, dans la devise de règlement du paiement, afin que les pages de remboursements se compensent avec le `refunded_amount` du paiement. Converti au taux en vigueur au moment de l'émission du remboursement, et non au taux d'origine du paiement. Null uniquement lorsqu'aucun taux de change n'est enregistré pour un ancien paiement multidevise.

> [accordion] Propriétés
>
> **amount** `string` *required*
>
> Le montant en unités principales, sous forme de chaîne décimale exacte. Par
> exemple, `"10.00"` correspond à dix dollars. Il s'agit d'une chaîne afin
> qu'aucun nombre à virgule flottante ne l'arrondisse en transit.
>
> **currency** `string` *required*
>
> Code de devise ISO 4217 à trois lettres, en minuscules.
>
> **decimals** `integer` *required*
>
> Nombre de décimales du montant. Il s'agit de la précision à laquelle le
> prélèvement lui-même est effectué.
>
> **display\_decimals** `integer` *required*
>
> Nombre de décimales à AFFICHER. Généralement égal à `decimals`, mais délibérément pas toujours : le COP est prélevé en centavos mais écrit en pesos entiers, ce qui donne `2` et `0`. Utilisez cette valeur pour formater le nombre selon vos propres paramètres régionaux.

**created\_at** `string` *required*

Date de la demande de remboursement, sous forme d'horodatage ISO 8601.

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

Une explication destinée au marchand indiquant pourquoi le remboursement a
échoué, dans la langue de la requête. Null sauf si le remboursement a échoué
ou a été annulé.

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

Raison de l'échec du remboursement, normalisée pour tous les prestataires. Null sauf si le remboursement a échoué ou a été annulé.

Options disponibles : `bank_declined`, `expired_or_canceled_card`, `lost_or_stolen_card`, `insufficient_funds`, `charge_disputed`, `not_refundable`, `merchant_request`, `unknown`

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

Vos propres données clé-valeur associées lors de la demande de remboursement.

**original\_amount** `object` *required*

Le montant remboursé dans la devise transférée par le processeur.

> [accordion] Propriétés
>
> **amount** `string` *required*
>
> Le montant en unités principales, sous forme de chaîne décimale exacte. Par
> exemple, `"10.00"` correspond à dix dollars. Il s'agit d'une chaîne afin
> qu'aucun nombre à virgule flottante ne l'arrondisse en transit.
>
> **currency** `string` *required*
>
> Code de devise ISO 4217 à trois lettres, en minuscules.
>
> **decimals** `integer` *required*
>
> Nombre de décimales du montant. Il s'agit de la précision à laquelle le
> prélèvement lui-même est effectué.
>
> **display\_decimals** `integer` *required*
>
> Nombre de décimales à AFFICHER. Généralement égal à `decimals`, mais délibérément pas toujours : le COP est prélevé en centavos mais écrit en pesos entiers, ce qui donne `2` et `0`. Utilisez cette valeur pour formater le nombre selon vos propres paramètres régionaux.

**payment\_id** `string` *required*

Le paiement annulé par ce remboursement, préfixé par `pay_`.

**provider** `string` *required*

Le prestataire de paiement qui a traité le remboursement, par exemple `paypal`
ou `coinbase`.

**provider\_created\_at** `string | null` *required*

Date à laquelle le prestataire a créé le remboursement, sous forme
d'horodatage ISO 8601.

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

Raison de l'émission du remboursement, lorsqu'elle est enregistrée.

Options disponibles : `duplicate`, `fraudulent`, `requested_by_customer`, `expired_uncaptured_charge`, `dispute_alert`

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

Indique si une référence de suivi du réseau bancaire est disponible pour ce remboursement.

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

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

Le type de référence de suivi, par exemple un numéro de référence de l'acquéreur.

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

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

La référence de suivi grâce à laquelle la banque de l'acheteur peut retracer
le remboursement.

**status** `string` *required*

Où en est le remboursement auprès du processeur : `pending`, `requires_action`, `succeeded`, `failed` ou `canceled`.

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

**updated\_at** `string` *required*

Date de la dernière modification du remboursement, sous forme d'horodatage ISO 8601.

**visa\_rdr** `boolean` *required*

Vrai lorsque le réseau de cartes a initié le remboursement via Rapid Dispute
Resolution.

```json Refund theme={null}
{
	"id": "rf_xxxxxxxxxxxxxx",
	"payment_id": "pay_xxxxxxxxxxxxxx",
	"account_id": "biz_xxxxxxxxxxxxxx",
	"status": "succeeded",
	"amount": {
		"amount": "49.00",
		"currency": "usd",
		"decimals": 2,
		"display_decimals": 2
	},
	"original_amount": {
		"amount": "49.00",
		"currency": "usd",
		"decimals": 2,
		"display_decimals": 2
	},
	"provider": "stripe",
	"reason": "requested_by_customer",
	"failure_reason": null,
	"failure_message": null,
	"reference_type": "acquirer_reference_number",
	"reference_status": "available",
	"reference_value": "74000006259000123456789",
	"visa_rdr": false,
	"metadata": {
		"refund_id": "ref_8f2k1"
	},
	"provider_created_at": "2026-09-15T14:30:02.000Z",
	"created_at": "2026-09-15T14:30:00.000Z",
	"updated_at": "2026-09-15T14:30:05.000Z"
}
```


## Related topics

- [List refunds](https://docs.whop.com/fr/api-reference/legacy/refunds/list-refunds.md)
- [Retrieve refund](https://docs.whop.com/fr/api-reference/legacy/refunds/retrieve-refund.md)
- [Refund payment](https://docs.whop.com/fr/api-reference/legacy/payments/refund-payment.md)
