latestOpenAPI 3.1.02026-08-08243131.9 MB

c5ddcd5c7e72

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

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}

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.

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

ISO currency code of the amounts.

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.