Skip to content

Customers

Retrieve customers

This endpoint is used to retrieve a list of customers.

Retrieve customer

This endpoint is used to retrieve details of a specific customer.

Update customer data

This endpoint is used to update customer data.

Delete customer

This endpoint is used to delete a specific customer and associated payment methods.

Retrieve payment methods

This endpoint is used to retrieve all payment methods for a specific customer.

Retrieve payment method

This endpoint is used to retrieve details of a specific payment method.

Delete payment method

This endpoint is used to delete a specific payment method.

Get list of customers

Request

Get list of customers

Security
bearer and basic and apiKey
Query
pageinteger, (int32)

Specifies page number

Example:page=2
createdFromstring

The createdAt date from witch the customers will be fetched

Example:createdFrom=2025-05-12
createdTostring

The createdAt date to witch the customers will be fetched

Example:createdTo=2025-05-15
merchantCustomerIdstring

The merchant customer id

Example:merchantCustomerId=Test_Merchant
emailstring

The email address

Example:email=test@gmail.com
phoneCountrystring

The phone country code

Example:phoneCountry=33
phoneNumberstring

The phone number

Example:phoneNumber=98746321
curl -i -X GET \
  -u '<username>:<password>' \
  'https://test.computop-paygate.com/api/v2/customers?page=2&createdFrom=2025-05-12&createdTo=2025-05-15&merchantCustomerId=Test_Merchant&email=test%40gmail.com&phoneCountry=33&phoneNumber=98746321' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'X-API-Key: YOUR_API_KEY_HERE'

Responses

Customers successfully retrieved

Bodyapplication/json
totalNumberOfPagesinteger, (int32)

Indicates total number of pages that exist.

totalNumberOfItemsinteger, (int32)

Indicates total number of items that exist.

pageinteger, (int32)

Indicates number of page that is retrieved.

pageSizeinteger, (int32)

Indicates max number of items on page.

dataArray of objects(baseCustomerData)
Response
{ "totalNumberOfPages": 5, "totalNumberOfItems": 82, "page": 5, "pageSize": 20, "data": [ { … }, { … } ] }