Rewrd API
  1. Merchant
Rewrd API
  • Customers
    • Create or Update a Customer
      POST
    • List Customers
      GET
    • Get a Customer
      GET
    • Update a Customer
      PUT
    • Restrict a Customer
      PATCH
    • Unrestrict a Customer
      PATCH
  • Merchant
    • Get Merchant Configuration
      GET
    • Update Merchant Configuration
      PATCH
    • List Earning Rules
      GET
    • Get Earning Rule Details
      GET
    • Get IP Whitelist
      GET
    • Update IP Whitelist
      PUT
    • Get Merchant Analytics
      GET
  • Points
    • Credit Points to a Customer
      POST
    • Redeem Points
      POST
    • Get Customer Transaction History
      GET
  1. Merchant

Get Merchant Configuration

GET
/merchant/config
Retrieves your current merchant configuration including profile information, social links, point expiry settings, webhook configuration, and security settings.
Use this endpoint to read your current settings before making updates.

Request

Authorization
JWT Bearer
Add the parameter
Authorization
to Headers
Example:
Authorization: ********************
or

Responses

🟢200OK
application/json
Merchant configuration retrieved successfully.
Body

🟠401Unauthorized
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request GET '/merchant/config' \
--header 'Authorization: Bearer <token>'
Response Response Example
200 - Example 1
{
    "status": true,
    "message": "Merchant configuration retrieved successfully",
    "data": {
        "merchant_id": "merch_xyz789",
        "email": "admin@mybusiness.com",
        "full_name": "My Coffee Shop",
        "phone_number": "+2348099887766",
        "created_at": "2025-12-01T08:00:00.000Z",
        "facebook": "https://facebook.com/mycoffeeshop",
        "ig_handle": "@mycoffeeshop",
        "linked_in": "string",
        "telegram": "string",
        "tiktok": "string",
        "whatsapp": "string",
        "x_handle": "string",
        "youtube": "string",
        "snapchat": "string",
        "point_balance": 50000,
        "last_chance_email_countdown": 7,
        "minimum_threshold_amount": 100,
        "point_should_expire": true,
        "reactivation_email_countdown": 30,
        "point_expiration_date": 365,
        "minimum_threshold_updated_at": "2019-08-24T14:15:22.123Z",
        "first_name": "Tolu",
        "last_name": "Adeyemi",
        "status": "active",
        "ip_whitelist": [
            "203.0.113.50",
            "198.51.100.25"
        ],
        "webhook_url": "https://mybusiness.com/webhooks/rewrd",
        "webhook_secret": "whsec_abc123..."
    }
}
Modified at 2026-02-25 12:17:15
Previous
Unrestrict a Customer
Next
Update Merchant Configuration
Built with