Skip to main content

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


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

➡️ API Resources

This endpoint requires standard KwikPaisa Neo Bank authentication headers.

Refer to: ➡️ Headers
➡️ Signature Generation
➡️ Timestamp Validation

Request Parameters

This endpoint does not require any request body parameters.

Example cURL Request


Signature Generation

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

Example Success Response


Response Parameters


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.