Customers

{
  "id": "cmjr4c7qq0000v8hozkzz4em5",
  "firstname": "Melvin",
  "lastname": "Charles",
  "email": "mekus@orafi.app",
  "mode": ["test"],
  "totalSpent": 0,
  "createdAt": "2025-12-29T12:12:29.615Z",
  "updatedAt": "2025-12-29T12:12:29.615Z"
}

The customer object

A customer represents a buyer who has interacted with your business through Orafi. Customers are typically created automatically during payment flows.

string

Unique identifier for the customer.

string

Customer’s first name.

string

Customer’s last name.

string

Customer’s email address.

string[]

Environments the customer has interacted in. Contains test, live, or both.

number

default:"0"

Aggregate amount the customer has spent across all completed transactions.

datetime

When the customer record was created.

datetime

When the customer record was last updated.

{
  "id": "cmjr4c7qq0000v8hozkzz4em5",
  "firstname": "Melvin",
  "lastname": "Charles",
  "email": "mekus@orafi.app",
  "mode": ["test"],
  "totalSpent": 0,
  "createdAt": "2025-12-29T12:12:29.615Z",
  "updatedAt": "2025-12-29T12:12:29.615Z"
}

Create a customer

POST /customers/create

Manually creates a customer record.

In most flows, customers are created automatically when a payment is completed. Manual creation is intended for pre-registration, data migrations, or account-based billing.

Request body

string

required

Customer’s first name.

string

required

Customer’s last name.

string

required

Customer’s email address.

curl -X POST https://api.orafi.app/customers/create \
  -H "Content-Type: application/json" \
  -H "x-api-key: ora_test_your_api_key" \
  -d '{
    "firstname": "John",
    "lastname": "Doe",
    "email": "john@example.com"
  }'

const response = await fetch("https://api.orafi.app/customers/create", {
  method: "POST",
  headers: {
    "Content-Type": "application/json",
    "x-api-key": "ora_test_your_api_key"
  },
  body: JSON.stringify({
    firstname: "John",
    lastname: "Doe",
    email: "john@example.com"
  })
});

import requests

response = requests.post(
    "https://api.orafi.app/customers/create",
    headers={
        "Content-Type": "application/json",
        "x-api-key": "ora_test_your_api_key"
    },
    json={
        "firstname": "John",
        "lastname": "Doe",
        "email": "john@example.com"
    }
)

{
  "success": true,
  "message": "Customer created successfully",
  "data": {
    "id": "cmjx0kiie0003v86cfqsve9fj",
    "firstname": "John",
    "lastname": "Doe",
    "email": "john@example.com",
    "mode": ["test"],
    "totalSpent": 0
  }
}

List customers

GET /customers

Returns a paginated list of customers. All query parameters are optional.

Query parameters

string

Filter by spending range. One of BELOW10USDT, FROM10TO30USDT, FROM30TO100USDT, FROM100TO200USDT, FROM200TO500USDT, ABOVE500USDT.

string

Filter by environment. test or live.

number

default:"20"

Maximum number of results per page.

string

Pagination cursor. Results start after the referenced customer.

curl -X GET "https://api.orafi.app/customers?mode=test&limit=10" \
  -H "x-api-key: ora_test_your_api_key"

const response = await fetch(
  "https://api.orafi.app/customers?mode=test&limit=10",
  { headers: { "x-api-key": "ora_test_your_api_key" } }
);

import requests

response = requests.get(
    "https://api.orafi.app/customers",
    headers={"x-api-key": "ora_test_your_api_key"},
    params={"mode": "test", "limit": 10}
)

{
  "success": true,
  "message": "Customers fetched successfully",
  "data": {
    "customers": [
      {
        "id": "cmjr4c7qq0000v8hozkzz4em5",
        "firstname": "Melvin",
        "lastname": "Charles",
        "email": "mekus@orafi.app",
        "mode": ["test"],
        "totalSpent": 0,
        "userCustomers": [
          { "createdAt": "2025-12-29T12:12:29.615Z" }
        ]
      }
    ],
    "count": 1,
    "nextCursor": null,
    "hasNextPage": false
  }
}

Retrieve a customer

GET /customers/{customerId}

Returns the details of a specific customer.

Path parameters

string

required

The customer ID to retrieve.

curl -X GET https://api.orafi.app/customers/cmjr4c7qq0000v8hozkzz4em5 \
  -H "x-api-key: ora_test_your_api_key"

const response = await fetch(
  "https://api.orafi.app/customers/cmjr4c7qq0000v8hozkzz4em5",
  { headers: { "x-api-key": "ora_test_your_api_key" } }
);

import requests

response = requests.get(
    "https://api.orafi.app/customers/cmjr4c7qq0000v8hozkzz4em5",
    headers={"x-api-key": "ora_test_your_api_key"}
)

{
  "success": true,
  "message": "Customer fetched successfully",
  "data": {
    "id": "cmjr4c7qq0000v8hozkzz4em5",
    "firstname": "Melvin",
    "lastname": "Charles",
    "email": "mekus@orafi.app",
    "mode": ["test"],
    "totalSpent": 0,
    "userCustomers": [
      { "createdAt": "2025-12-29T12:12:29.615Z" }
    ]
  }
}

Delete a customer

DELETE /customers/{customerId}

Permanently deletes a customer record. This action cannot be undone.

Deleting a customer is irreversible. Only use this for duplicate records, accidental creation, or compliance-related data removal requests. We recommend keeping records for transaction history and reconciliation.

Path parameters

string

required

The customer ID to delete.

curl -X DELETE https://api.orafi.app/customers/cmjr4c7qq0000v8hozkzz4em5 \
  -H "x-api-key: ora_test_your_api_key"

const response = await fetch(
  "https://api.orafi.app/customers/cmjr4c7qq0000v8hozkzz4em5",
  {
    method: "DELETE",
    headers: { "x-api-key": "ora_test_your_api_key" }
  }
);

import requests

response = requests.delete(
    "https://api.orafi.app/customers/cmjr4c7qq0000v8hozkzz4em5",
    headers={"x-api-key": "ora_test_your_api_key"}
)

{
  "success": true,
  "message": "User Deleted successfully",
  "data": null
}

Overview

Transactions

Payments

Refunds

Payouts

Paylinks

Subscriptions

Webhooks

Webhook Deliveries

Crypto Settlements

Fiat Settlements

Profile

Mode

Notifications

Extras

Customers

The customer object

Create a customer

Request body

List customers

Query parameters

Retrieve a customer

Path parameters

Delete a customer

Path parameters

​The customer object

​Create a customer

​Request body

​List customers

​Query parameters

​Retrieve a customer

​Path parameters

​Delete a customer

​Path parameters

The customer object

Create a customer

Request body

List customers

Query parameters

Retrieve a customer

Path parameters

Delete a customer

Path parameters