Skip to main content
POST
Refund a payment

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

Idempotency-Key
string | null

Optional. Makes a retry of the same action safe. Send a new random value (e.g. a UUID) for each user action and repeat it on retries of that action. A repeat with the same key and the same request returns the first response (same status and body) and does nothing else: no second Stripe call, ledger write or event. A concurrent repeat waits for the first request and then returns its response. The key is scoped to the team, the acting user, the operation and the target resource; reusing it on another resource is a new request. Errors: 422 idempotency_key_invalid (blank or over 255 characters); 409 idempotency_key_conflict (the key was already used with a different request); 409 idempotency_request_in_progress (Stripe still processing an earlier request with this key; retry later with the same key). A request that fails with an error stores nothing, so the same key can be retried. Refund and cancel keys are kept permanently; webhook-replay keys expire after 24 hours. Without the header the route behaves as before.

Path Parameters

team_id
string
required
hub_id
string
required
payment_id
string
required

Body

application/vnd.api+json
data
RefundRequestResource · object
required

Response

Successful Response

data
PaymentResource · object
required