latestOpenAPI 3.1.02026-08-08243131.9 MB

c5ddcd5c7e72

Get the authenticated user's one-time (app-OTP) payment by invoice number

read:self. Fetches one of the caller's own payments by Fanvue invoice number. 404 for unknown invoice numbers, another buyer's payment, or pre-migration rows.

get/apps/{appUuid}/payments/me/{invoiceNumber}

Path parameters

appUuidstring uuid required

Example:00000000-0000-4000-8000-000000000001

invoiceNumberstring required

Example:FVE-20260619-1234

Headers

X-Fanvue-API-Versionstring required

Example:2025-06-26

API version to use for the request

Response

The user's one-time payment

uuidstring required

Horizon purchase identifier.

appUuidstring required

UUID of the app the purchase belongs to.

buyerUuidstring required

UUID of the purchasing Fanvue user.

planUuidstring required

UUID of the purchased pricing plan / item.

invoiceNumberstring nullable required

Fanvue invoice number. Use as the idempotency key for fulfilment. Null for purchases that settled before reconciliation was enabled, or not yet settled.

billingReferenceIdstring required

The appotp_… reference minted at checkout.

clientReferenceIdstring required

Merchant-supplied reference passed at checkout via ?client_reference_id=; empty string when unset.

status'pending' | 'completed' | 'failed' | 'refunded' | 'expired' required

Lifecycle status of the one-time purchase.

amountnumber required

Amount in minor currency units, snapshotted at checkout.

currencystring required

ISO currency code.

externalPaymentIdstring required

Provider payment id; empty string until completed.

createdAtstring date-time required

When the purchase was created.

updatedAtstring date-time required

When the purchase was last updated.