# Venly Documentation > Explore Venly: Your Hub for Seamless Blockchain Solutions. Simplify Wallet Integration, NFT Creation, and Secure Credit Card Payments with our Developer-Friendly APIs and Widgets. ## Guides - [Welcome to Venly!](https://docs.venly.io/docs/what-is-venly.md): A short introduction to the world of Venly. - [Developer Portal](https://docs.venly.io/docs/developer-portal.md): Introduction to the developer portal features. - [Pricing](https://docs.venly.io/docs/pricing.md): How does Venly pricing work? - [Self-Custody Infrastructure](https://docs.venly.io/docs/infrastructure.md): Be the owner of your funds without compromising speed and security using Venlys' self-custody infrastructure - [Pincode Management](https://docs.venly.io/docs/pincode-management.md): This guide describes the different use cases for pincode management of your end-users. - [Private Key Management](https://docs.venly.io/docs/private-key-management.md) - [Quickstart Guide](https://docs.venly.io/docs/getting-started-with-venly.md): Jumpstart Your Venly Journey and Get Up and Running Quickly! - [Authentication](https://docs.venly.io/docs/authentication.md): Learn how to authenticate with different Venly products. - [API Authentication](https://docs.venly.io/docs/api-authentication.md): Learn how to authenticate with our API - [Widget Authentication](https://docs.venly.io/docs/widget-authentication.md): Learn how to authenticate with our Widget. - [API Security Best Practices](https://docs.venly.io/docs/api-security-best-practices.md): This explainer highlights important security practices that everyone should try to implement to reduce the risk of unauthorized access and potential security threats for APIs. - [Integrations](https://docs.venly.io/docs/integrations.md): Providing integrations across diverse industries, from gaming and E-commerce to loyalty programs and workflow automation - [Zapier: No-Code Blockchain Automation](https://docs.venly.io/docs/zapier-integration.md): Learn how to automate blockchain tasks with Venly and Zapier. Create NFTs, mint tokens, and deploy smart contracts without writing code, using simple workflows for various use cases. - [Zapier: Mint NFTs](https://docs.venly.io/docs/zapier-nft-creation-minting-guide.md): This guide describes how you can use Zapier to create contracts and mint NFTs - [Airtable x Venly](https://docs.venly.io/docs/airtable-venly-zapier-integration.md): This step-by-step guide explains how you can mint and distribute NFTs, using Airtable. - [Eventbrite x Venly](https://docs.venly.io/docs/eventbrite-venly-zapier-integration.md): This step-by-step guide explains how you can mint and distribute welcome NFTs whenever a new attendee purchases your ticket, using Eventbrite. - [Google Forms x Venly](https://docs.venly.io/docs/google-forms-venly-zapier-integration.md): This step-by-step guide explains how you can mint and distribute NFTs whenever someone submits a form, using Google Forms. - [Mailchimp x Venly](https://docs.venly.io/docs/mailchimp-venly-zapier-integration.md): This step-by-step guide explains how you can mint and distribute welcome NFTs whenever someone subscribes to your mails, using Mailchimp. - [Monday.com x Venly](https://docs.venly.io/docs/mondaycom-venly-zapier-integration.md): This step-by-step guide explains how you can mint and distribute welcome NFTs using Monday.com. - [Google Sheets x Venly](https://docs.venly.io/docs/google-sheets-venly-zapier-integration.md): This step-by-step guide explains how to mint and distribute NFTs, using Google Sheets. - [Zapier: Mint ERC20 Tokens](https://docs.venly.io/docs/zapier-integration-erc20-minting.md): This guide describes hwo to use the Zapier integration for ERC20 minting. - [Sitemanager](https://docs.venly.io/docs/sitemanager.md): Create mint pages in minutes, all no-code. (Additional features releasing soon!) - [How to set up NFT project](https://docs.venly.io/docs/how-to-set-up-nft-project-with-sitemanager.md): This guide describes how to set up your NFT project with the SiteManager integration. - [How to update an NFT collection](https://docs.venly.io/docs/how-to-update-an-nft-collection-with-sitemanager.md): This guide describes how you can edit/update an existing NFT collection for your project. - [How to update token template](https://docs.venly.io/docs/how-to-update-token-template-with-sitemanager.md): This guide describes how to update/edit the token template for your project. - [How to token gate content](https://docs.venly.io/docs/how-to-token-gate-content-sitemanager.md): This guide describes how to token gate content for Sitemanager integration. - [How to add a new NFT collection](https://docs.venly.io/docs/how-to-add-a-new-nft-collection-sitemanager.md): This guide describes how to add a new NFT collection to your Sitemanager website. - [How to add a new token template](https://docs.venly.io/docs/how-to-add-a-new-token-template-sitemanager.md): This guide describes how to add a new NFT token template to your Sitemanager website. - [MoonPay](https://docs.venly.io/docs/moonpay.md): Create onramp and offramp URLs with the MoonPay integration. - [Transak](https://docs.venly.io/docs/transak.md): Create onramp and offramp URLs with the Transak integration. - [Ramp Network](https://docs.venly.io/docs/ramp-network.md): Create onramp and offramp URLs with the Ramp Network integration. - [SDKs](https://docs.venly.io/docs/sdk-overview.md): Accelerate Integration, Save Time, and Focus on Your App - [C#](https://docs.venly.io/docs/c-sdk.md): Effortless SDK Integration: Mastering Wallets, NFTs and Payments with C# - [Async Operations](https://docs.venly.io/docs/async-operations.md) - [Javascript / Typescript](https://docs.venly.io/docs/js-sdk.md): Effortless SDK Integration: Mastering Wallets, NFTs and Payments with Javascript or Typescript - [Faucets](https://docs.venly.io/docs/faucets.md): In this guide you'll learn what is a faucet, how to use it and how to get testnet tokens - [Networks & URLs](https://docs.venly.io/docs/environments.md): More details about our Sandbox and Production environment and supported blockchains. - [Testnet Assets](https://docs.venly.io/docs/blockchain-testnet-assets.md): Receive testnet assets and start testing immediately when you sign up with Venly! - [Overview](https://docs.venly.io/docs/widget-overview.md): The widget explained. - [Integration](https://docs.venly.io/docs/integrating-widget.md): Learn how to integrate the Venly Widget with your app. - [Configuration](https://docs.venly.io/docs/configuration.md): Configuring and customising the widget - [Getting started](https://docs.venly.io/docs/widget-getting-started.md): Learn how to get up and running with the native integration of the Venly Widget. - [Initializing the widget](https://docs.venly.io/docs/initializing-widget.md): Getting started with Venly Connect, our JavaScript Widget for easy integration. - [Selecting Environments and Networks](https://docs.venly.io/docs/selecting-environments-and-networks.md): Describes how to select a production or sandbox environment for the Widget. - [Authenticating with Venly](https://docs.venly.io/docs/authenticating-widget-with-venly.md): Authenticating with Venly and types of authentication - [User authentication](https://docs.venly.io/docs/widget-user-authentication.md): Authenticate a user using the Widget. - [Retrieve user profile](https://docs.venly.io/docs/retrieve-user-profile.md): How to retrieve a user's profile. - [Retrieve user wallets](https://docs.venly.io/docs/retrieve-user-wallets.md): How to retrieve a user's wallets. - [Retrieve wallet balance](https://docs.venly.io/docs/retrieve-wallet-balance.md): How to retrieve the native balance of a wallet - [Retrieve a user account](https://docs.venly.io/docs/retrieve-a-user-account.md): How to retrieve a user account - [Retrieve token balance](https://docs.venly.io/docs/retrieve-token-balance.md): How to retrieve the balance of a token for a wallet - [Retrieve non-fungible tokens](https://docs.venly.io/docs/retrieve-non-fungible-tokens.md): How to retrieve non-fungible tokens for a wallet. - [Sign a message](https://docs.venly.io/docs/sign-a-message.md): How to ask users to sign a message. - [Sign an EIP712 message](https://docs.venly.io/docs/sign-an-eip712-message.md): How to ask users to sign an EIP712 structured message. - [Execute Transactions](https://docs.venly.io/docs/execute-transactions.md): This page describes how you can perform a transaction on chain - [Transfer a native token](https://docs.venly.io/docs/transfer-a-native-token.md): How to perform a basic transfer. E.g transfer ETH from one wallet to another. - [Transfer a ERC20 token](https://docs.venly.io/docs/transfer-a-fungible-token.md): How to perform a fungible transfer. E.g transfer an ERC20 token from one wallet to another. - [Transfer an NFT](https://docs.venly.io/docs/transfer-a-non-fungible-token.md): How to perform a non-fungible transfer. E.g transfer an ERC721 or ERC1155 token from one wallet to another. - [Call a Contract](https://docs.venly.io/docs/call-a-contract.md): How to perform a contract call. - [Chain specific fields](https://docs.venly.io/docs/chain-specific-fields.md): Overview of supported blockchains that support contract calls and their chain specific details. - [Ethers.js](https://docs.venly.io/docs/ethersjs.md): Overview, installation, and initialization settings for ethers.js - [Wagmi](https://docs.venly.io/docs/wagmi.md): Overview and initialization for Wagmi. - [Web3-React](https://docs.venly.io/docs/web3-react.md): Overview, installation, and initialization settings for web3-react. - [Web3Modal (WalletConnect)](https://docs.venly.io/docs/web3modal-walletconnect.md): Overview and initialization setting for web3modal. - [Web3.js](https://docs.venly.io/docs/web3js.md): Already have support for Web3? GREAT 🎉, this is the place to start. - [Web3onboard](https://docs.venly.io/docs/web3onboard.md): Overview and installation for web3-onboard. - [addOnTokenRefreshCallback](https://docs.venly.io/docs/addontokenrefreshcallback.md): Receive a callback when the bearer token refreshes. - [authenticate](https://docs.venly.io/docs/authenticate.md): Authenticate a user to Venly. - [checkAuthenticated](https://docs.venly.io/docs/checkauthenticated.md): Check if a user is authenticated in Venly. - [createSigner (deprecated)](https://docs.venly.io/docs/createsigner.md): Create a Signer object. - [executeContract](https://docs.venly.io/docs/executecontract.md): Execute a contract call. - [executeGasTransfer](https://docs.venly.io/docs/executegastransfer.md): Transfer gas from one destination to another. - [executeNftTransfer](https://docs.venly.io/docs/executenfttransfer.md): Transfer a non-fungible token from one destination to another. - [executeTokenAssociation](https://docs.venly.io/docs/executetokenassociation.md): Associate a token to a Hedera account. - [executeTokenTransfer](https://docs.venly.io/docs/executetokentransfer.md): Transfer a fungible token from one destination to another. - [executeTransfer](https://docs.venly.io/docs/executetransfer.md): Transfer the native token of a blockchain from one destination to another. - [getAccount](https://docs.venly.io/docs/getaccount.md): Authenticate, and get the wallets of a user for a specific chain. - [getAllNonFungibles](https://docs.venly.io/docs/getallnonfungibles.md) - [getBalance](https://docs.venly.io/docs/getbalance.md): Fetch the native balance of a wallet. - [getBalanceByAddress](https://docs.venly.io/docs/getbalancebyaddress.md): Fetch the native balance of a wallet. - [getNonfungibles](https://docs.venly.io/docs/getnonfungibles.md): Fetch non-fungible items by wallet ID. - [getNonfungiblesByAddress](https://docs.venly.io/docs/getnonfungiblesbyaddress.md): Fetch non-fungible items by wallet address. - [getProfile](https://docs.venly.io/docs/getprofile.md): Fetch a user's profile - [getTokenBalance](https://docs.venly.io/docs/gettokenbalance.md): Fetch the balance of a specific token (ERC20 standard) on a specific wallet. - [getTokenBalanceByAddress](https://docs.venly.io/docs/gettokenbalancebyaddress.md): Fetch the balance of a specific token (ERC20 standard) on a specific wallet by address. - [getTokenBalances](https://docs.venly.io/docs/gettokenbalances.md): Fetch the token balances (ERC20 standard) for a specific wallet. - [getTokenBalancesByAddress](https://docs.venly.io/docs/gettokenbalancesbyaddress.md): Fetch the token balances (ERC20 standard) for a specific wallet by address. - [getTransactionStatus](https://docs.venly.io/docs/gettransactionstatus.md): Fetch transaction status. - [getWallet](https://docs.venly.io/docs/getwallet.md): Fetch a specific wallet - [getWallets](https://docs.venly.io/docs/getwallets.md): Fetch all the wallets for a specifc user - [importWallet](https://docs.venly.io/docs/importwallet-1.md): Imports a wallet from one chain into another - [linkWallets](https://docs.venly.io/docs/linkwallets.md): Link a user wallet to your application - [logout](https://docs.venly.io/docs/logout.md): Log the user out of Venly. - [manageWallets](https://docs.venly.io/docs/managewallets.md): Manage a user's wallets for a specific application. - [readContract](https://docs.venly.io/docs/readcontract-1.md): Call a read function on a contract. - [signEip712](https://docs.venly.io/docs/signeip712.md): Signing an EIP712 structured message. - [signMessage](https://docs.venly.io/docs/signmessage.md): Sign a message - [unlink](https://docs.venly.io/docs/unlink.md): Unlink a wallet from an application. - [Account](https://docs.venly.io/docs/account.md) - [AuthenticationOptions](https://docs.venly.io/docs/authenticationoptions.md) - [AuthenticationResult](https://docs.venly.io/docs/authenticationresult.md) - [ConstructorOptions](https://docs.venly.io/docs/constructoroptions.md) - [ContractExecutionDto](https://docs.venly.io/docs/contractexecutiondto.md): Data structure for performing a contract call on a blockchain - [ContractReadRequest](https://docs.venly.io/docs/contractreadrequest.md): Data structure as input for performing a contract read on a blockchain. - [ContractReadResponse](https://docs.venly.io/docs/contractreadresponse.md): Data structure returned when performing a contract read on a blockchain. - [Eip712SignRequestDto](https://docs.venly.io/docs/eip712signrequestdto.md) - [GasTransferRequestDto](https://docs.venly.io/docs/gastransferrequestdto.md): Data structure for performing a gas transfer. - [HederaTokenAssociationRequest](https://docs.venly.io/docs/hederatokenassociationrequest.md): Data structure for performing a Hedera token association. - [ImportWalletRequest](https://docs.venly.io/docs/importwalletrequest.md): Data structure for performing an import wallet. - [KeycloakInstance](https://docs.venly.io/docs/keycloakinstance.md) - [MessageSignRequestDto](https://docs.venly.io/docs/messagesignrequestdto.md) - [NFT](https://docs.venly.io/docs/nft.md): This page describes an NFT. - [NFTContract](https://docs.venly.io/docs/nftcontract.md): This object describes the properties of an NFT contract. - [NftTransferRequestDto](https://docs.venly.io/docs/nfttransferrequestdto.md): Data structure for performing a non-fungible token transfer. - [PopupOptions](https://docs.venly.io/docs/popupoptions.md) - [PopupResult](https://docs.venly.io/docs/popupresult.md) - [Profile](https://docs.venly.io/docs/profile.md) - [SecretType](https://docs.venly.io/docs/secrettype.md): Enum that identifies the blockchain (secret type). - [Signer (deprecated)](https://docs.venly.io/docs/signer.md) - [SignerResult (deprecated)](https://docs.venly.io/docs/signerresult.md) - [RedirectOptions](https://docs.venly.io/docs/redirectoptions.md) - [TokenBalance](https://docs.venly.io/docs/tokenbalance.md) - [TokenTransferRequestDto](https://docs.venly.io/docs/tokentransferrequestdto.md): Data structure for performing a fungible token transfer. - [Trait](https://docs.venly.io/docs/trait.md) - [TransferRequestDto](https://docs.venly.io/docs/transferrequestdto.md): Data structure for performing a native token transfer. - [TxStatusResult](https://docs.venly.io/docs/txstatusresult.md) - [VenlySubProviderOptions](https://docs.venly.io/docs/venlysubprovideroptions.md) - [Wallet](https://docs.venly.io/docs/wallet.md) - [WalletBalance](https://docs.venly.io/docs/walletbalance.md) - [WalletItems](https://docs.venly.io/docs/walletitems.md): Object that contains all the items for a wallet - [WindowMode](https://docs.venly.io/docs/windowmode.md) - [Overview](https://docs.venly.io/docs/wallet-api-overview.md): A small introduction to the Wallet-API. - [Getting started](https://docs.venly.io/docs/wallet-api-getting-started.md): Covering the basics from authentication to creating your first wallet - [User Management](https://docs.venly.io/docs/user-management.md): This guide will take you through the API calls for creating, deleting, updating, and managing users. - [Signing Methods](https://docs.venly.io/docs/signing-methods.md): In this guide, we discuss the types of signing methods, it's uses, how to configure them, and how to use them in API calls. - [Wallet Testnet Assets](https://docs.venly.io/docs/testnet-assets.md): Get up and running quickly with our Wallet API. - [Create a user](https://docs.venly.io/docs/create-a-user.md): How to create a new user. - [Retrieve a user](https://docs.venly.io/docs/retrieve-a-user.md): Get information about a specific user. - [Update a user](https://docs.venly.io/docs/update-users-reference.md): How to update your user's reference. - [Delete a user](https://docs.venly.io/docs/delete-a-user.md): How to delete one of your users. - [Create a signing method](https://docs.venly.io/docs/create-users-signing-method.md): How to create signing methods for your users. - [Update a signing method](https://docs.venly.io/docs/update-users-signing-method.md): How to update your user's signing method. - [Delete a signing method](https://docs.venly.io/docs/delete-users-signing-method.md): How to delete your user's signing method. - [Create a wallet](https://docs.venly.io/docs/create-a-wallet.md): How to create a new blockchain wallet. - [Retrieve wallet](https://docs.venly.io/docs/retrieve-a-wallet.md): Retrieve a single wallet using its unique id. - [Archive a wallet](https://docs.venly.io/docs/unarchive-a-wallet.md): How to archive or unarchive a wallet. - [Import a wallet](https://docs.venly.io/docs/import-a-wallet.md): How to import an existing wallet. - [Export a wallet](https://docs.venly.io/docs/export-a-wallet.md): How to export an existing wallet. - [Retrieve native balance](https://docs.venly.io/docs/retrieve-native-wallet-balance.md): How to retrieve the native balance of a wallet. - [Retrieve ERC20 tokens](https://docs.venly.io/docs/retrieve-erc20-token-balance.md): How to retrieve the token balances for a wallet (ERC20 standard). - [Retrieve NFTs](https://docs.venly.io/docs/retrieve-non-fungible-tokens-1.md): How to retrieve non-fungible tokens for a wallet. - [Transfer a native token](https://docs.venly.io/docs/transfer-a-native-token-1.md): How to perform a basic token transfer. E.g transfer ETH from one wallet to another. - [Transfer an ERC20 token](https://docs.venly.io/docs/transfer-an-erc20-token.md): How to transfer an ERC20 token from wallet to another. - [Transfer an NFT](https://docs.venly.io/docs/transfer-a-non-fungible-token-1.md): How to perform a non-fungible transfer. E.g transfer an ERC721 or ERC1155 token from one wallet to another. - [Transfer a fungible token](https://docs.venly.io/docs/transfer-a-fungible-token-1.md): How to perform a fungible token transfer. E.g transfer ERC1155 token from one wallet to another. - [Signatures](https://docs.venly.io/docs/signatures.md): Sign data using your wallet. You can sign an arbitrary message or and EIP712 message. - [Read a contract](https://docs.venly.io/docs/read-contract.md): Endpoint that allows you to read contract functions. - [Execute a contract call](https://docs.venly.io/docs/execute-contract-call.md): An endpoint to execute a function on a smart contract (write) on any (supported) blockchain. As a result, a new transaction will be submitted to the network containing the smart contract execution. - [Get Transaction status](https://docs.venly.io/docs/get-transaction-status.md): Get the status of a specific transaction. - [Resubmit a transaction](https://docs.venly.io/docs/resubmit-transaction-1.md): Resubmit a failed transaction. - [Get wallet events](https://docs.venly.io/docs/get-wallet-events-by-walletid.md): This guide describes how to retrieve all the events related to a wallet by walletId. The events can be wallet created, funds transfer, signed signature, etc. - [Webhooks](https://docs.venly.io/docs/webhooks-wallet-api.md): Describes how to configure and use webhooks for the Wallet-API. - [Burn an NFT](https://docs.venly.io/docs/how-to-burn-nft.md): In this guide we will go through the process of burning an NFT - [Filter Spam NFTs](https://docs.venly.io/docs/how-to-filter-spam-nfts.md): This page describes how to filter out possible spam NFT collections. - [Filter NSFW NFTs](https://docs.venly.io/docs/how-to-filter-nsfw-nfts.md): This page describes how to filter out possible NSFW NFT collections. - [SWAP Token Pairs](https://docs.venly.io/docs/swap-token-pair.md): This guide will explain how to SWAP tokens using the Wallet-API. - [Gasless/Meta Transactions](https://docs.venly.io/docs/what-are-meta-transactions.md): This page describes how to execute gasless or meta transactions on ERC1155 tokens (NFTs). - [Sign RAW Transactions](https://docs.venly.io/docs/how-to-sign-raw-transactions.md): This page describes how to sign raw transactions and submit them yourself to the blockchain. - [Using Fiat Onramp with Wallet-API](https://docs.venly.io/docs/how-to-use-fiat-onramp-with-wallet-api.md): This guide compares four fiat onramps so you can choose the right one according to your needs. It also describes how the onramp providers work with our Wallet-API. - [Deploy an Ethereum contract](https://docs.venly.io/docs/how-to-deploy-an-ethereum-smart-contract.md): This is a guide with a very simple smart contract example. - [Integrate with WalletConnect](https://docs.venly.io/docs/how-to-integrate-with-walletconnect.md) - [Set Up NFT Token Gating](https://docs.venly.io/docs/set-up-nft-token-gating.md): This guide describes the endpoint to set up NFT token gating. - [Chain Specific Fields](https://docs.venly.io/docs/chain-specific-fields-ethereum-matic-hedera-bsc.md): Data structure for providing chain specific fields when doing a contract call or transaction execution. - [Integrate with WalletConnect](https://docs.venly.io/docs/integrate-with-walletconnect.md): How to integrate the Venly Wallet API with WalletConnect and build your own wallet that is compatible with every Dapp - [Encrypted PIN Transfer](https://docs.venly.io/docs/encrypted-pin-transfer.md): This guide describes how to implement secure PIN transfer for your end-users. - [Gasless tx/ Transfer with authorization - ERC20](https://docs.venly.io/docs/gasless-tx-transfer-with-authorization-erc20.md): This guide describes how to execute a gasless transaction or transferWithAuthorization (EIP-3009) with ERC20 tokens. - [Gasless tx/ permit & transferFrom - ERC20](https://docs.venly.io/docs/gasless-tx-permit-transferfrom-erc20.md): This guide describes how to execute a gasless transaction using permit and transferFrom functions (EIP-2612) with ERC20 tokens. - [Get gas fee for specific tx's](https://docs.venly.io/docs/get-gas-fee-for-specific-txs.md): This guide describes how to retreive the gas fee for specific transactions including transferring native token, ERC20 token, and NFT. - [Overview](https://docs.venly.io/docs/token-api-overview.md): A small introduction to the Token API. - [Getting started](https://docs.venly.io/docs/token-api-getting-started.md): Covering the basics from authentication to minting your first ERC20 token. - [Create token contract](https://docs.venly.io/docs/create-erc20-token-contract.md): This guide explains how you can create an ERC20 smart contract on the blockchain. - [Check token contract status](https://docs.venly.io/docs/check-erc20-token-contract-status.md): This guide explains how to check the on-chain status of your ERC20 token contract. - [Retrieve token contracts](https://docs.venly.io/docs/retrieve-erc20-token-contracts.md): How to retrieve the information of one or all of your ERC20 token contracts. - [Mint tokens](https://docs.venly.io/docs/mint-erc20-tokens.md): This page describes the endpoint used to mint ERC20 tokens. - [Get all ERC20 token mints](https://docs.venly.io/docs/get-all-erc20-token-mints.md): This guide describes how to retreive all of your ERC20 token mints. - [Check token mint request](https://docs.venly.io/docs/check-erc20-token-mint-request.md): How to check the status of an ERC20 token mint request. - [Delete token contract](https://docs.venly.io/docs/delete-token-contract.md): How to delete/archive an ERC20 token contract. - [Update contract owner](https://docs.venly.io/docs/update-contract-owner-erc20.md): This guide describes how to update the contract owner of an ERC20 token contract. - [Webhooks](https://docs.venly.io/docs/webhooks-token-api.md): Describes how to configure and use webhooks for the Token API. - [Burn ERC20 Token](https://docs.venly.io/docs/how-to-burn-erc20-tokens.md): This guide describes how to burn ERC20 tokens from your wallet. - [Overview](https://docs.venly.io/docs/nft-api-overview.md): A small introduction to the NFT-API. - [Getting started](https://docs.venly.io/docs/nft-api-getting-started.md): Covering the basics from authentication to minting your first NFT. - [Migration to NFT v3](https://docs.venly.io/docs/migration-guide-to-nft-v3.md): This guide describes why you should migrate to the latest NFT v3 to make use of the latest features! - [NFT Testnet Assets](https://docs.venly.io/docs/nft-testnet-assets.md): Get up and running quickly with our NFT API. - [Get any NFT info](https://docs.venly.io/docs/show-nft-info.md): Retrieve the NFT token information based on the NFT contract address and the token id. - [Get any NFT contract](https://docs.venly.io/docs/show-nft-contract.md): Retrieve the NFT contract information based on the contract address. - [Get NFTs by any wallet](https://docs.venly.io/docs/retrieve-nfts-by-a-wallet-address.md): Retrieve all tokens that are stored on a wallet address. - [Get wallets by any NFT](https://docs.venly.io/docs/retrieve-wallets-containing-an-nft.md): Retrieve the wallet that holds/owns a specific NFT. - [Create contract](https://docs.venly.io/docs/create-contract.md): This guide explains how you can create a smart contract for your NFT collection on the blockchain. - [Retrieve Contract](https://docs.venly.io/docs/retrieve-contract.md): How to retrieve the information of one or all of your NFT contracts. - [Delete Contract](https://docs.venly.io/docs/delete-contract.md): How to delete an NFT contract/collection. - [Check Contract Status](https://docs.venly.io/docs/check-contract-status.md): This guide explains how to check the on-chain status of your NFT contract/collection. - [Retrieve Contract Metadata](https://docs.venly.io/docs/retrieve-contract-metadata.md): How to retrieve the metadata of an NFT contract/collection. - [Update Contract Metadata](https://docs.venly.io/docs/update-contract-metadata.md): Endpoint that allows you to update the metadata of an NFT contract/collection. - [Create Token-type (NFT template)](https://docs.venly.io/docs/create-nft-template.md): This page explains how to create an NFT template (token-type). - [Retrieve Token-type (NFT template)](https://docs.venly.io/docs/retrieve-nft-template.md): How to retrieve an NFT token type (template) from one of your contracts. - [Delete Token-type (NFT Template)](https://docs.venly.io/docs/delete-token-type-nft-template.md): How to delete a token-type. - [Check Token-type Status](https://docs.venly.io/docs/check-token-type-status.md): This guide explains how to check the status of a token-type (NFT template) creation. - [Retrieve Token-type Metadata](https://docs.venly.io/docs/retrieve-nft-metadata.md): How to retrieve the metadata of an NFT token type (template) from one of your contracts. - [Update Token-type Metadata](https://docs.venly.io/docs/update-nft-metadata.md): Endpoint that allows you to update the metadata of a NFT template (Token type). - [Mint an NFT](https://docs.venly.io/docs/how-to-mint-an-nft.md): This page describes the entire flow in minting an NFT. - [Batch Mint NFTs](https://docs.venly.io/docs/how-to-batch-mint-nfts-to-multiple-destinations.md): This guide will explain how you can mint and send NFTs to multiple wallets in a batch. - [Update NFT Metadata](https://docs.venly.io/docs/update-the-nft-metadata.md): This guide explains how to update the metadata of an already minted NFT. - [Retrieve NFT Metadata](https://docs.venly.io/docs/retrieve-nft-metadata-1.md): How to retrieve the metadata of an NFT by tokenId. - [Add Audio to your NFTs](https://docs.venly.io/docs/how-to-add-audio-in-your-nfts.md): This page explains how you can add audio files to your NFTs. - [Add Video to your NFTs](https://docs.venly.io/docs/how-to-add-video-in-your-nfts.md): This page explains how you can add videos to your NFTs. - [Store NFT Media](https://docs.venly.io/docs/store-nft-image-and-media.md): This API endpoint allows to store images / media on the storage solutions of Venly. - [Webhooks](https://docs.venly.io/docs/webhooks-nft-api.md): Describes how to configure and use webhooks for the NFT-API. - [Update contract owner](https://docs.venly.io/docs/update-contract-owner.md): This guide describes how to update the owner of an NFT contract. - [Update royalty for contract](https://docs.venly.io/docs/update-royalty-for-contract.md): This guide describes how to add/update the royalties for an NFT contract. - [Mass Minting](https://docs.venly.io/docs/mass-minting.md): Mass Minting represents enterprise-grade, high-volume minting, allowing users to mint a large number of NFTs simultaneously. - [Speed Up Minting](https://docs.venly.io/docs/speed-up-your-minting-process.md): How to speed up your minting using multiple company minter wallets. - [Dynamic NFTs](https://docs.venly.io/docs/dynamic-nfts-api-flow.md): This API guide explains all the endpoints related to dynamic NFTs. - [Configure Royalties](https://docs.venly.io/docs/configure-royalties-with-royalty-registry.md): This guides explains how to configure royalties on your existing/new NFT smart contract using Royalty Registry. - [Retrieve Company Minter Wallets](https://docs.venly.io/docs/retrieve-company-minter-wallets.md): Retrieve the minter wallet addresses and their respective balances by blockchain. - [Store NFT Metadata on IPFS](https://docs.venly.io/docs/how-to-store-your-nft-metadata-on-ipfs.md): This page describes how you can store your NFT metadata on InterPlanetary File System (IPFS). - [View NFT on sandbox/testnet](https://docs.venly.io/docs/view-nft-on-sandboxtestnet.md): This guide describes how to view your NFTs on the OpenSea Testnet - [Create token-type & directly mint NFTs](https://docs.venly.io/docs/create-token-type-directly-mint-nfts.md): This guide describes how to create a token-type and simultaneously mint NFTs. - [NFT Configuration](https://docs.venly.io/docs/nft-configurations.md): A more detailed explanation of the NFT metadata structure, advanced configurations and possibilities. - [Attributes](https://docs.venly.io/docs/nft-attributes.md): NFT Properties / Stats / Boost - [Animation & Media](https://docs.venly.io/docs/animation-media.md): Add animation media to your NFTs - [Collection Info](https://docs.venly.io/docs/collection-info.md): Metadata on the level of the NFT contract - [Max Supply](https://docs.venly.io/docs/max-supply.md): Defining a max supply in your NFT template - [Mint Number](https://docs.venly.io/docs/mint-number.md): Unique mint number - [Burnable](https://docs.venly.io/docs/burnable.md): Allow an NFT to get burned - [Metadata Storage](https://docs.venly.io/docs/metadata-storage.md): Available options for storing NFT metadata - [Overview](https://docs.venly.io/docs/pay-api-overview.md): Introducing you to PAY and how your business can benefit from it. - [Getting started](https://docs.venly.io/docs/pay-api-getting-started.md): Learn how to get your business onboarded and configure PAY. - [Example Use Case Scenario](https://docs.venly.io/docs/example-use-case-scenario.md): In this guide, a scenario is explained where your end-user wants to purchase an NFT and pay in fiat, in reference to the PAY API endpoints. - [Checkout Management](https://docs.venly.io/docs/checkout-link-management.md): This guide describes how to create a checkout session and check it's payment status. - [Customize Checkout Branding](https://docs.venly.io/docs/checkout-link-branding.md): This guides explains how you can customize the checkout page with colors and your company logo. - [Fetch Stripe Dashboard](https://docs.venly.io/docs/fetch-stripe-dashboard.md): This guide explains how you can retrieve the login link for your Stripe Dashboard. - [Testing PAY](https://docs.venly.io/docs/testing-pay.md): This page explains how you can simulate payments to test the integration and webhooks. - [Fiat On/Off Ramps Configuration](https://docs.venly.io/docs/fiat-on-off-ramps-configuration.md): This guide outlines the process for configuring fiat on and off ramps in both sandbox and production environments. We have implemented a new approach to give you more control and flexibility. - [Supported Fiat & Crypto for Providers](https://docs.venly.io/docs/on-ramp-off-ramp-supported-fiat-crypto-currencies.md): This guide explains retrieving the supported fiat and crypto currencies for Transak, Moonpay, and Ramp-Network. - [Fiat on-ramps](https://docs.venly.io/docs/fiat-on-ramps.md): This guide describes creating onramp URLs using Transak, Moonpay, and Ramp Network. - [Fiat off-ramps](https://docs.venly.io/docs/fiat-off-ramps.md): This guide describes creating offramp URLs using Transak, Moonpay, and Ramp Network. - [Configuring Webhooks](https://docs.venly.io/docs/webhooks-pay-api.md): Describes how to configure and use webhooks for the PAY. - [Overview](https://docs.venly.io/docs/gaming-sdk-overview.md): Level Up Your Game Development with Venly's Gaming Toolkit: Seamless Integration, Limitless Possibilities - [Getting started with Unity](https://docs.venly.io/docs/getting-started-with-unity.md): A quick start guide to get you up and running - [Backend Provider: Developer Mode](https://docs.venly.io/docs/developer-mode-overview.md) - [Backend Provider: PlayFab](https://docs.venly.io/docs/playfab-overview.md): The PlayFab Backend Provider gives you the option to interact with the Venly API using Azure Cloud Functions. - [Create an Azure Cloud Function](https://docs.venly.io/docs/create-an-azure-cloud-function.md): Explanation on how to create an Azure Cloud Function to relay the Venly API calls - [Configure your PlayFab Account](https://docs.venly.io/docs/configure-your-playfab-account.md) - [Configure Venly SDK Manager](https://docs.venly.io/docs/configure-venly-sdk-manager.md) - [Backend Provider: Beamable](https://docs.venly.io/docs/beamable-overview.md) - [Configure Realm Config](https://docs.venly.io/docs/configure-realm-config.md): Client Authoritative - [Create Venly Microservice](https://docs.venly.io/docs/create-venly-microservice.md): Client Authoritative - [Configure the Venly SDK Manager](https://docs.venly.io/docs/configure-the-venly-sdk-manager.md): Client Authoritative - [Provide BeamContext (optional)](https://docs.venly.io/docs/provide-beamcontext.md): Client Authoritative - [Server Authoritative](https://docs.venly.io/docs/server-authoritative.md) - [Backend Provider: Custom](https://docs.venly.io/docs/backend-provider-custom-overview.md) - [Provider extensions](https://docs.venly.io/docs/provider-extensions.md) - [Getting started with Unreal Engine](https://docs.venly.io/docs/getting-started-with-unreal-engine.md): A quick start guide to get you up and running - [Backend Provider: Developer Mode](https://docs.venly.io/docs/backend-provider-developer-mode.md) - [Backend Provider: PlayFab](https://docs.venly.io/docs/backend-provider-playfab.md): The PlayFab Backend Provider gives you the option to interact with the Venly API using Azure Cloud Functions. - [Create CloudFunction](https://docs.venly.io/docs/create-cloudfunction.md): Explanation on how to create an Azure Cloud Function to relay the Venly API calls. - [Configuring the SDK](https://docs.venly.io/docs/configuring-the-sdk.md) - [Backend Provider: Beamable](https://docs.venly.io/docs/backend-provider-beamable.md) - [Beamable Microservice](https://docs.venly.io/docs/beamable-microservice.md) - [Binding the Microservice](https://docs.venly.io/docs/binding-the-microservice.md) - [Provider Extensions](https://docs.venly.io/docs/provider-extensions-1.md) - [Game example 🎮](https://docs.venly.io/docs/game-examples.md) - [Simple NFT Application](https://docs.venly.io/docs/simple-nft-application.md): Your First NFT Application with Venly - [Web2 Wallet onboarding](https://docs.venly.io/docs/web2-wallet-onboarding.md): Simplify user onboarding in blockchain applications by integrating traditional web2 signup options alongside backend wallet provisioning - [Blockchain Comparison](https://docs.venly.io/docs/blockchain-networks-comparison.md): Technical comparison of blockchains used in Venly APIs. - [Custodial vs. Non-Custodial](https://docs.venly.io/docs/custodial-vs-noncustodial.md): This page describes the difference between custodial and non-custodial wallets. - [Omnibus vs Segregated Wallets](https://docs.venly.io/docs/omnibus-vs-segregated-wallets-in-crypto.md): This page explains the difference between omnibus and segregated wallet offerings in crypto. - [Wallet-API vs Wallet-Widget](https://docs.venly.io/docs/wallet-api-vs-wallet-widget.md): In-depth comparison between the Wallet-API and Wallet-Widget products. - [NFT contract vs collection](https://docs.venly.io/docs/difference-between-an-nft-contract-and-a-collection.md): This page explains the difference between an NFT contract and an NFT collection. ## API Reference - [How to authenticate](https://docs.venly.io/reference/how-to-get-bearer-token.md): This guide explains how to retrieve the bearer token required to run API calls. - [Fetch Bearer Token](https://docs.venly.io/reference/bearertoken.md) - [Check Health](https://docs.venly.io/reference/healthcheckwallet.md): This endpoint is used to check the current health of the **Wallet-API**. It returns the API health status as either **UP** or **DOWN**. - [Get all Users](https://docs.venly.io/reference/getall.md): This endpoint retrieves all your users and their information. - [Create User](https://docs.venly.io/reference/createuser.md): Creates a new user account along with their primary signing method. Users are unique entities that can own and manage multiple wallets. **Signing Method Requirements:** - The first signing method must be a six-digit PIN - This PIN serves as the primary authentication method for wallet access - Signing methods are required to authorize transactions and access wallet functions **User-Wallet Relationship:** - Each user can be associated with multiple wallets - The signing method applies to all wallets owned by the user - Users maintain a single identity across all their associated wallets This endpoint combines user creation and security setup in a single operation - [Get User by ID](https://docs.venly.io/reference/getuser.md): This endpoint retrieves detailed information for a specific user by their `UUID`. - [Update User’s Reference](https://docs.venly.io/reference/updateuser.md): Updates the reference identifier for a specific user based on the user `UUID`. The reference is a custom identifier that can be used to link users to external systems. - [Delete User](https://docs.venly.io/reference/deleteuser.md): This endpoint deletes a user. All the linked wallets to the user will be inaccessible once the user has been deleted. - [Create User’s Signing Method](https://docs.venly.io/reference/createsigningmethod.md): This endpoint allows you to create a signing method for a user, whether it's their first or an additional one. The first signing method must always be a six-digit `PIN`, and does not require the `Signing-Method` to be passed in the header. For creating subsequent signing methods like `BIOMETRIC`/`EMERGENCY_CODE`/`PASSWORD`, include an existing valid `Signing-Method` in the request header. - [Update User’s Signing Method](https://docs.venly.io/reference/updatesigningmethod.md): This endpoint is used to update a user's signing method. This can be done, in case the user forgets their PIN. In order to update a signing method, another valid signign method has to be passed in the header. - [Delete User’s Signing Method](https://docs.venly.io/reference/deletesigningmethod.md): This endpoint is used to delete a user's signing method. - [Get Wallet](https://docs.venly.io/reference/viewwallet.md): This endpoint gets a wallet by id. - [Update Wallet](https://docs.venly.io/reference/updatemetadata_1.md): Updates modifiable metadata properties of an existing wallet. This endpoint allows you to modify the wallet's description, set primary status, archive/unarchive the wallet, or update the custom identifier for external system integration - [Get all Wallets](https://docs.venly.io/reference/viewwallets_1.md): Retrieves a paginated list of all wallets accessible to your account. This endpoint supports comprehensive filtering, sorting, and inclusion options to help you find specific wallets or groups of wallets based on various criteria. **Key Features:** - Filter by blockchain network, user, or company - Include or exclude archived wallets - Sort results by multiple criteria - Control balance information inclusion for performance - Search by wallet address or custom identifier Use this endpoint for wallet management dashboards, reporting, or integration with external systems requiring wallet inventory data. - [Create Wallet](https://docs.venly.io/reference/createwallet.md): Creates a new wallet for an existing user with a configured signing method. **Prerequisites:** - User must be created to which the wallet will be linked - User must have at least one configured signing method (used to authenticate wallet creation) - [Export Wallet](https://docs.venly.io/reference/exportbyid.md): Exports wallet credentials for use in external applications or backup purposes. **Security Considerations:** - Password-protected keystores are recommended for enhanced security against network attacks - Once exported, private keys are outside our security controls - Compromised keys can result in unauthorized access and potential fund loss **Important:** Exported credentials grant full wallet access. Store them securely and never share with untrusted parties. - [Import Wallet](https://docs.venly.io/reference/importwallet.md): This endpoint is used to import a wallet. Read more about [how to import a wallet](https://docs.venly.io/docs/import-a-wallet). - [Validate Wallet Address](https://docs.venly.io/reference/validateaddress.md): This endpoint is used to validate whether the format of a wallet address is correct for a specific chain. - [Get all Wallet Events](https://docs.venly.io/reference/index-1.md): This endpoint retrieves all the events related to a wallet by `walletId`. The events can be wallet created, funds transfer, signed signature, etc. - [Link Wallet to User](https://docs.venly.io/reference/linkwallettouser.md): This endpoint is used only when migrating from the old/deprecated wallet management to the new user management. Click [here](https://docs.venly.io/docs/user-management) to read more about user management. It is used to link an existing wallet to a user. - [Update Wallet PIN code](https://docs.venly.io/reference/updatesecurity.md): This endpoint has been deprecated. Please click here to read about [Signing Methods](https://docs.venly.io/docs/signing-methods-api-flow). - [Get native Balance by walletId](https://docs.venly.io/reference/viewbalance.md): This endpoint gets native balance of a wallet by wallet `UUID`. - [Get all ERC20 Token Balance by walletId](https://docs.venly.io/reference/viewtokenbalances.md): This endpoint fetches all the ERC20 token balance by wallet `UUID` - [Get specific ERC20 Token Balance by walletId and token address](https://docs.venly.io/reference/viewtokenbalance.md): This endpoint retrieves ERC20 Token balances by wallet `UUID` and token contract address. - [Get Token Associations for Hedera Wallet](https://docs.venly.io/reference/gettokenassociations.md): This endpoint retrieves the token assocciations for a Hedera wallet using the wallet address. - [Get native Balance by Chain and Wallet Address](https://docs.venly.io/reference/viewbalance_1.md): Retrieves the native token balance for a specific wallet address on the specified blockchain network. This endpoint returns the current balance in both human-readable and raw formats, along with token metadata and USD exchange rates when available. - [Get ERC20 Balance by Chain and Wallet Address](https://docs.venly.io/reference/viewtokenbalances_1.md): Retrieves ERC20 token balances for a specific wallet address on the specified blockchain network. This endpoint returns detailed balance information including token metadata, exchange rates, and USD valuations when available. **Filtering Options:** - Query specific tokens by contract address - Show all tokens or only those with non-zero balances - Include or exclude potential spam/scam tokens - [Get specific ERC20 Token Balance by Chain, Wallet Address, and Token Address](https://docs.venly.io/reference/viewtokenbalance_1.md): This endpoint gets the ERC20 token balance by Wallet `ID`, wallet address, and token address. - [Get all Transactions](https://docs.venly.io/reference/getall_1.md): Retrieves a paginated list of transactions with optional filtering capabilities. **Features:** - Filter by transaction status - Filter by specific user UUID - Configurable pagination - Flexible sorting options - Optional user details inclusion - [Execute Transaction](https://docs.venly.io/reference/executetransaction_1.md): Creates and executes a blockchain transaction of any supported type. **Supported Transaction Types:** - Native token transfers - ERC-20 token transfers - NFT transfers (ERC-721, ERC-1155) - Smart contract interactions - [Create Transaction](https://docs.venly.io/reference/createtransaction.md): Creates a blockchain transaction of any supported type with autogenrating the gas fields. **Supported Transaction Types:** - Native token transfers - ERC-20 token transfers - NFT transfers (ERC-721, ERC-1155) - Smart contract interactions - [Confirm Transaction Request](https://docs.venly.io/reference/confirmtransaction.md): Confirms a saved transaction request and prepares it for execution by updating its status from **SAVED** to **READY**. **Process flow:** 1. Validates the saved transaction request parameters 2. Calculates and populates gas fees, nonce, and other blockchain-specific fields 3. Updates status to **READY**, making it available for execution 4. Sets expiration time for the confirmed transaction **When to use:** - After creating a transaction request with `status: "SAVED"` - Before calling the execute endpoint to complete the transaction - When you're ready to finalize gas calculations and network parameters **Important notes:** - Only works with transaction requests in **SAVED** status - Gas fields will be auto-populated based on current network conditions - The confirmed transaction will have an expiration time after which it cannot be executed - [Build Transaction Request](https://docs.venly.io/reference/buildtransaction.md): Transforms a generic transaction request into a blockchain-specific transaction with all necessary parameters populated for the target network. **What this endpoint does:** - Validates transaction data against the specified blockchain network - Converts generic amounts to blockchain-native units (e.g., 0.1 SUI → 100000000 MIST) - Calculates and populates network-specific parameters (gas price, gas budget, nonce) - Transforms generic transaction types to chain-specific types (TRANSFER → SUI_TRANSFER) - Returns a structured transaction request ready for confirmation and execution **Supported transaction types:** - **Native transfers**: Send blockchain's native currency (ETH, SUI, MATIC, etc.) - **Token transfers**: Send ERC-20 or equivalent tokens - **NFT transfers**: Transfer ERC-721/ERC-1155 or equivalent NFTs - **Contract execution**: Call smart contract functions - **Multi-transfers**: Batch multiple operations (Hedera only) - [Execute Transaction Request](https://docs.venly.io/reference/executetransaction.md): Executes a confirmed transaction request by transaction UUID, by performing the blockchain transaction operation. **Prerequisites:** - Transaction request must be in **READY** status (use confirm endpoint first) - Transaction must not be expired **Process:** 1. Validates the transaction request status and expiration 2. Authenticates using provided signing method 3. Signs and broadcasts the transaction to the blockchain network 4. Returns the transaction result with hash and network confirmation - [Get Transaction Status](https://docs.venly.io/reference/getstatus.md): Retrieves the current status of a blockchain transaction using its unique hash identifier. This endpoint queries the specified blockchain network to determine the transaction's current state, such as whether it's pending, confirmed, or failed. The status is fetched directly from the blockchain's network nodes to ensure accuracy. **Supported Status Values:** - `PENDING` - Transaction submitted but not yet confirmed - `SUCCEEDED` - Transaction successfully confirmed on blockchain - `FAILED` - Transaction failed during execution - `UNKNOWN` - Status cannot be determined (unsupported chain or invalid hash) - [Get Gas Price for a Chain](https://docs.venly.io/reference/getstatus_1.md): This endpoint fetches the current fees (for EVM based chains: `gasprice`) for a specific chain - [Resubmit Transaction](https://docs.venly.io/reference/resubmit.md): This endpoint immediately tries to resubmit a stuck transaction. Sometimes a transaction fails to execute/propagate. This can be due to several factors, for example, the gas price is too low. - [Cancel Transaction](https://docs.venly.io/reference/cancel.md): This endpoint immediately tries to cancel a stuck transaction. - [Get Signature Request by userId](https://docs.venly.io/reference/getusersignaturerequests.md): This endpoint retrives all the signature requests, and the results can be filtered by `userId` and signature status. - [Create or Sign Signature](https://docs.venly.io/reference/signtransaction.md): Creates and optionally executes cryptographic signatures for blockchain messages and structured data. **Supported signature types:** - **Message signing**: Plain text message signing using personal_sign method - **EIP-712**: Ethereum typed structured data signing for improved security and usability - [Confirm Signature](https://docs.venly.io/reference/confirmsignaturerequest.md): Confirms a saved signature request and prepares it for execution by updating its status from **SAVED** to **READY**. **Process flow:** 1. Validates the saved signature request parameters 2. For transaction signatures: Calculates and populates gas fees, nonce, and other required fields 3. Updates status to **READY**, making it available for signing 4. Sets expiration time for the confirmed request - [Sign Signature](https://docs.venly.io/reference/signsignaturerequest.md): Executes a confirmed signature request by performing the cryptographic signing operation. It returns the completed signature in the appropriate format. **Prerequisites:** - Signature request must be in **READY** status (use confirm endpoint first) - [Build Signature Request](https://docs.venly.io/reference/buildsignature.md): Transforms a generic signature request into a blockchain-specific signature request with all necessary parameters populated for the target network. **Supported operations:** - **Plain Message signing** - **EIP-712 structured data signing** - [Verify Signed Signature](https://docs.venly.io/reference/isvalidsignature.md): Cryptographically verifies that a signature was signed by a specific wallet address for the given message or data. - [Get Signature Request by id](https://docs.venly.io/reference/getsignaturerequestbyid.md): Retrieves a signature request by its unique identifier, including current status, metadata, and signing details. **Returns information about:** - Current signature request status (SAVED, READY, SIGNED, EXPIRED, CANCELED) - Original request parameters and data - Timestamps (created, expires, signed) - Signature results (if completed) - Associated wallet and blockchain network details - [Cancel Signature Request](https://docs.venly.io/reference/cancel_2.md): Cancels a signature request by setting its status to **CANCELED**. This prevents the signature from being executed and marks it as permanently inactive. **Cancellation rules:** - Can only cancel requests with status: **SAVED** or **READY** - Cannot cancel already **SIGNED**, **EXPIRED**, or **CANCELED** requests - Action is irreversible - canceled requests cannot be reactivated - [Read Contract](https://docs.venly.io/reference/readcontract.md): This endpoint allows you to read contract functions. This function is only available for EVM-based chains. - [Encode Inputs](https://docs.venly.io/reference/encode.md): This endpoint allows you to encode contract functions. This function is only available for EVM-based chains. - [Decode Inputs](https://docs.venly.io/reference/decode.md): This endpoint allows you to decode contract functions. This function is only available for EVM-based chains. - [Get Wallets that contain NFT from a specific Contract](https://docs.venly.io/reference/getwalletbalance.md): This endpoint returns the wallet address(es) which contain NFTs from a specific NFT contract address. - [Get NFTs by walletId](https://docs.venly.io/reference/listnonfungibles.md): This endpoint retrieves NFTs by wallet `ID` - [Get NFTs by Chain](https://docs.venly.io/reference/listnonfungibles_1.md): This endpoint retrieves NFTs by blockchain. - [Get NFTs by Chain and Wallet Address](https://docs.venly.io/reference/listnonfungiblesbyaddress.md): This endpoint retrieves NFTs by blockchain and wallet address. - [Get NFT contract](https://docs.venly.io/reference/getnonfungiblecontract.md): This endpoint retrieves NFT contract information by blockchain and contract address. - [Get NFT information](https://docs.venly.io/reference/getnonfungible.md): This endpoint retrieves a specific NFT information by chain, contract address, and the token `ID`. - [Get Wallets that contain specific NFTs](https://docs.venly.io/reference/gettokenwalletbalance.md): This endpoint fetches the wallet that contain a specific NFT. The wallets are filtered by blockchain, contract address of the NFT, and the token `ID` - [Get Token Allowances for Hedera NFTs](https://docs.venly.io/reference/gethederanonfungibleallowances.md): This endpoint retrieves the token allowances specifically for Hedera chain - [Get Token Pairs](https://docs.venly.io/reference/gettradingpairs.md): This endpoint gets all the possible token pairs that can be swapped based on the blockchain of the wallet. - [Get Exchange Rate](https://docs.venly.io/reference/getexchangerate.md): This endpoint returns information about the expected result of the swap. It provides the expected output amount, as well gives information about the slippage, and fee involved for that specific swap. - [Build Swap](https://docs.venly.io/reference/createswap.md): This endpoint returns the transaction detail that is needed to perform the actual swap, based on information obtained in the **Get Exchange Rate** endpoint. This endpoint will build a transaction for you, which afterward you or your user needs to execute. Each item in the response array needs to be taken, enriched with the relevant signing method and submitted against the endpoint: `/api/transactions/execute` - [Get Chain Information](https://docs.venly.io/reference/getchaininfo.md): Returns information about a specific blockchain. - [Get all supported Chains](https://docs.venly.io/reference/secrettypes_1.md): This endpoint returns all the supported chains by the Wallet-API. - [Get Venly Public Key](https://docs.venly.io/reference/getkeys.md): This endpoint retrieves the Venly public key. - [Check Health](https://docs.venly.io/reference/healthcheckpay.md): This endpoint is used to check the current health of the **PAY-API**. It returns the API health status as either **UP** or **DOWN**. - [Get supported fiat and crypto currencies](https://docs.venly.io/reference/getcurrencies.md): Get all supported fiat currencies and crypto currencies for a specific provider. The response includes the `fiat` and `crypto` arrays. The `fiat[]` array includes all the supported fiat currencies for the specific provider, and the `crypto[]` array includes all the supported crypto currencies for the specific provider. - [Transak Onramp](https://docs.venly.io/reference/gettransakfiatonrampurl.md): This endpoint is used to create a Transak onramp URL. - [Transak Offramp](https://docs.venly.io/reference/gettransakfiatofframpurl.md): This endpoint is used to create a Transak offramp URL. - [Ramp Network Onramp](https://docs.venly.io/reference/getrampnetworkfiatonrampurl.md): This endpoint is used to create a Ramp Network onramp URL. - [Ramp Network Offramp](https://docs.venly.io/reference/getrampnetworkfiatofframpurl.md): This endpoint is used to create a Ramp Network offramp URL. - [Moonpay Onramp](https://docs.venly.io/reference/getmoonpayfiatonrampurl.md): This endpoint is used to create a Moonpay onramp URL. - [Moonpay Offramp](https://docs.venly.io/reference/getmoonpayfiatofframpurl.md): This endpoint is used to create a Moonpay offramp URL. - [Create Checkout Link](https://docs.venly.io/reference/checkoutsession.md): Initiate the checkout process for a single payment by calling this endpoint. Save the `id` and `url` from response body. The `id` parameter is the sessionId (Used when checking status of this checkout), and the `url` parameter is the checkout URL (You pass this to your end-user). - [Get Checkout Status](https://docs.venly.io/reference/getsession.md): To retrieve the details of a completed or canceled checkout, call this endpoint using the corresponding session `ID`. - [Get Line Items](https://docs.venly.io/reference/getlineitems.md): This endpoint retrieves a checkout session's line items. - [Upload Icon](https://docs.venly.io/reference/uploadicon.md): Personalize your checkout page by adding your business' icon or logo. The icon must be a square image and have a minimum size of **128px x 128px**. - [Customize Checkout Page](https://docs.venly.io/reference/updatesettingsbranding.md): You can select a primary color for the left side of the checkout page, and a secondary color for the PAY button. The checkout page will also feature your icon. - [Get Stripe Dashboard Login Link](https://docs.venly.io/reference/getdashboardlink.md): This endpoint allows you to fetch a login link for your Stripe dashboard. - [Create a Webhook](https://docs.venly.io/reference/createwebhook.md): This endpoint is used to create a webhook, to receive updates of your user's payments (_successful/cancelled_). - [Get Webhooks](https://docs.venly.io/reference/findall-1.md): This endpoint is used to get all of your webhooks. - [Update a Webhook](https://docs.venly.io/reference/update-2.md) - [Delete a Webhook](https://docs.venly.io/reference/delete.md) - [Check Health](https://docs.venly.io/reference/healthchecktokenapiv3.md): This endpoint is used to check the current health of the **NFT-API**. It returns the API health status as either **UP** or **DOWN**. - [Get Supported Chains](https://docs.venly.io/reference/getsupportedchainserc20.md): This endpoint is used to retreive the supported chains for the Token API. - [Create contract](https://docs.venly.io/reference/deployerc20contract.md): This endpoint is used to create an ERC20 contract. - [Check token contract status](https://docs.venly.io/reference/geterc20contractdeployment.md): This endpoint is used to check the status of the token contract creation request. - [Get all contracts](https://docs.venly.io/reference/getallerc20contracts.md): This endpoint fetches all of your token contracts. - [Get contracts by chain and contract address](https://docs.venly.io/reference/geterc20contract.md): This endpoint is used to get a specific token contract by blockchain and contract address. - [Archive Contract](https://docs.venly.io/reference/archiveerc20tokencontract.md): This endpoint allows you to archive an ERC20 contract. When you archive an ERC20 contract, it will be removed from all API responses, rendering it inaccessible via any API calls. Furthermore, you cannot mint new tokens under the archived contract. All minted ERC20 tokens associated with the archived contract will also be archived and cannot be accessed via API calls. However, the ERC20 contract will remain on the blockchain. - [Update token contract owner](https://docs.venly.io/reference/updateowner-1.md): This endpoint is used to update the owner of a token contract. - [Mint ERC20 tokens](https://docs.venly.io/reference/minterc20tokens.md): This endpoint is used to mint and send ERC20 tokens. - [Get All ERC20 Token Mints](https://docs.venly.io/reference/getallerc20mints.md): This endpoint is used to retrieve all of your ERC20 token mint requests. - [Check token mint status](https://docs.venly.io/reference/geterc20tokenmintstatus.md): This endpoint is used to check the status of a token mint request. - [Get All Company Wallets](https://docs.venly.io/reference/getcompanywallets.md): This endpoint retrieves all company minter wallets. - [Get Company Wallets by Chain](https://docs.venly.io/reference/getcompanywalletbychain_1.md): This endpoint retrieves company minter wallets by blockchain. - [Delete Company Wallet](https://docs.venly.io/reference/deleteminterwallet.md): This endpoint deletes a company wallet by blockchain and wallet address. - [Check Health](https://docs.venly.io/reference/healthchecknftv3.md): This endpoint is used to check the current health of the **NFT-API**. It returns the API health status as either **UP** or **DOWN**. - [Get Supported Chains](https://docs.venly.io/reference/getsupportedchainserc1155.md): This endpoint is used to retrieve the supported chains for the NFT API. - [Get All Company Wallets](https://docs.venly.io/reference/getcompanywallets-1.md): This endpoint retrieves all company minter wallets. - [Get Company Wallets by Chain](https://docs.venly.io/reference/getcompanywalletbychain_1-1.md): This endpoint retrieves company minter wallets by blockchain. - [Create Company Wallet](https://docs.venly.io/reference/createcompanywallet.md): This endpoint creates a new company minter wallet for a specific chain. - [Delete Company Wallet](https://docs.venly.io/reference/deleteminterwallet-1.md): This endpoint deletes a company wallet by blockchain and wallet address. - [Get all contracts](https://docs.venly.io/reference/getcontracts.md): This endpoint fetches all of your contracts. - [List all Sui NFT Contracts](https://docs.venly.io/reference/listsuinftcontracts.md): Retrieves a list of all NFT contracts deployed on the Sui blockchain, including their deployment status and metadata. - [Create Contract](https://docs.venly.io/reference/deploycontract.md): This endpoint is used to create a contract. - [Create a Sui Contract](https://docs.venly.io/reference/deploysuicontract.md): This endpoint is used to create a Sui contract. You need to have a Sui company wallet with enough SUI tokens to pay for the gas fees for contract deployment, token-type creation, and token mints. You can create or view your Sui company wallet in the Company Wallets section of the API. - [Update Contract Owner](https://docs.venly.io/reference/updateowner.md): This endpoint is used to update the `owner` of an NFT contract. The updated owner will have admin rights on the contract. - [Check Contract Status](https://docs.venly.io/reference/getcontractstatus.md): This endpoint is used to check the status of the contract creation request. - [Update Royalty for NFT Contract](https://docs.venly.io/reference/updateroyalties.md): This endpoint is used to add/update the royalties for an NFT contract. You can add a royalty recipient wallet address and specifiy the royalty percentage. (_only for contracts created with the NFT v3_) - [Check a Sui Contract Status](https://docs.venly.io/reference/getsuicontract.md): This endpoint is used to check the status of a Sui contract creation request. - [Get Contract by Chain and Contract Address](https://docs.venly.io/reference/getcontract.md): This endpoint is used to get a specific contract by blockchain and contract address. - [Archive Contract](https://docs.venly.io/reference/archivetokencontract.md): This endpoint allows you to archive a contract. When you archive an NFT contract, it will be removed from all API responses, rendering it inaccessible via any API calls. Furthermore, you will lose the ability to create new token-types under the deleted contract. All token-types and minted NFTs associated with the archived contract will also be archived and cannot be accessed via API calls. However, the NFT contract will remain on the blockchain. - [Get Sui NFT contract by address](https://docs.venly.io/reference/getsuinftcontract.md): Retrieves a specific NFT contract on the Sui blockchain by its contract address, including deployment status and metadata. - [Archive a Sui NFT Contract](https://docs.venly.io/reference/archivesuinftcontract.md): This endpoint allows you to archive a Sui NFT contract. When you archive an NFT contract, it will be removed from all API responses, rendering it inaccessible via any API calls. Furthermore, you will lose the ability to create new token-types under the deleted contract. All token-types and minted NFTs associated with the archived contract will also be archived and cannot be accessed via API calls. However, the NFT contract will remain on the blockchain. - [Get Contract Metadata](https://docs.venly.io/reference/getcontractmetadata.md): This endpoint is used to fetch the metadata of as contract. - [Get Sui NFT contract metadata](https://docs.venly.io/reference/getsuinftcontractmetadata.md): This endpoint is used to fetch the metadata of a Sui NFT contract. - [Update Contract Metadata](https://docs.venly.io/reference/patchcontractmetadata.md): This endpoint is used to update the metadata of a contract. - [Get All Token-types](https://docs.venly.io/reference/getalltokentypes.md) - [Create Token-type](https://docs.venly.io/reference/createtokentype.md): This endpoint is used to create a token-type. - [Get All Sui Token-types](https://docs.venly.io/reference/getallsuitokentypes.md) - [Get Specific Token-type Details](https://docs.venly.io/reference/gettokentype.md): This endpoint fetches the details of a specific token-type by `tokenTypeId`. - [Create a Sui Token-type](https://docs.venly.io/reference/createsuitokentype.md): This endpoint is used to create a Sui token-type. - [Archive Token-type](https://docs.venly.io/reference/archivetokentype.md): This endpoint archives a token type, removing it from all API responses and making it inaccessible through API calls. Once archived, you will no longer be able to mint new NFTs under this token type. Additionally, all NFTs associated with the archived token type will also be archived and cannot be accessed via API calls. - [Check Token-type Status](https://docs.venly.io/reference/checktokentype.md): This endpoint is used to check the status of token-type creation request. - [Check Sui Token-type Status](https://docs.venly.io/reference/checksuitokentype.md): This endpoint is used to check the status of a Sui token-type creation request. - [Get Specific Sui Token-type Details](https://docs.venly.io/reference/getsuitokentype.md): This endpoint fetches the details of a specific Sui token-type by `tokenTypeId`. - [Archive SUI Token-type](https://docs.venly.io/reference/archivesuitokentype.md): This endpoint archives a SUI token type, removing it from all API responses and making it inaccessible through API calls. Once archived, you will no longer be able to mint new NFTs under this token type. Additionally, all NFTs associated with the archived token type will also be archived and cannot be accessed via API calls. - [Get Token-type Metadata](https://docs.venly.io/reference/gettokentypemetadata.md): This endpoint is used to fetch the metadata of a token-type - [Update Token-type Metadata](https://docs.venly.io/reference/updatemetadatafortokentype.md): This endpoint is used to update the metadata of a token-type. - [Get Sui NFT token-type metadata](https://docs.venly.io/reference/getsuinfttokentypemetadata.md): This endpoint is used to fetch the metadata of a Sui NFT token-type. - [Update Sui NFT token-type metadata](https://docs.venly.io/reference/updatesuinfttokentypemetadata.md): This endpoint is used to update the metadata of a Sui NFT token-type. - [Get All Tokens](https://docs.venly.io/reference/gettokens.md): This endpoint is used to get all tokens in a contract. - [Get all Sui NFT tokens](https://docs.venly.io/reference/getsuinfttokens.md): This endpoint is used to get all tokens in a Sui NFT contract. - [Get All Token Mints](https://docs.venly.io/reference/getall-1.md): This endpoint is used to retrieve all of your token mint requests. - [Get All Sui Token Mints](https://docs.venly.io/reference/getallsuimints.md): This endpoint is used to retrieve all of your Sui token mint requests. - [Mint Tokens](https://docs.venly.io/reference/minttokens.md): This endpoint is used to mint fungible or non-fungible tokens. - [Mint SUI NFTs](https://docs.venly.io/reference/mintsuitokens.md): This endpoint is used to mint SUI NFTs. - [Check Token Mint Status](https://docs.venly.io/reference/gettokenmint.md): This endpoint is used to check the status of a token mint request. - [Get Specific Token Details](https://docs.venly.io/reference/gettoken.md): This endpoint fetches the details of a specific token by tokenId. - [Archive a Token](https://docs.venly.io/reference/archivetoken.md): This endpoint is used to archive a token by `tokenId`. The archived token will continue to exist on-chain but it will not be returned in API calls anymore. - [Check Sui Token Mint Status](https://docs.venly.io/reference/getsuitokenmint.md): This endpoint is used to check the status of a Sui token mint request. - [Get Token Metadata](https://docs.venly.io/reference/gettokenmetadata.md): This endpoint fetches the metadata of a token by `tokenId`. - [Get Sui NFT token metadata by token ID](https://docs.venly.io/reference/getsuinfttoken.md): This endpoint fetches the details and metadata of a specific Sui NFT token by its `tokenId`. - [Update Property](https://docs.venly.io/reference/updatepropertyfortoken.md): This endpoint is used to update a property for a specific NFT. You can also add a property using this endpoint. - [Archive a Sui NFT token](https://docs.venly.io/reference/archivesuinfttoken.md): This endpoint is used to archive a Sui NFT token by `tokenId`. The archived token will continue to exist on-chain but it will not be returned in API calls anymore. - [Delete Property](https://docs.venly.io/reference/deletepropertyfortoken.md): This endpoint is used to delete a property for a specific NFT. - [Add Attribute](https://docs.venly.io/reference/addattributefortoken.md): This endpoint is used to add attributes to a specific NFT. - [Update Attribute](https://docs.venly.io/reference/updateattributefortoken.md): This endpoint is used to update an attribute's data for a specific NFT. - [Delete Attribute](https://docs.venly.io/reference/deleteattributefortoken.md): This endpoint is used to delete an attribute for a specific NFT. - [Update Animation URLs](https://docs.venly.io/reference/updateanimationurlsmetadatafortoken.md): This endpoint is used to update the `animationUrls` for a specific NFT. - [Delete Animation URLs](https://docs.venly.io/reference/deleteanimationurlsmetadatafortoken.md): This endpoint is used to delete `animationUrls` for a specific NFT. - [Upload Media File](https://docs.venly.io/reference/addmedia.md): This endpoint is used to upload a media file to our servers. - [Upload Image](https://docs.venly.io/reference/addnftimage.md): This endpoint is used to upload an NFT image to our servers. Make sure to only upload images to with this endpoint. ## Pages - [Create Wallet Snippet](https://docs.venly.io/create-wallet-snippet.md) - [Venly Wallet end user FAQ](https://docs.venly.io/venly-wallet-end-user-faq.md) ## Changelog - [Deprecation of NFT API v1/v2](https://docs.venly.io/changelog/deprecation-of-nft-api-v1v2.md) - [Updated Ethereum Deployment Funding](https://docs.venly.io/changelog/updated-ethereum-deployment-funding.md) - [NFT API – Improved Token ID Sequencing for V2 & V3](https://docs.venly.io/changelog/nft-api-improved-token-id-sequencing-for-v2-v3.md) - [Developer Portal - Update Actions for NFT API](https://docs.venly.io/changelog/developer-portal-update-actions-for-nft-api.md) - [Reversal of Ethereum Minting Deprecation](https://docs.venly.io/changelog/reversal-of-ethereum-minting-deprecation.md)