Create One-Time Checkout Link

post

https://withpaper.com/api/2022-08-12/checkout-link-intent

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

This API creates a 🔐 One-Time Checkout Link.

Most fields are optional so you can get started quickly and customize as your needs change!

👍
Tip: Render your checkout link in a drawer
Open your new checkout in a drawer on your page in just one function call:
import { renderPaperCheckoutLink } from "@paperxyz/js-client-sdk"

const openCheckout = () => renderPaperCheckoutLink({
  checkoutLinkUrl: "https://withpaper.com/checkout-link-intent/eyJh...",
});

<button onClick={openCheckout}>Buy with Paper</button>

Body Params

contractId

string

required

Defaults to f5b49e5b-2027-44c8-892c-911a17dffbea

The ID of your registered contract. This is not your contract's blockchain address.

title

string

required

Defaults to Mumbai Example

A clear title for this checkout that is shown on the checkout UX, credit card statement, and post-purchase email.

description

string

Defaults to Describe your project *with Markdown!*

A markdown-enabled description shown in the checkout. The description will be truncated to 2,000 characters.

imageUrl

string

Defaults to https://unsplash.it/240/240

An image to display on the checkout page. 240x240px images are preferred. Base64-encoded images, video files, and webpage links are not supported. Requirements: .webp (recommended), .png, .jpg, or .gif under 3 MB.

expiresInMinutes

int32

Defaults to 15

The duration in minutes this link is valid for. Defaults to 15 minutes. Maximum is 43200 minutes (30 days).

limitPerTransaction

int32

Defaults to 5

Limit the quantity a buyer can mint in a single purchase.

twitterHandleOverride

string

Override the Twitter handle shown in the checkout.

successCallbackUrl

string

The URL to navigate the buyer after completing their purchase. Set redirectAfterPayment: true to automatically redirect the buyer.

redirectAfterPayment

boolean

Defaults to false

If true, redirect the buyer to successCallbackUrl after payment, skipping the post-purchase page.

cancelCallbackUrl

string

The URL to navigate a buyer if the checkout link has expired, the NFT has sold out, the buyer is not eligible to purchase, etc.

walletAddress

string

The buyer's wallet address.

string

The buyer's verified email address.

sendEmailOnCreation

boolean

Defaults to false

If true and email is provided, email this Dynamic One-Time Checkout Link to the buyer.

requireVerifiedEmail

boolean

Defaults to false

If true, prompt the buyer to verify their email address.

quantity

int32

Defaults to 1

The quantity to purchase from this link.

metadata

json

Defaults to {}

Arbitrary data to attach to this transaction which is provided in webhook events and on the Developer Dashboard: Purchases page. Requirements: A flat JSON of primitive types values (string, boolean, numeric). Nested objects are not supported.

mintMethod

json

Defaults to { "name": "claimTo", "args": { "_to": "$WALLET", "_quantity": "$QUANTITY", "_tokenId": 0 }, "payment": { "currency": "MATIC", "value": "0.001 * $QUANTITY" } }

Required for custom contracts. Remove this field if your contract type is not CUSTOM_CONTRACT. Details about your contract's method to purchase the NFT. See details.

eligibilityMethod

object

Optional, used only for custom contracts. Details about your smart contract's method to determine whether the buyer is eligible to purchase this NFT. See details.

contractArgs

json

Required for thirdweb Edition Drop, thirdweb Signature Drop, Solana Auction House, and Reservoir contract types. Contract-specific details to complete this purchase. See details

feeBearer

string

enum

Defaults to BUYER

If SELLER, the developer sponsors network and service fees. _Requirement: You have topped up your Sponsored Fees balance on the Developer Dashboard: Developers page. Defaults to BUYER: the buyer pays all fees.

Allowed:

hideNativeMint

boolean

Defaults to false

If true, disallow buyers from minting the NFT directly from the contract from their own wallet.

hidePaperWallet

boolean

Defaults to false

If true, disallow the buyer from sending the NFT to their Paper Wallet.

hideExternalWallet

boolean

Defaults to false

If true, disallow buyers from sending the NFT to their own wallets (MetaMask, WalletConnect, Coinbase Wallet).

hidePayWithCard

boolean

Defaults to false

If true, disallow buyers from paying with a credit card.

hidePayWithCrypto

boolean

Defaults to false

If true, disallow buyers from paying with ETH.

hidePayWithIdeal

boolean

Defaults to true

If true, disallow buyers from paying with iDEAL, a common payment method in the Netherlands. Learn more

sendEmailOnTransferSucceeded

boolean

Defaults to true

If true, Paper will email the buyer when their NFT is delivered. Tip: You can customize this email!

Responses

Tip: Render your checkout link in a drawer

200200

400400