🚧

Important:

Request headers are required. See API basics introduction for more information.

Burn asset

Endpoint

POST /burn

• Creates a new Burn request for an asset that is owned by a given user UID associated with the given App (set by the X-API-KEY), to a specific wallet address.
• Returns a new Burn (burn uid) associated.

📘

Note:

The burn request is partly asynchronous - this will immediately return the burn uidand perform the burn of the underlying NFT on the blockchain asynchronously.

To know when the burn has been executed on the blockchain, you can subscribe to the Webhook events or poll any of the Get burn details routes.

🚧

Important:

For executing a burn, the following conditions must have been filled:

• The asset must be minted.
• The asset must be transferable (not already transferring or burned).
• The asset must be owned by the specified user.

Request body

Request example

Sample: request body

{
  "asset_uid": "764893807463",
  "from_user_uid": "110985463782",
}

Response

Response example

Sample: 201 Burned Response

You will receive a uid which refers to the burn details uid:

{
  "success": true,
  "data": {
    "uid": "324167489835", // (burn uid)
  }
}

You can use this uid to call the other Burn endpoints. For example GET /burn/{uid} with this uid will return the burn details.

Example

The following example creates a burn for the asset 123123123123 from user 111111111111.

# API_KEY is your api key
# TOKEN is the access token generated with your api key secret

curl -i \
  -X POST \ 
  -d "{\"asset_uid\":\"123123123123\",\"from_user_uid\":\"111111111111\"}" \
  -H "Content-Type: application/json" \
  -H "X-Api-Key: API_KEY" \
  -H "Authorization: Bearer TOKEN" \
  "https://api.getoriginal.com/v1/burn"