> ## 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.

# Create Customer

***

## icon: user-plus

# Create Customer

Use the Create Customer API to register a customer with KwikPaisa Neo Bank.

Once a customer is created successfully, KwikPaisa Neo Bank generates a unique customer ID (`x_customer_id`). This ID can be used when creating plans and subscriptions for the customer.

***

## Endpoint

```text theme={null}
POST /api/v3/pg/customer/create
```

***

#### 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

| Parameter | Type | Required | Description |
| :- | :- | :- | :- |
| `CUST_NAME` | String | Yes | Customer's full name |
| `CUST_EMAIL` | String | Yes | Customer's email address |
| `CUST_MOBILE` | String | Yes | Customer's mobile number |
| `CUST_ADDRESS_LINE1` | String | Yes | Primary address line |
| `CUST_ADDRESS_LINE2` | String | No | Secondary address line |
| `CUST_ADDRESS_CITY` | String | Yes | Customer's city |
| `CUST_ADDRESS_STATE` | String | Yes | Customer's state |
| `CUST_ADDRESS_COUNTRY` | String | Yes | Customer's country |
| `CUST_ADDRESS_POSTAL_CODE` | String | Yes | Customer's postal/ZIP code |

***

## Example Request Body

```text theme={null}
{
  "CUST_NAME": "Rahul Sharma",
  "CUST_EMAIL": "rahul@example.com",
  "CUST_MOBILE": "9999999999",
  "CUST_ADDRESS_LINE1": "House No. 101, Sector 15",
  "CUST_ADDRESS_LINE2": "Near City Park",
  "CUST_ADDRESS_CITY": "Hisar",
  "CUST_ADDRESS_STATE": "Haryana",
  "CUST_ADDRESS_COUNTRY": "India",
  "CUST_ADDRESS_POSTAL_CODE": "125001"
}
```

***

## Example cURL Request

```text theme={null}
curl --request POST \
--url https://sandbox.kwikpaisa.com/api/v3/pg/customer/create \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--header "X-API-KEY: pk_test_xxxxxxxxx" \
--header "X-TIMESTAMP: GENERATED_TIMESTAMP" \
--header "X-SIGNATURE: GENERATED_SIGNATURE" \
--data '{
  "CUST_NAME": "Rahul Sharma",
  "CUST_EMAIL": "rahul@example.com",
  "CUST_MOBILE": "9999999999",
  "CUST_ADDRESS_LINE1": "House No. 101, Sector 15",
  "CUST_ADDRESS_LINE2": "Near City Park",
  "CUST_ADDRESS_CITY": "Hisar",
  "CUST_ADDRESS_STATE": "Haryana",
  "CUST_ADDRESS_COUNTRY": "India",
  "CUST_ADDRESS_POSTAL_CODE": "125001"
}'
```

***

## Example Success Response

```text theme={null}
{
  "success": true,
  "message": "Customer created successfully",
  "customer": {
    "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"
  }
}
```

***

## Response Parameters

| Parameter | Description |
| :- | :- |
| `success` | Indicates whether the customer was created successfully |
| `message` | API response message |
| `customer.name` | Customer's full name |
| `customer.email` | Customer's email address |
| `customer.phone` | Customer's mobile number |
| `customer.address` | Customer's address details |
| `customer.x_customer_id` | Unique KwikPaisa Neo Bank generated customer ID |
| `customer.status` | Current customer status |
| `customer.created_at` | Customer creation timestamp |
| `customer.updated_at` | Customer last update timestamp |

***

## Example Error Response

The following response is returned when the required customer email and phone are missing.

```text theme={null}
{
  "message": "Customer email and phone are required",
  "errors": {
    "customer": [
      "Customer email and phone are required"
    ]
  }
}
```

***

## Important Notes

* `CUST_EMAIL` and `CUST_MOBILE` are required customer details.
* Always provide valid customer information.
* The `x_customer_id` is generated by KwikPaisa Neo Bank after successful customer creation.
* Store the returned `x_customer_id` for future customer-related API requests.
* Use the generated customer ID when creating a subscription for this customer.
* Generate API signatures on your server only.
* Never expose your secret key in frontend applications or client-side code.
* Use HTTPS for all API requests.

***

## Recommended Customer Flow

1. Collect customer details from your application.
2. Call the Create Customer API.
3. Receive the generated `x_customer_id`.
4. Store the customer ID in your system.
5. Use the customer ID for subsequent plan and subscription operations.


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