API Reference

πŸ”— Integration Guide

Welcome to the JamsrPay Integration Guide. This section will provide everything you need to successfully integrate the crypto payment gateway into your website or platform.

🧩 Step 1: Create Your JamsrPay Account

➑️ Register and verify your email address to activate your account.

Developer Shortcut Explore and test the JamsrPay API using our Scalar API Explorer:

πŸ›οΈ Step 2: Set Up Your First Store

  • After logging in, you'll be prompted to create a store.
  • Provide basic details Store Name and Description.
  • Save the store.
πŸ”Ή

A store is required before you can generate payment links or use API integrations.

πŸ›’

Why a Store? Each store acts as a separate business unit inside JamsrPay. You can create multiple stores for different brands or services.


πŸ”‘ Step 3: Add Your Payout Wallet

To enable seamless fund transfers, it is essential to configure at least one payout wallet for instant payout. This wallet will be used for receiving automatic payouts once a payment is successfully processed.

  • Navigate to SETTINGS > Payout Wallets
  • Click on Manage Coins.
  • Choose your cryptocurrency (e.g., TRX, USDT, BTC, ETH) and enable it.
  • Add your payout address.

πŸ’³ Step 4: Accept Payments

You can accept payments in two ways:

  • Payment Links (no coding required) Generate a payment link and share it with your customers.
  • API Integration (developer-friendly) Create a payment, redirect users to the payment page, and receive real-time updates.

πŸ”‘ Step 5: Generate Your API Keys

  • Navigate to Settings > API Keys
  • Click Create API Key.
  • Use these keys to authenticate your API requests securely.

πŸ”” Step 6: Configure Webhooks (Recommended)

  • Go to Settings > Webhooks.
  • Enter the URL where JamsrPay should send payment status updates.
  • This allows automatic updates for order status.

πŸ§ͺ Step 7: Test with Test Coins

  • Purpose: Check full flow without using real funds.

JamsrPay offers a sandbox test environment for developers to simulate crypto payments without using real funds.

CoinNetworkFaucet Link
TRXNile TestnetLink
USDT (TRC-20)Nile TestnetLink
BTCBitcoin Testnet (Testnet3)Link
ETHSepolia TestnetLink
BNB & BNB TokensBNB Smart ChainLink
SOLDevnetLink

πŸš€ Step 8: Go Live

  • Once everything is set up and tested, Switch from Test Mode to Live Mode
  • Ensure API requests now use live API keys.