Customers API

Customers are contacts linked to your merchant account. A customer is created automatically when a payment link with Collect Customer Info enabled is paid. You can also create and manage customers directly via the API and attach them to payments using customer_id.

The customer object

{
  "data": {
    "id":         1,
    "name":       "Rahim Uddin",
    "email":      "rahim@example.com",
    "phone":      "01512345678",
    "address":    null,
    "notes":      null,
    "created_at": "2026-06-12T14:30:00+06:00",
    "updated_at": "2026-06-12T14:30:00+06:00"
  }
}

Create a customer

POST /api/v1/customers

{
  "name":    "Rahim Uddin",        // required — max 255 chars
  "phone":   "01512345678",        // required — max 20 chars
  "email":   "rahim@example.com",  // optional
  "address": "Dhaka, Bangladesh",  // optional — max 500 chars
  "notes":   "VIP customer"        // optional — max 2000 chars
}

Returns the created customer with HTTP 201.

Retrieve a customer

GET /api/v1/customers/{id}

Update a customer

PATCH /api/v1/customers/{id}

{
  "name":    "Rahim Uddin Jr.",
  "phone":   "01898765432",
  "email":   "new@example.com",
  "address": "Chittagong, Bangladesh",
  "notes":   "Updated note"
}

Only the fields you send are updated. Returns the updated customer.

List customers

GET /api/v1/customers?per_page=25
GET /api/v1/customers?email=rahim@example.com   // filter by email
GET /api/v1/customers?phone=01512345678         // filter by phone

Returns a paginated list, newest first. email, phone, and per_page (max 100, default 25) are optional filters.

Linking customers to payments

Every payment object includes a customer_id field. Set it yourself when creating a payment for a customer you already have, or let it populate automatically when a customer completes a payment link that has Collect Customer Info enabled. Either way, use customer_id to look up the customer or correlate payments to contacts in your system.