Customers

/docs/global/api-reference/customersGlobal

Customer records are derived automatically from payment activity — there is no separate “create customer” call. The first time an email or phone pays you, a customer is created; every subsequent payment from the same identifier links to it.

Authenticated by dashboard session, not an API key

Authorized by your dashboard session bearer token, not an sk_ key — see Authentication. Paths below are relative to https://binkpay.net/api/v1.

List customers

GET/api/v1/merchant/customers

Returns customers ranked by lifetime paid volume, with per-currency totals.

Customer stats

GET/api/v1/merchant/customers/stats

Retrieve a customer

GET/api/v1/merchant/customers/:id

json

{
 "id": "cus_4b7e21",
 "name": "Mohamed Ahmed",
 "email": "mohamed@example.com",
 "totalsByCurrency": [
 { "currency": "EGP", "paidMinor": "184500", "count": 7 }
 ]
}

A customer's payments

GET/api/v1/merchant/customers/:id/payments

Parameter	Type	Required	Description
id	string (path)	Required	The customer ID.

Related resources

Payments — the activity that creates and links customer records.

Was this page helpful?