Get Customer List

Retrieve a list of all registered customers for a specific merchant account.

Endpoint Information

Name: Get Customer List
Method: GET
URL: {{base_url}}/api/v1/get-customer-list?search=&filterByEmail=&merchantAccountId=100002

Description

This endpoint allows you to search and filter through the list of customers associated with your merchant account.

Authentication

Type: Basic Auth

• Username: App Key
• Password: Secret Key

Request Parameters

Parameter	Type	Required	Description
search	string	No	Search by customer name or other details
filterByEmail	string	No	Filter the list by customer email
merchantAccountId	string	Yes	Your Merchant Account ID

Response

Success Response

{
    "success": true,
    "message": "Success",
    "data": [
        {
            "customer": {
                "customer_reference_id": "0379b581-b6d3-41e3-8869-d32273a33cb8",
                "first_name": "John",
                "middle_name": null,
                "last_name": "DOe",
                "email": "[email protected]",
                "dob": "2025-10-01",
                "contact_number": "32423423432",
                "address_details": {
                    "country": "Sweden",
                    "state": null,
                    "city": null,
                    "address": "Stockholmes",
                    "zip_code": null
                }
            }
        }
    ]
}