PaperCreateCheckoutLinkShardParams
The parameters for creating a paper.xyz checkout link.
type PaperCreateCheckoutLinkShardParams = { cancelCallbackurl?: string; description?: string; email?: string; expiresInMinutes?: number; feeBearer?: "BUYER" | "SELLER"; imageUrl?: string; limitPerTransaction?: number; metadata?: Record<string, string | number | null>; quantity?: number; redirectAfterPayment?: boolean; sendEmailOnSuccess?: boolean; successCallbackUrl?: string; title: string; twitterHandleOverride?: string; walletAddress?: string;};
The URL to redirect (or prompt the user to navigate) if the checkout link is expired or the buyer is not eligible to purchase (sold out, not allowlisted, sale not started, etc.).
type cancelCallbackurl = string;
The description of the checkout.
type description = string;
The email address of the recipient.
type email = string;
The time in minutes that the intent will be valid for.
type expiresInMinutes = number;
Determines whether the buyer or seller pays the network and service fees for this purchase. The seller will be billed if set to SELLER. (default: BUYER )
type feeBearer = "BUYER" | "SELLER";
The image that will be displayed on the checkout page.
type imageUrl = string;
The maximum quantity the buyer is allowed to purchase in one transaction.
type limitPerTransaction = number;
Arbitrary data that will be included in webhooks and when viewing purchases in the paper.xyz dashboard.
type metadata = Record<string, string | number | null>;
The number of NFTs that will be purchased through the checkout flow.
type quantity = number;
If true, the checkout flow will redirect the user to the successCallbackUrl immediately after successful payment and bypass the final receipt page.
type redirectAfterPayment = boolean;
If true, Paper will send buyers an email when their purchase is transferred to their wallet. (default: true)
type sendEmailOnSuccess = boolean;
The URL to prompt the user to navigate after they complete their purchase.
type successCallbackUrl = string;
The title of the checkout.
type title = string;
Override the seller's Twitter handle for this checkout.
type twitterHandleOverride = string;
The wallet address that the NFT will be sent to.
type walletAddress = string;