FAfanvue

Get a creator's checkout-link payment by invoice number

Changed on

Fetch a single checkout-link payment by its Fanvue invoiceNumber, scoped to the specified creator. Returns 404 if the payment does not exist or does not belong to this creator.

get/creators/{creatorUserUuid}/checkout-links/payments/{invoiceNumber}

Request

  • Base URL
    https://api.fanvue.com
  • URL
    https://api.fanvue.com/creators/{creatorUserUuid}/checkout-links/payments/{invoiceNumber}
  • Auth
    OAuth 2
    Authorization code: https://auth.fanvue.com/oauth2/auth
    Token URL: https://auth.fanvue.com/oauth2/token scopes: read:creator

Path parameters

creatorUserUuidstring uuid required
invoiceNumberstring required

Fanvue payment identifier (invoice number).

Headers

X-Fanvue-API-Versionstring required
Example:2025-06-26

API version to use for the request

Response

The checkout-link payment

invoiceNumberstring required

Fanvue's unique payment identifier. Use this as the idempotency key for fulfilment.

status'pending' | 'succeeded' | 'failed' required

Settlement status of the payment.

billingReason'one_time' | 'subscription_initial' | 'subscription_renewal' required

What the payment was for: a one-off purchase, the first payment of a subscription, or a subscription renewal. Matches the billing_reason on the checkout_link.payment.* webhook.

refundStatus'pending' | 'approved' | 'failed' | 'refunded' | 'rejected' | 'withdrawn' | 'disputed' nullable required

Where this payment stands on being handed back, or null when nothing has been asked for or paid back. The first six values are the status of the payment's most recent refund request (see the refund-requests endpoints); refunded also covers a refund Fanvue issued without a request, and disputed means the fan raised a chargeback, which blocks a refund.

clientReferenceIdstring nullable required

The merchant-supplied reference passed at checkout via ?client_reference_id=. Use it to match the payment to your own order/customer.

grossnumber required

Gross amount the buyer paid, in minor units.

netnumber nullable required

Creator net amount after fees, in minor units.

currencystring nullable required

Informational only — the local currency the fan originally paid in (e.g. 'BRL'). The gross, net, and fee amounts are already converted to USD minor units regardless of this value.

transactionIdstring nullable required

Payment processor transaction reference.

createdAtstring date-time required

When the payment was created.

paidAtstring date-time nullable required

When the payment settled, if it did.

metadataobject required

Arbitrary merchant metadata passed at checkout via ?metadata[key]=value.

Changes