✨Create Payment

In this section, you’ll learn how to create a payment link using the PayRam API for customers to make payments easily.

---

URL Details

Parameter	Description	Example
BASE_URL	Your PayRam server URL	https://yourdomain.com:8443
API Endpoint	Endpoint to create a new payment link.	/api/v1/payment

Note : You can generate a unique API key for each project directly from the PayRam dashboard. This helps you manage and track payouts separately for every project.

Headers

Header	Description	Example
API-Key	Your unique PayRam API key generated from your dashboard.	811b12035f0dfa8ffd62296df3c98b27
Content-Type	Format of the request data.	application/json

Request Body

Field	Description	Example
customerEmail	Customer’s email address where the payment link will be associated.	[email protected]
customerID	Unique identifier for the customer.	1
amountInUSD	The payment amount in USD.	10

curl request

Before running the command, replace the placeholders with your actual details:

• ${BASE_URL} → Your PayRam server URL

• <your_api_key> → Your PayRam API key

• Replace the request body fields with real customer data

curl --location '${BASE_URL}/api/v1/payment' \
--header 'API-Key: <your_api_key>' \
--header 'Content-Type: application/json' \
--data-raw '{
  "customerEmail": "<customer_email>",
  "customerID": "<customer_id>",
  "amountInUSD": <amount_in_usd>
}'

curl response

{
  "host": "https://yourdomain.com:8443",
  "reference_id": "c80f5363-0397-4761-aa1a-3155c3a21470",
  "url": "https://yourdomain.com/payments?reference_id=c80f5363-0397-4761-aa1a-3155c3a21470&host=https://yourdomain.com:8443"
}

Note : The url field provides a ready-to-use PayRam payment page. You can share this link directly with your customers, or build a custom UI using other API endpoints.