Type alias PaperCreateCheckoutLinkShardParams

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 parameters for creating a paper.xyz checkout link.

Type declaration

  • Optional cancelCallbackurl?: 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.).

  • Optional description?: string

    The description of the checkout.

  • Optional email?: string

    The email address of the recipient.

  • Optional expiresInMinutes?: number

    The time in minutes that the intent will be valid for.

  • Optional feeBearer?: "BUYER" | "SELLER"

    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)

  • Optional imageUrl?: string

    The image that will be displayed on the checkout page.

  • Optional limitPerTransaction?: number

    The maximum quantity the buyer is allowed to purchase in one transaction.

  • Optional metadata?: Record<string, string | number | null>

    Arbitrary data that will be included in webhooks and when viewing purchases in the paper.xyz dashboard.

  • Optional quantity?: number

    The number of NFTs that will be purchased through the checkout flow.

  • Optional redirectAfterPayment?: boolean

    If true, the checkout flow will redirect the user to the successCallbackUrl immediately after successful payment and bypass the final receipt page.

  • Optional sendEmailOnSuccess?: boolean

    If true, Paper will send buyers an email when their purchase is transferred to their wallet. (default: true)

  • Optional successCallbackUrl?: string

    The URL to prompt the user to navigate after they complete their purchase.

  • title: string

    The title of the checkout.

  • Optional twitterHandleOverride?: string

    Override the seller's Twitter handle for this checkout.

  • Optional walletAddress?: string

    The wallet address that the NFT will be sent to.

Settings

Member Visibility

Theme

Generated using TypeDoc