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
      • Deployment FAQ's
      • Configuration FAQ's
      • API Integration FAQ's
      • Fund Management FAQ's
      • Referral FAQ's
      • Debug FAQ's
    • 📅Change Log
Powered by GitBook
On this page
  • Step 1: Connect to Your EC2 Instance
  • Step 2: Open Your Terminal and Switch to the Superuser
  • Step 3: Verify Your Current Directory
  • Step 4: Grant Directory Permissions
  • Step 5: Create the config.yaml File
  1. INTRODUCTION
  2. Getting Started

Setup

Step 1: Connect to Your EC2 Instance

  • Log in to your EC2 instance.

Step 2: Open Your Terminal and Switch to the Superuser

  • Open your terminal.

  • Run the following command to switch to the superuser:

sudo su

Step 3: Verify Your Current Directory

  • Confirm you are in the correct directory (ideally /home/ubuntu or your project directory):

  • Run the following command

pwd
/home/ubuntu

| Note: If the output differs, change your directory to /home/ubuntu.

Step 4: Grant Directory Permissions

  • Run the following command to set the necessary permissions:

sudo chmod o+x .

Step 5: Create the config.yaml File

  • Create a file named config.yaml and paste the configuration below:

    Note: The configuration controls your PayRam server settings. Do not modify existing values or the order of the keys.

  • To configure for Mainnet, use the configuration below

config.yaml
server: "PRODUCTION"
configuration:
  wallet_connect_id: ""
  payram.backend: ""
  payram.frontend: ""
  postal.endpoint: "https://postal.bedpayments.com"
  postal.apikey: "hwVUvX7kCkTyD5hn4KkiN4rh"
  ssl: false
database:
  postgres.host: "localhost"
  postgres.port: "5432"
  postgres.database: "payram"
  postgres.username: "payram"
  postgres.password: "payram123"
projects:
  project1:
    name: ""
    website: ""
    successEndpoint: ""
    webhookEndpoint: ""
blockchain:
  ETH:
    client: "geth"
    server: "https://ethereum-rpc.publicnode.com"
    server_api_key: ""
    explorer_address: "https://etherscan.io/address/"
    explorer_transaction: "https://etherscan.io/tx/"
    min_confirmations: 2
  BTC:
    client: "bitcoin_core"
    server: "13.210.195.110:8332"
    server_username: "payram"
    server_password: "bitpayram"
  TRX:
    client: "trongrid"
    server: "grpc.trongrid.io:50051"
    server_api_key: "170a584b-4139-4150-864a-65e1849cd031"
wallets:
  Ethereum:
    xpub: ""
    deposit_addresses_count: ""
  Bitcoin:
    xpub: ""
    deposit_addresses_count: ""
  Trx:
    xpub: ""
    deposit_addresses_count: ""
  • If you want to configure for Testnet for testing purpose, use the configuration below

config.yaml
server: "DEVELOPMENT"
configuration:
  wallet_connect_id: ""
  payram.backend: ""
  payram.frontend: ""
  postal.endpoint: "https://postal.bedpayments.com"
  postal.apikey: "hwVUvX7kCkTyD5hn4KkiN4rh"
  ssl: false
database:
  postgres.host: "localhost"
  postgres.port: "5432"
  postgres.database: "payram"
  postgres.username: "payram"
  postgres.password: "payram123"
projects:
  project1:
    name: ""
    website: ""
    successEndpoint: ""
    webhookEndpoint: ""
blockchain:
  ETH:
    client: "geth"
    server: "https://ethereum-sepolia-rpc.publicnode.com"
    server_api_key: ""
    explorer_address: "https://etherscan.io/address/"
    explorer_transaction: "https://etherscan.io/tx/"
    min_confirmations: 2
  BTC:
    client: "bitcoin_core"
    server: "13.211.216.231:18332"
    server_username: "payram"
    server_password: "bitpayramtest"
  TRX:
    client: "trongrid"
    server: "grpc.nile.trongrid.io:50051"
    server_api_key: "170a584b-4139-4150-864a-65e1849cd031"
wallets:
  Ethereum:
    xpub: ""
    deposit_addresses_count: ""
  Bitcoin:
    xpub: ""
    deposit_addresses_count: ""
  Trx:
    xpub: ""
    deposit_addresses_count: ""

Note: Use the testnet configuration for testing purposes and the mainnet configuration for production use.

PreviousGetting StartedNextYAML Configuration

Last updated 29 days ago

💡