Skip to main content

Documentation Index

Fetch the complete documentation index at: https://mintlify.com/own-pay/OwnPay-Documentation/llms.txt

Use this file to discover all available pages before exploring further.

The Customers section of OwnPay is a centralised directory of every client who has interacted with your brand — whether they paid through a checkout link, settled an invoice, or were manually registered by your team. Each customer profile stores contact information, a full transaction history, and a lifetime spending total, giving administrators a complete picture of customer value at a glance. Customer data is encrypted in the database, and staff role restrictions may mask or block access to contact records depending on permissions. In the OwnPay admin dashboard, expand the PEOPLE section in the left sidebar and click Customers. The customer list view opens, scoped to your currently active brand.

Customer List View

The list view presents all registered customers for the active brand in a searchable, paginated table:
  • KPI Card — Displays the total customer count for the brand at the top of the page.
  • Search Toolbar — Search across customers by name, email address, or phone number.
  • Customers Table — Each row shows the customer’s Name and internal ID, Email, Phone, transaction volume count, Total Spent (in the brand’s base currency), and registration date.
  • ActionsView opens the full customer profile with their transaction history. Delete permanently removes the profile.
Customer data is encrypted in the database. Ensure that you have the appropriate permissions to view customer profiles, as staff role restrictions may mask or block access to email and phone records.

Creating a Customer Manually

1

Click Add Customer

On the Customers page, click the Add Customer button in the top-right corner to open the creation form.
2

Enter the customer's full name

Type the client’s full name in the Name field (e.g. Jane Smith). This is the name that appears on invoices and receipts sent to the customer.
3

Enter the email address

Type a valid email in the Email field (e.g. jane@example.com). This address receives payment notifications, invoice links, and receipt emails.
4

Enter a phone number (optional)

Add a contact number in international format in the Phone field (e.g. +8801700000000). This field is optional but recommended for mobile wallet gateways.
5

Save the profile

Click Add Customer. The new profile is saved to the database under your active brand’s merchant_id and the customer appears immediately in the list.
Before manually creating a new customer, use the search bar to check whether a profile already exists for that email address. Duplicate customer records fragment transaction history and inflate the customer count metric shown in reports.

Customer Fields Reference

FieldRequiredPlaceholderDescription
NameYesFull nameCustomer’s full name, shown on invoices and receipts.
EmailYesemail@example.comBilling and notification email address. Stored encrypted.
PhoneNo+880XXXXXXXXXXContact phone number. Stored encrypted. Optional.

Auto-Registration from Payment Flows

Customers do not need to be manually created for every payment. OwnPay automatically registers a new customer profile when:
  • A customer completes a checkout link (/checkout/{token}) for the first time.
  • A customer pays through a payment link (/pay/{slug}).
  • An invoice is sent to a new email address and the customer pays it.
In all these cases, the system creates a record in the op_customers table, scoped to the brand’s merchant_id. If the same email pays again, the existing profile is updated rather than duplicated.
Auto-registered customers have their details collected during the checkout flow itself. You do not need to pre-create customer profiles unless you are planning to issue invoices proactively before any payment has occurred.

Reviewing a Customer’s Transaction History

To review all payments linked to a customer, navigate to the Customers list and click View next to the target customer. The profile page shows their lifetime transaction count, total amount spent, and a full list of all historical invoices and payments associated with that account. This view is the fastest way to investigate a customer’s payment behaviour or verify whether a specific invoice was settled.

Best Practices

Avoid duplicate profiles

Always search by email before creating a customer manually. Duplicates split transaction history and produce inaccurate spending totals.

Do not delete active customers

Deleting a customer profile that has associated transactions orphans those transaction records. Only delete profiles with no payment history.

Verify email format on creation

Malformed emails will cause invoice and receipt delivery failures. OwnPay validates the format on save but cannot verify deliverability.

Use role permissions to protect PII

Restrict the manage_customers permission to staff who genuinely need full contact details. Support staff who only handle payment queries should receive view_customers with masked PII.

Build docs developers (and LLMs) love