Jump to Content
Guides
Recipes
API Reference
Product Changelog
v1.0
v2.0
Get Started - It's Free
Guides
Get Started - It's Free
v2.0
Guides
Recipes
API Reference
Product Changelog
Hypermint APIs
👩🚀 moonbase
Welcome to MoonPay
Advantages of our products
FAQ
Testing credit cards
Sandbox testing
Mobile payments
Integration Examples
📥 ON-Ramp
Overview
Architecture
Quickstart
How to
Test On-Ramp without any code
Design your integration
Integrate using a URL
Integrate using an SDK
Configure the On-Ramp user journey
Customize the widget's appearance
Enhance security using signed URLs
Transition to production
Integrations (SDKs)
Web
Web SDK
React SDK
Node.js SDK
Mobile
iOS SDK
Android SDK
React Native SDK
SDK events
Ramps' events
Events' properties
💰 OFF-RAMP
Overview
Architecture
Quickstart
How to
Test Off-Ramp without any code
Integrate Off-Ramp using a URL
Integrate Off-Ramp using our SDKs
Configure the Off-Ramp user journey
Handle Off-Ramp crypto deposits
Customize the widget's appearance
Enhance security using signed URLs
Transition to production
FAQ
Integrations
Best practices when integrating
Web
Web SDK
React SDK
Node.js SDK
Mobile
iOS SDK
Android SDK
React Native SDK
SDK events
Ramps' events
Events' properties
🔁 Swap
Overview
Integration options
Swap widget flow
Architecture
Quickstart: Swap widget flow
Integrations (SDKs)
Best practices when integrating
Web SDK
React SDK
iOS SDK
Android SDK
React Native SDK
How to
Integrate using a URL
Integrate using an SDK
Configure the Swap user journey
Customize the widget's appearance
Enhance security using signed URLs
Transition to production
Swap API-driven flow
Architecture
Quickstart: Swap API-driven flow
Integrations (SDKs)
Best practices when integrating
Web SDK
React SDK
iOS SDK
Android SDK
React Native SDK
How to
Configure the Swap Customer Setup user journey
How to
Check which swap pairs are supported
🛍️ CHeckout
Overview
Quickstart
How to
Validate signature of requests
FAQ
Proxy smart contracts
Integration
Hosted checkout
Reservoir
Commerce flow
Partner driven
NFT Lite
🖼️ mintING
Overview
Architecture
Introduction to smart contracts
ERC-721a contract
ERC-1155 contract
Splitter contract
Token management
Token metadata basics
Proceeds and Royalties
Distributing proceeds
Wallets
Minting logistics
Minting time window
Access lists
Access list special features
Reserving tokens
Non-transferable or "soulbound" tokens
Quickstart
Create a collection
Create your NFTs
Choose a deployment environment
Launch your collection
Token gate an experience
Authorize access list purchases
FAQ
Integrations (SDK/API)
SDK integration
Authenticate
Contract
Constructor()
Buy()
buyAuthorized()
Burn()
Connect()
Disconnect()
getSigner() & setSigner()
getConnectedWallet()
getContractInformation()
getTokenMetadata()
getTokenMetadataUrl()
getTestWETH()
getTokenBalance()
getTotalMinted()
getToken()
getTokens()
getTokenAllocation()
getTransactionStatus()
getWalletBalance()
isWalletValid()
transfer()
waitForTransaction()
getMoonPayWidgetUrl()
API integration
GET: Contract Information
PUT: Create Draft Contract
PATCH: Deploy Contract
GET: Tokens
GET: Token Information
GET: Authorise Buy
PUT: Mint Token
GET: Mint Status
GET: Mints of Contract
GET: Owned Tokens
PUT: Transfer Token
GET: Transfer Status
PATCH: Update Contract Name and Symbol
PATCH: Update Contract (ERC-721a)
PATCH: Update Contract Metadata URLs
PATCH: Update Contract Buy on Network
PATCH: Update Contract Dates
PUT: Add Access Lists Addresses
PUT: Add Tokens (ERC-1155)
PATCH: Update Token (ERC-1155)
GET: Interaction Status
GET: Contract Hosted Metadata
GET: Token Hosted Metadata
PATCH: Set Token Hosted Metadata
PUT: Upload Contract and Token Metadata Media
GET: Token Allocation
GET: Verify Token Burn
ABI interface
ERC-721a
ERC-1155
Server code
Authorizing access list purchases
Self-hosted metadata
Development
Scalability
Authorization and token gating
👤 authenticatE
Overview
Quickstart
How to
Configure user authentication methods
Customize the experience
Get and inspect a partner token
Generate a wallet
FAQ
🎟️ Passes
Product Overview
Getting Started
Passes
Creating Passes
Scanning Passes
Querying Passes
Updating Passes
Distributing Passes
Using Pass Barcodes
Fetching Scan History
Using Webhooks
Policies
Creating Policies
Validating Policies
Attaching Policies To Passes
SDK
Installation & Setup
Components
<PassGenerator />
<GatedComponent />
Hooks
usePolicies
Hypermint APIs
Suggest Edits
These are the APIs
Updated 10 months ago
