Customers
Customers
Create merchant-scoped customer records for balances and reusable payment relationships.
A Customer is the merchant-owned identity boundary for customer balances, deposits, withdrawals
and Paybytoken Pay links. It is not a global Paybytoken consumer identity. Store its id against
your own customer record and use reference as your stable, non-secret correlation value.
Endpoints
| Method | Endpoint | Purpose |
|---|---|---|
POST | /api/v1/customers | Create a customer. |
GET | /api/v1/customers | List merchant-owned customers. |
GET | /api/v1/customers/:customerId | Retrieve one customer. |
PATCH | /api/v1/customers/:customerId | Update status or metadata. |
curl https://api-prod.paybytoken.io/api/v1/customers \
-X POST \
-H "Authorization: Bearer $PAYBYTOKEN_SECRET_KEY" \
-H "Idempotency-Key: customer:merchant_customer_8" \
-H "Content-Type: application/json" \
-d '{
"reference": "merchant_customer_8",
"email": "alex@example.com",
"name": "Alex",
"metadata": { "segment": "pro" }
}'Statuses are active, restricted, and closed. Restrict a customer to stop new funds-moving
operations while preserving its audit history. Do not place secrets, authentication tokens or
sensitive identity documents in reference or metadata.
Did this page answer your question?
Your feedback helps us improve the integration path.