NOTE: Replace "" with either the IP address of the server where you're installing the payram setup, or the domain name to which you've mapped the server's address.
payram.backend
Explanation : Please enter the URL of the server where Payram is running, or the domain where Payram is configured. If you’re installing payram for first time then enter the IP address of the current server in which you’re setting up
Example:http://IP:8080 or http://yourpayramserver.com:8080
payram.frontend
Explanation: Please enter the URL of the server where Payram is running, or the domain where Payram is configured. If you’re installing payram for first time then enter the IP address of the current server in which you’re setting up
Example:http://IP or http://yourpayramserver.com
3.2. Projects
This section contains details for each project configured.
projects:
project1:
name: "Rare Rabbit"
website: "http:yourprojectwebsite.com"
successEndpoint: "http://yourprojectwebsite.com/success" # or use payrams http://yourpayramserver.com:8080/success
webhookEndpoint: "http://yourprojectwebsite.com/webhook" # or use payrams http://yourpayramserver.com:8080/v1/payment/webhook
Project Parameters
name
Explanation: The name of the project.
website
Explanation: The project's website URL
successEndpoint
Explanation : URL where users are redirected after a successful payment.
Tip: Use your own endpoint or the default Payram endpoint.
Note: When adding additional projects, follow this format exactly. Incorrect formatting of YAML keys will result in errors.
3.3. Blockchain Settings
This section configures settings for various blockchains used in the application.
There is no need to change any of the existing configuration values except for the server API key in TRX.
Blockchain
You only need to enter the server_api_key value for TRX
blockchain:
ETH:
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: "" #you need to add the key here
Steps to Obtain the TRX server_api_key
**Create/Log into Your Account:**Sign up for a new account or log in to your existing one.
Click on "Create API Key" in the top right corner
After clicking "Create API Key," you'll get a popup window. Enter your desired API key name and click create.
Click the check button to view the API key you created.
After obtaining the server_api_key, paste it into the blockchain > TRX > server_api_key value
blockchain:
ETH:
.......
.......
........
BTC:
......
.....
...........
TRX:
.......
.....
server_api_key: " paste your api key here in the config file"
After you fill in all the configuration details, your YAML file will look like the example below, but with your own values.
The script will install all the required dependencies. When prompted, enter an email address and password—these credentials will be used for signing up and logging into the server. This will be actually root details which will be your revenue account inside the payram server.
Note: Be sure to save your email and password in a secure location.
When the script completes, your terminal will display output at the end that looks like the image below:
[ ]
**Visit the API Provider:**Navigate to TronGrid at
Navigate to DashboardGo to
You will be redirected to where you can find your API key. If not automatically redirected, navigate to this page manually.
