1. Customers
Rewrd API
  • Customers
    • Create a Customer
      POST
    • List Customers
      GET
    • Get a Customer
      GET
    • 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
    • List Merchant IPs
      GET
    • Add Merchant IP
      POST
    • Update Merchant IP
      PATCH
    • Delete Merchant IP
      DELETE
    • Get Merchant Analytics
      GET
  • Points
    • Process a Unified Points Transaction
      POST
    • Get Customer Transaction History
      GET
  1. Customers

Create a Customer

Development Server
https://rewrd-api-staging.fly.dev/v1
Development Server
https://rewrd-api-staging.fly.dev/v1
POST
/customers
Creates a new customer.
How the matching works:
Rewrd uses the phone_number to check if a customer already exists in your merchant account:
New customer (phone number not found) → A new customer record is created with status active and 0 points balance.
Existing customer (phone number already exists) → Returns a 409 error indicating the customer is already registered.
Uniqueness constraints:
phone_number is unique across all merchants — the same phone number cannot be registered by multiple merchants.
customer_email is unique across all merchants — the same email cannot be registered more than once.

Quick Start — Enroll your first customer:

This endpoint requires an Idempotency-Key header to prevent duplicate customer creation from retried requests.

Request

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

Body Params application/jsonRequired

Examples

Responses

🟢200OK
application/json
Customer created successfully.
Body

🟠400Bad Request
🟠401Unauthorized
🟠409
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request POST 'https://rewrd-api-staging.fly.dev/v1/customers' \
--header 'Idempotency-Key: customer-create-20260203-001' \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data-raw '{
    "customer_email": "jane@example.com",
    "phone_number": "+2348012345678"
}'
Response Response Example
200 - Example 1
{
    "status": true,
    "message": "Customer created successfully",
    "data": {
        "uid": "26833813",
        "email": "jane@example.com",
        "phone_number": "+2348012345678",
        "first_name": "Jane",
        "last_name": "Doe",
        "date_of_birth": "1995-06-15",
        "status": "active",
        "points_balance": 1500,
        "created_at": "2026-01-15T10:30:00.000Z"
    }
}
Modified at 2026-04-07 21:05:20
Next
List Customers
Built with