Skip to main content
POST
Withdraw a checkout-link refund request
Required scope
  • write:creator — Modify creator profiles, settings, and creator-specific data.

Authorizations

Authorization
string
header
required

OAuth 2.0 access token, presented as a JWT bearer token in the Authorization header. Obtain a token via the authorization-code flow; the scopes granted to the token determine which operations it may call.

Headers

X-Fanvue-API-Version
string
default:2025-06-26
required

API version to use for the request

Example:

"2025-06-26"

Path Parameters

creatorUserUuid
string<uuid>
required
uuid
string<uuid>
required

Fanvue refund-request identifier.

Response

Refund request withdrawn

uuid
string
required

Fanvue's unique refund-request identifier.

paymentId
string
required

Invoice number of the payment this request is against (invoiceNumber).

status
enum<string>
required

Where the request stands. pending is awaiting review; approved means Fanvue accepted it and is reversing the payment; failed means a reversal attempt did not go through and Fanvue is still working it (not a decision against the request); refunded is the money back with the fan, and also fires checkout_link.refund.created; rejected is refused, with the reason in reviewNote; withdrawn is the creator taking their own request back; chargebacked means the fan disputed the payment with their bank before the request was settled, so the money went back through the dispute instead (see the checkout_link.dispute.* events). The Fanvue dashboard shows approved and failed together as "processing".

Available options:
pending,
approved,
failed,
refunded,
rejected,
withdrawn,
chargebacked
reason
enum<string>
required

Why the creator is asking for the payment to be refunded.

Available options:
duplicate,
fraudulent,
requested_by_customer,
other
note
string | null
required

The note the creator sent with the request.

reviewNote
string | null
required

Fanvue's reason for the decision; populated when status is rejected.

createdAt
string<date-time>
required

When the request was opened.

resolvedAt
string<date-time> | null
required

When the request reached a final state, or null while it is still open.