# Create Brand Wallet

**Method:** `POST`

**Path:** `/payment-option/create/wallet`

**Category:** Brand Wallet

**Authentication:** Required

## Description

Creates brand wallets for one or more customers. The `customers` array must not be empty.
After creation, activate the wallet before it can be used for transactions.


## Request Body

Content-Type: `application/json`

- `currency_code` (`string`) — ISO 4217 currency code for the wallet
- `customers` (`CustomerDetails[]`) **required** — List of customers for whom wallets should be created
  - `email_id` (`string`) — Customer's email address.
  - `first_name` (`string`) — Customer's first name.
  - `last_name` (`string`) — Customer's last name.
  - `customer_id` (`string`) — Unique identifier of the customer.
  - `mobile_number` (`string`) — Customer's mobile number.
  - `country_code` (`string`) — Country code of the registered mobile number. Defaults to 91.
  - `billing_address` (`object`) — Physical address.
    - `address1` (`string`) — Address line 1.
    - `address2` (`string`) — Address line 2.
    - `address3` (`string`) — Address line 3.
    - `pincode` (`string`) — Postal/ZIP code.
    - `city` (`string`) — City name.
    - `state` (`string`) — State or province.
    - `country` (`string`) — Country name.
    - `full_name` (`string`) — Full name of the address holder.
    - `adddress_type` (`string`) — Type of address (e.g., Home, Office).
    - `address_category` (`billing | shipping`) — Category of the address.

  - `shipping_address` (`object`) — Physical address.
    - `address1` (`string`) — Address line 1.
    - `address2` (`string`) — Address line 2.
    - `address3` (`string`) — Address line 3.
    - `pincode` (`string`) — Postal/ZIP code.
    - `city` (`string`) — City name.
    - `state` (`string`) — State or province.
    - `country` (`string`) — Country name.
    - `full_name` (`string`) — Full name of the address holder.
    - `adddress_type` (`string`) — Type of address (e.g., Home, Office).
    - `address_category` (`billing | shipping`) — Category of the address.

  - `is_edit_customer_details_allowed` (`boolean`) — Whether the customer is allowed to edit their details.

- `notes` (`string`) — Free-text notes attached to the wallet creation request

### Example Request

```json
{
  "currency_code": "INR",
  "customers": [
    {
      "email_id": "john@example.com",
      "first_name": "Kevin",
      "last_name": "Bob",
      "customer_id": "123456",
      "mobile_number": "9876543210",
      "country_code": "91",
      "billing_address": {
        "address1": "10 Downing Street Westminster London",
        "address2": "Oxford Street Westminster London",
        "address3": "Baker Street Westminster London",
        "pincode": "51524036",
        "city": "Westminster",
        "state": "Westminster",
        "country": "London",
        "full_name": "Kevin Bob",
        "adddress_type": "Home",
        "address_category": "billing"
      },
      "shipping_address": {
        "address1": "10 Downing Street Westminster London",
        "address2": "Oxford Street Westminster London",
        "address3": "Baker Street Westminster London",
        "pincode": "51524036",
        "city": "Westminster",
        "state": "Westminster",
        "country": "London",
        "full_name": "Kevin Bob",
        "adddress_type": "Home",
        "address_category": "billing"
      },
      "is_edit_customer_details_allowed": false
    }
  ]
}
```

## Responses

- `200` — Wallets created successfully.
- `400` — 
- `401` — 
- `422` — Unprocessable entity.
- `500` — 

### Response Schema

- `currency_code` (`string`) — ISO 4217 currency code for the created wallets
- `customers` (`CustomerDetails[]`) — List of customers whose wallets were successfully activated
  - `email_id` (`string`) — Customer's email address.
  - `first_name` (`string`) — Customer's first name.
  - `last_name` (`string`) — Customer's last name.
  - `customer_id` (`string`) — Unique identifier of the customer.
  - `mobile_number` (`string`) — Customer's mobile number.
  - `country_code` (`string`) — Country code of the registered mobile number. Defaults to 91.
  - `billing_address` (`object`) — Physical address.
    - `address1` (`string`) — Address line 1.
    - `address2` (`string`) — Address line 2.
    - `address3` (`string`) — Address line 3.
    - `pincode` (`string`) — Postal/ZIP code.
    - `city` (`string`) — City name.
    - `state` (`string`) — State or province.
    - `country` (`string`) — Country name.
    - `full_name` (`string`) — Full name of the address holder.
    - `adddress_type` (`string`) — Type of address (e.g., Home, Office).
    - `address_category` (`billing | shipping`) — Category of the address.

  - `shipping_address` (`object`) — Physical address.
    - `address1` (`string`) — Address line 1.
    - `address2` (`string`) — Address line 2.
    - `address3` (`string`) — Address line 3.
    - `pincode` (`string`) — Postal/ZIP code.
    - `city` (`string`) — City name.
    - `state` (`string`) — State or province.
    - `country` (`string`) — Country name.
    - `full_name` (`string`) — Full name of the address holder.
    - `adddress_type` (`string`) — Type of address (e.g., Home, Office).
    - `address_category` (`billing | shipping`) — Category of the address.

  - `is_edit_customer_details_allowed` (`boolean`) — Whether the customer is allowed to edit their details.

- `notes` (`string`) — Notes from the creation request

### Example Response

```json
{
  "currency_code": "INR",
  "customers": [
    {
      "email_id": "john@example.com",
      "first_name": "Kevin",
      "last_name": "Bob",
      "customer_id": "123456",
      "mobile_number": "9876543210",
      "country_code": "91",
      "billing_address": {
        "address1": "10 Downing Street Westminster London",
        "address2": "Oxford Street Westminster London",
        "address3": "Baker Street Westminster London",
        "pincode": "51524036",
        "city": "Westminster",
        "state": "Westminster",
        "country": "London",
        "full_name": "Kevin Bob",
        "adddress_type": "Home",
        "address_category": "billing"
      },
      "shipping_address": {
        "address1": "10 Downing Street Westminster London",
        "address2": "Oxford Street Westminster London",
        "address3": "Baker Street Westminster London",
        "pincode": "51524036",
        "city": "Westminster",
        "state": "Westminster",
        "country": "London",
        "full_name": "Kevin Bob",
        "adddress_type": "Home",
        "address_category": "billing"
      },
      "is_edit_customer_details_allowed": false
    }
  ]
}
```

---

Reference: https://localhost:3000/api/brand-wallet/create-brand-wallet