PAYRAM
API SPECS
  • INTRODUCTION
    • 👋PAYRAM
    • 💡Getting Started
      • Setup
      • YAML Configuration
      • Wallet Configuration
      • Reset Setup
      • Update PayRam Server
      • Check your Database
      • Project API Keys
      • Webhook Integration
      • 🦊Test Wallet Setup
  • PAYMENT INTEGERATION
    • 📪Payments Flow
    • 🎌Integrating Payments
      • Implementing the Payment Form
      • Generating a Payment Link
      • Get Payment Details
      • Checking Payment Status
      • Webhook
  • REFERRAL INTEGRATION
    • 👬Referral Flow
    • Create New Campaign
      • Embed the Referral Dashboard
      • Link Referrers to Referees
      • Trigger Events
  • Fund Management
    • 🛠️Smart Consolidation
    • ⛽GAS Station
    • 👮‍♀️Policy Management
  • DEVELOPERS
    • 🎨API Reference
    • 🧪Test Faucets
  • SUPPORT
    • ⁉️FAQ
    • 📅Change Log
Powered by GitBook
On this page
  • Supported Networks
  • 1. Prerequisites
  • 2. Getting Started with PayRam
  1. INTRODUCTION

Getting Started

Welcome to PayRam! This guide & video will help you set up and get started with PayRam in a few simple steps.

PreviousPAYRAMNextSetup

Last updated 12 days ago

Supported Networks

Currently, we support these networks for receiving payments.

Mainnet :

Testnet :

1. Prerequisites

Before starting, please ensure your system meets the following requirements:

Server Configuration

  • Use a VPS or a dedicated server with the minimum configuration to host the PayRam server.

  • Follow the hosting instructions to get your server up and running.

Minimum Configuration Requirements:

  • To run a PayRam server, ensure your machine meets the following minimum configuration:

    • CPU: 4 CPU cores

    • RAM: 4 GB

    • Storage: 50 GB SSD

    • Operating System: Ubuntu 22.04

  • Further upgrades based on scale are detailed in

Network Requirements

  • Make sure the following ports are open on your EC2 instance or server:

    • 80

    • 8080

    • 443

    • 8443

2. Getting Started with PayRam

After deploying PayRam to your server, follow these steps to set up your account and project:

Step 1: Create the Root Account

  • Navigate: Go to your hosted PayRam URL (e.g., https://yourdomain.com/).

  • Sign Up: Register using your email and password to create the root account. This account grants full access to all revenue data and allows you to manage team members by adding users with specific roles and permissions.

Step 2: Configure Your Project

  • Log In: Access the PayRam dashboard using your root account credentials.

  • Company Details: Enter your company information and select the cryptocurrencies you wish to accept.

  • Branding: Customize the payment page to match your company’s visual identity.

  • Integration: Once the setup is complete, API keys will be automatically generated for seamless integration of PayRam into your systems.

That's it! You have successfully set up Payram and you can now create and manage your projects and accept payments. For more detailed Project setup process and advanced configurations, refer to the further documentation.

💡
Ethereum
Bitcoin
Trx
Ethereum(Sepolia)
Bitcoin
Trx(Nile)
Page cover image