Getting Started
This guide will help you quickly integrate Monero payments into your application.
Installation
Install the SDK using npm or yarn:
npm install monero-payment-sdk
# or
yarn add monero-payment-sdk
Basic Implementation
Step 1: Import the Component
import { MoneroPaymentComponent } from 'monero-payment-sdk';
Step 2: Add the Component to Your Page
function CheckoutPage() {
return (
<div>
<h1>Complete Your Purchase</h1>
<MoneroPaymentComponent
gatewayUrl="https://your-payment-gateway.com"
amount={0.01}
description="Premium Subscription"
onPaymentComplete={(id) => {
console.log(`Payment ${id} completed!`);
// Redirect to success page
}}
/>
</div>
);
}
Using a Remote Hosted Service
Popular Monero RPC Service Providers ???
NONE
ALWAYS RUN YOUR OWN NODE
Setup with a Hosted RPC Service
Create an Account with a Provider Most services will provide:
Host URL
Port number
Authentication credentials
Configure Your Gateway Use the provided credentials in your configuration:
<MoneroPaymentComponent gatewayUrl="https://your-selected-provider.com" apiKey="your-api-key" amount={0.01} description="Premium Subscription" />
Configuration Options
gatewayUrl
string
URL of your payment gateway
apiKey
string
Authentication key for the gateway
amount
number
Amount in XMR
description
string
Description of the payment
onPaymentComplete
function
Callback when payment is complete
onPaymentError
function
Callback when an error occurs
darkMode
boolean
Enable dark mode styling
For complete configuration options, see the Component API documentation.
Next Steps
Review the API Reference for more detailed information
See the Troubleshooting guide if you encounter issues
Last updated