Paper Checkout
Search…
Checkout API

Quickstart

  1. 1.
    When your app has a new NFT to sell, create a checkout:
  2. 2.
    Link the buyer to the provided checkout link on your website or app.
Sample cURL
1
$ curl --request POST \
2
--url https://paper.xyz/api/v1/checkout \
3
--header 'Authorization: Bearer YOUR-API-KEY' \
4
--header 'Content-Type: application/json' \
5
--data '{
6
"contractAddress": "0x87D549BF461c9Bb6018a7469Ef20FBA2b988c9E5",
7
"contractChain": "Polygon",
8
"collectionTitle": "My First Checkout",
9
"contractType": "THIRDWEB_NFT_DROP_V2",
10
"successCallbackUrl": "https://paper.xyz?success",
11
"priceValue": 0.01,
12
"priceCurrency": "MATIC"
13
}'
14
​
15
// Status 200 response:
16
{
17
"checkoutUrl": "https://paper.xyz/checkout/6b141def-9102-45c6-8bbf-07154e380420",
18
"result": {
19
"id": "6b141def-9102-45c6-8bbf-07154e380420",
20
"createdAt": "2022-04-07T01:47:16.529986+00:00",
21
...
22
}
23
}
Copied!
​

Summary

If your app has recurring and dynamic NFTs to sell, the API allows you to automate creation of checkout links.
You can also create, edit, delete, and view your checkouts in the Dashboard.
Some advanced options targeted at developers, like One-Time Checkout Links, are only available when creating checkouts with the API.
​
get
https://paper.xyz/api/v1
/checkout
List checkouts
get
https://paper.xyz/api/v1
/checkout/:checkoutId
Get checkout flow
post
https://paper.xyz/api/v1
/checkout
Create checkout
post
https://paper.xyz/api/v1
/checkout/:checkoutId
Edit checkout
delete
https://paper.xyz/api/v1
/checkout/:checkoutId
Delete checkout