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
  1. INTRODUCTION
  2. Getting Started

Wallet Configuration

PreviousYAML ConfigurationNextReset Setup

Last updated 1 month ago

  • Next, configure the wallets for Ethereum, Bitcoin, and TRX by updating the corresponding fields in the config.yaml file:

    wallets:
      Ethereum:
        xpub: ""
        deposit_addresses_count: ""
      Bitcoin:
        xpub: ""
        deposit_addresses_count: ""
      Trx:
        xpub: ""
        deposit_addresses_count: ""

How to Configure Wallets

  • Navigate to this link below [ this url is the payram server link which you just setup]

    http://yourpayramserver.com/addresses
  • After navigating to that link, you will see the following page:

  • You'll need to obtain a seed phrase (a 12-word mnemonic) from Meta Mask or another wallet of your choice.

  • If you need help creating a Meta Mask wallet, check out this guide: Link

    • This is what your 12-word seed phrase (mnemonic) looks like.

    staff topic tobacco item ethics shine stick assault metal accuse cake item
  • After obtaining the seed phrase, copy and paste it into the box

    Note : Now, generate xpub addresses for Bitcoin, Ethereum, and TRX, and paste them into the configuration file.

  • Click on the drop-down, select the Ethereum network, and then click "Generate Addresses."

  • After clicking on generate addresses you can see your xpub getting generated

  • You've successfully generated the xpub for Ethereum; now, add it to the config.yaml file.

    wallets:
      Ethereum:
        xpub: "" #add the generated Ethereum xpub key here
        deposit_addresses_count: "10"  # give a number for generating addresses

    Similarly, generate the xpub addresses for the other networks—Bitcoin testnet and Tron—using the same seed phrase which you used for Ethereum. You can change the networks by clicking on the drop-down menu

    Note : Don’t use Bitcoin use only Bitcoin Test net while selecting networks

    wallets:
      Ethereum:
        xpub: "" #add the generated Ethereum xpub key here
        deposit_addresses_count: "10" # give a number for generating addresses
      Bitcoin:
        xpub: "" #add the generated Bitcoin xpub key here
        deposit_addresses_count: "10" # give a number for generating addresses
      Trx:
        xpub: "" #add the generated Tron xpub key here
        deposit_addresses_count: "10" # give a number for generating addresses
  • After you fill in all the configuration details, your YAML file will look like the example below, but with your own values.

example
server: "PRODUCTION"  
configuration:
	wallet_connect_id: "03ec747d98f19c7c89d10605b6586cc3"
  payram.backend: "http://yourpayramserver.com:8080"
  payram.frontend: "http://yourpayramserver.com:80"
  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: "Ecommerce"
    website: "payram.app"
    successEndpoint: "http://yourwebsite.com:80/success"
    webhookEndpoint: "http://yourwebsite.com/webhook"
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: "xpub6DefrWHxsQRJPEZ1Vd2SVmE79ZazE7g3A11R5cQs48Zcp5VxgGfMfhVXd44uqXqnF9bSWH1E1RDEgfub25gH4nXfwkSdkHVR6P67VDUz7HZ"
    deposit_addresses_count: "10"
  Bitcoin:
    xpub: "tpubDFDy9XG6xJfUpPnKiiWTpxzBKLU4KaAsLDAAzaarvdSAhDRpPUBKVyEg5RxT85VbhR1qJdo5AwnNzaGx6jxQyvVR63dZNS6vy3uBSwwwS7c"
    deposit_addresses_count: "10"
  Trx:
    xpub: "xpub6Ees5117C2fXLL4ewmoGxwgdG8wGXmAKGFZMyx8sdE9q9jfhkTdcfHZ8GSxPyUjMJoCs5pxETWmzqfAtEm6TaJ2KqNkhd7j9PL2wnEMyjRR"
    deposit_addresses_count: "10"
  • Now you need to apply the newly added configurations to your server, which means we have to run the command again.

    • Run the below command again on your terminal

      rm -f script.sh && curl -sSL -o script.sh https://raw.githubusercontent.com/PayRam/payram-scripts/refs/heads/master/script.sh && chmod +x script.sh && ./script.sh
  • If you see this specific output in the terminal at the end, it means your PayRam server has started successfully.

Note: Currently, only testnet transactions are supported. For Ethereum, the Sepolia testnet is used.

💡
The API keys shown in the image above are 29e861c1c94304b96d919c79532bf7c6 and d32cd5cef7199fd7727c517672e3336e