RE:VIVE - Redemption as Settlement

If you wish to use RE:VIVE before its official release, please reach out to [email protected] to request early access as the product is currently under development.
Welcome to the RE:VIVE - Redeem as Settlement section of the API documentation. The RE:DREAMER API documentation below outlines the essential steps to enable your end-users to utilize NFTs as settlement in your web store.
NFT Redemption as Settlement
Redemption process:
1.Select "NFT Redemption" as your preferred settlement method at checkout.
2.The shop will initiate a request to create an RE:VIVE order.
3.You will be redirected to the RE:DREAMER website.
4.On the RE:DREAMER website, connect your wallet.
5.A list of available NFTs for the order will be displayed.
6.Choose an NFT to redeem.
7.RE:DREAMER will redirect you back to the shop after the redemption process is complete.
Prerequisite
To make use of RE:VIVE, a redemption protocol smart contract called RE:VERSE is required. You will need to pass the address of your RE:VERSE smart contract as reverse_address in the request body parameter to create an order. Please contact our team at [email protected] to obtain the reverse_address.
STEP 1: Create an Order
To initiate an order for the product that the end-user wishes to redeem, send a POST request to the following endpoint:
post
/api/v1/revive/:network/orders
Create an Order
Create an order for the product that the end-user wishes to redeem.
Parameters
Path
network*
Unique identifier of the network. Currently only eth is supported.
Header
x-api-key*
API key.
Body
contract_addresses*
Array of String
A list of eligible NFT smart contract addresses that can be used for settlement.
custom_id*
The unique identifier of the order, as provided by the shop owner.
item_name*
The name of the item that the end-user wishes to redeem.
item_url*
A URL of the image of the item that the end-user wishes to redeem.
redirect_link*
A URL that the end-user will be directed to after the redemption process is complete and has been broadcasted to the blockchain network.
reverse_address*
The address of the redemption protocol smart contract that is specifically created for the redemption operator.
Responses
200: OK
STEP 2: List RNFTs for an Order
To retrieve the list of RNFTs eligible for redemption for a specific order, send a GET request to the following endpoint:
get
/api/v1/revive/:network/nfts
List RNFTs for an Order
Returns a list of eligible Redeemable-NFTs (RNFTs) owned by the connected wallet for a specific order.
Parameters
Path
network*
Unique identifier of the network. Currently only eth is supported.
Query
order_uuid*
The unique identifier of the order for which the list of eligible RNFTs is being retrieved.
Header
Authorization*
Bearer ${token}. Replace ${token} with the actual JWT.
Responses
200: OK
STEP 3: Use NFT as Settlement
To use the selected NFT as settlement, send a POST request to the following endpoint:
post
/api/v1/revive/:network/redemption
Use an NFT as settlement for specific order
Parameters
Path
network*
Unique identifier of the network. Currently only eth is supported.
Header
x-api-key*
API key.
Body
contract_address*
The address of the smart contract for the selected NFT.
order_uuid*
The unique identifier of the order for which the list of eligible RNFTs is being retrieved.
redeemer_address*
The address of the user.
reverse_address*
The address of the redemption protocol smart contract that is specifically created for the redemption operator.
token_id*
Integer
Unique identifier for an NFT within a specific smart contract.
user_input_data*
JSON Object
Additional key-value pairs {"key":"value",...} which can be used to store shipping information.
Responses
200: OK

Last modified 1mo ago