Skip to main content
Customers represent the people or businesses you move money for — senders, recipients, merchants, or internal entities. Every organisation gets a primary customer at signup (representing the organisation itself). Existing swaps and routes without a customer are attributed to this primary customer. Required scopes: transfers:read (list), transfers:write (create)

Why customers matter

  • Attach customerId to swaps and payment routes for per-counterparty tracking
  • Filter GET /v1/swaps?customerId=... and GET /v1/transactions?customerId=...
  • Reconcile by customer name in the transactions ledger

List customers

curl https://api.remitflex.io/v1/customers \
  -H "Authorization: Bearer $REMITFLEX_API_KEY"
Response:
{
  "status": "success",
  "message": "Customers fetched",
  "data": {
    "customers": [
      {
        "id": "uuid",
        "name": "Acme Ltd",
        "email": "treasury@acme.io",
        "type": "business",
        "isPrimary": true,
        "createdAt": "2026-06-01T00:00:00.000Z"
      }
    ],
    "total": 1
  }
}

Create a customer

curl -X POST https://api.remitflex.io/v1/customers \
  -H "Authorization: Bearer $REMITFLEX_API_KEY" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Jane Supplier",
    "email": "jane@supplier.co.ke",
    "type": "individual"
  }'
FieldRules
name2–120 characters
emailValid email
typeindividual or business (default: individual)

Dashboard

View and filter activity per customer at dashboard.remitflex.ioOverview, Transactions, Payment routes, and per-customer receipts. API keys cannot manage dashboard-only settings.

API reference

List customers

GET /customers

Create customer

POST /customers