Create refund
Refund all or part of a succeeded payment. Optionally provide an X-Idempotency-Key header so retries with the same key and request return the existing refund.
Authorizations
API key authentication for public API requests.
Keys come in two flavors:
- Legal-entity-scoped keys are pinned to a single legal entity. Minted via the dashboard under a specific entity; every request acts on that entity.
- User-scoped keys are pinned to a user and span every legal
entity that user has access to. Every request made with a
user-scoped key (except
GET /legal-entity, which lists the legal entities the user can access) must include anx-legal-entityheader naming the legal entity the request is operating on. Requests without the header are rejected with400. The authenticated user must have an active permission role on the supplied legal entity, otherwise the request is rejected with403.
Headers
An optional unique key for this refund. Retrying the same request with the same key returns the previously created refund.
Body
Response
OK
The refund object. Its status tracks the refund from creation through completion.
Unique identifier for the refund.
Current refund processing status.
pending, processing, succeeded, failed Refund amount in the smallest unit of currency. Refunds are always in the currency of the payment intent being refunded.
ISO currency code for the refund. Supported currencies are usd and eur.
usd, eur The payment intent being refunded.
ISO-8601 timestamp the refund was created at.
ISO-8601 timestamp the refund last changed status.