> ## Documentation Index
> Fetch the complete documentation index at: https://docs.kwikpaisa.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Fetch All Customer

***

## icon: users

# List Customers

Use the List Customers API to retrieve all customers created under your KwikPaisa Neo Bank merchant account.

This API returns customer details, including their contact information, address, unique KwikPaisa customer ID, current status, and creation timestamps.

***

## Endpoint

```text theme={null}
GET /api/v3/pg/customers
```

***

#### To view all available base URLs and environments, refer to:

➡️ [API Resources](https://docs.kwikpaisa.com/guide/quick-start/api-resources.md)

#### This endpoint requires standard KwikPaisa Neo Bank authentication headers.

Refer to:

➡️ [Headers](https://docs.kwikpaisa.com/guide/authentication/headers.md)\
➡️ [Signature Generation](https://docs.kwikpaisa.com/guide/authentication/signature.md)\
➡️ [Timestamp Validation](https://docs.kwikpaisa.com/guide/authentication/timestamp.md)

***

## Request Parameters

This endpoint does not require any request body parameters.

***

## Example cURL Request

```text theme={null}
curl --request GET \
--url https://sandbox.kwikpaisa.com/api/v3/pg/customers \
--header "Accept: application/json" \
--header "X-API-KEY: pk_test_xxxxxxxxx" \
--header "X-TIMESTAMP: GENERATED_TIMESTAMP" \
--header "X-SIGNATURE: GENERATED_SIGNATURE"
```

***

## Signature Generation

For this GET request, generate the signature using an empty payload.

```text theme={null}
$timestamp = time();
$payload = [];

$jsonPayload = json_encode($payload, JSON_UNESCAPED_SLASHES);

$signature = hash_hmac(
    'sha256',
    $jsonPayload . $timestamp,
    $secretKey
);
```

***

## Example Success Response

```text theme={null}
{
  "success": true,
  "message": "Customers fetched successfully",
  "total": 36,
  "customers": [
    {
      "name": "Rahul Sharma",
      "email": "rahul@example.com",
      "phone": "9999999999",
      "address": {
        "line1": "House No. 101, Sector 15",
        "line2": "Near City Park",
        "city": "Hisar",
        "state": "Haryana",
        "country": "India",
        "postal_code": "125001"
      },
      "x_customer_id": "cust_d71f980e-4b3f-4e9b-9d14-7cfa92fd9134",
      "status": "active",
      "created_at": "2026-11-11T09:49:43.000000Z",
      "updated_at": "2026-11-11T09:49:43.000000Z"
    },
    {
      "name": "Rahul Sharma",
      "email": "rahul@example.com",
      "phone": "9876543210",
      "address": {
        "line1": "House No. 101, Sector 15",
        "line2": "Near City Park",
        "city": "Hisar",
        "state": "Haryana",
        "country": "India",
        "postal_code": "125001"
      },
      "x_customer_id": "cust_2a378860-deea-4fbc-bfa2-1193f2d2dff3",
      "status": "active",
      "created_at": "2026-11-11T09:38:30.000000Z",
      "updated_at": "2026-11-11T09:38:30.000000Z"
    },
    {
      "name": "Rahul Sharma",
      "email": "rahul@example.com",
      "phone": "9876543210",
      "address": {
        "line1": "House No. 101, Sector 15",
        "line2": "Near City Park",
        "city": "Hisar",
        "state": "Haryana",
        "country": "India",
        "postal_code": "125001"
      },
      "x_customer_id": "cust_0ed94aed-2c1f-46f5-ba17-92be39b80121",
      "status": "active",
      "created_at": "2026-11-11T09:38:09.000000Z",
      "updated_at": "2026-11-11T09:38:09.000000Z"
    }
  ]
}
```

***

## Response Parameters

| Parameter | Description |
| :- | :- |
| `success` | Indicates whether the customer list was fetched successfully |
| `message` | API response message |
| `total` | Total number of customers returned by the API |
| `customers` | Array containing customer records |
| `customers[].name` | Customer's full name |
| `customers[].email` | Customer's email address |
| `customers[].phone` | Customer's mobile number |
| `customers[].address` | Customer's address details |
| `customers[].x_customer_id` | Unique KwikPaisa Neo Bank generated customer ID |
| `customers[].status` | Current customer status |
| `customers[].created_at` | Customer creation timestamp |
| `customers[].updated_at` | Customer last update timestamp |

***

## Important Notes

* The API retrieves customers associated with the authenticated merchant account.
* Each customer has a unique `x_customer_id` generated by KwikPaisa Neo Bank.
* Store and use `x_customer_id` for subsequent customer-related operations, including subscription creation.
* The `total` field represents the total number of customers returned in the response.
* Customer records may contain nullable address fields.
* Generate API signatures on your server only.
* Use HTTPS for all API requests.


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.