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. REFERRAL INTEGRATION
  2. Create New Campaign

Link Referrers to Referees

  1. When referrers share their referral code to their referees, they need a place to enter this referral code i the Merchants UI.

  2. Merchants must add the ability to enter the code during sign-up code and call the Payram API described below to link the new user to their referrer.

  3. To link a referee to their referrer you will need to send your API key, referrers coupon code, referees email and unique reference ID.

Request & Response Example:

curl --location --request POST '<https://payram.resuefas.vip:8443/api/v1/referral/referee>' \\
--header 'API-Key: The API Key Shared with you.' \\
--header 'Content-Type: application/json' \\
--data-raw '{
    "email": "refree-xyz@gmail.com",
    "referrerCode": "M71DZ5E",
    "referenceID": "67890"
}'
{
  "id": 2,
  "createdAt": "2025-02-09T08:06:55.330723051Z",
  "updatedAt": "2025-02-09T08:06:55.330723051Z",
  "project": "1",
  "referenceId": "67890",
  "referrerId": 1,
  "referrerReferenceId": "12345",
  "email": "referee-xyz@gmail.com",
  "referrer": {
    "id": 1,
    "createdAt": "2025-02-08T11:59:29.837000303Z",
    "updatedAt": "2025-02-08T15:58:50.789707632Z",
    "project": "1",
    "referenceId": "12345",
    "email": "xyz@gmail.com",
    "code": "M71DZ5E",
    "status": "active",
    "campaigns": null
  }
}
  1. Users are more likely to enter a referral code if they receive a reward for doing so. This can be configured when creating the campaign.

  2. If you are planning to give a discount to the incoming users, make sure you configure this discount during your checkout process.

Next Steps:

  • Configure the event(s) at which you want the campaign rewards get activated for your users.

PreviousEmbed the Referral DashboardNextTrigger Events

Last updated 3 months ago