# CreateWalletRequest

## Example Usage

```typescript
import { CreateWalletRequest } from "@flexprice/sdk/sdk/models";

let value: CreateWalletRequest = {
  currency: "Somali Shilling",
};
```

## Fields

| Field                                                                                                                                                                                                                                                                    | Type                                                                                                                                                                                                                                                                     | Required                                                                                                                                                                                                                                                                 | Description                                                                                                                                                                                                                                                              |
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| `alertSettings`                                                                                                                                                                                                                                                          | [models.AlertSettings](../../sdk/models/alert-settings.md)                                                                                                                                                                                                               | :heavy_minus_sign:                                                                                                                                                                                                                                                       | N/A                                                                                                                                                                                                                                                                      |
| `autoTopup`                                                                                                                                                                                                                                                              | [models.AutoTopup](../../sdk/models/auto-topup.md)                                                                                                                                                                                                                       | :heavy_minus_sign:                                                                                                                                                                                                                                                       | N/A                                                                                                                                                                                                                                                                      |
| `conversionRate`                                                                                                                                                                                                                                                         | *string*                                                                                                                                                                                                                                                                 | :heavy_minus_sign:                                                                                                                                                                                                                                                       | amount in the currency =  number of credits * conversion_rate<br/>ex if conversion_rate is 1, then 1 USD = 1 credit<br/>ex if conversion_rate is 2, then 1 USD = 0.5 credits<br/>ex if conversion_rate is 0.5, then 1 USD = 2 credits                                    |
| `currency`                                                                                                                                                                                                                                                               | *string*                                                                                                                                                                                                                                                                 | :heavy_check_mark:                                                                                                                                                                                                                                                       | N/A                                                                                                                                                                                                                                                                      |
| `customerId`                                                                                                                                                                                                                                                             | *string*                                                                                                                                                                                                                                                                 | :heavy_minus_sign:                                                                                                                                                                                                                                                       | N/A                                                                                                                                                                                                                                                                      |
| `description`                                                                                                                                                                                                                                                            | *string*                                                                                                                                                                                                                                                                 | :heavy_minus_sign:                                                                                                                                                                                                                                                       | N/A                                                                                                                                                                                                                                                                      |
| `externalCustomerId`                                                                                                                                                                                                                                                     | *string*                                                                                                                                                                                                                                                                 | :heavy_minus_sign:                                                                                                                                                                                                                                                       | external_customer_id is the customer id in the external system                                                                                                                                                                                                           |
| `initialCreditsExpiryDateUtc`                                                                                                                                                                                                                                            | *string*                                                                                                                                                                                                                                                                 | :heavy_minus_sign:                                                                                                                                                                                                                                                       | initial_credits_expiry_date_utc is the expiry date in UTC timezone (optional to set nil means no expiry)<br/>ex 2025-01-01 00:00:00 UTC                                                                                                                                  |
| `initialCreditsToLoad`                                                                                                                                                                                                                                                   | *string*                                                                                                                                                                                                                                                                 | :heavy_minus_sign:                                                                                                                                                                                                                                                       | initial_credits_to_load is the number of credits to load to the wallet<br/>if not provided, the wallet will be created with 0 balance<br/>NOTE: this is not the amount in the currency, but the number of credits                                                        |
| `initialCreditsToLoadExpiryDate`                                                                                                                                                                                                                                         | *number*                                                                                                                                                                                                                                                                 | :heavy_minus_sign:                                                                                                                                                                                                                                                       | initial_credits_to_load_expiry_date YYYYMMDD format in UTC timezone (optional to set nil means no expiry)<br/>for ex 20250101 means the credits will expire on 2025-01-01 00:00:00 UTC<br/>hence they will be available for use until 2024-12-31 23:59:59 UTC            |
| `metadata`                                                                                                                                                                                                                                                               | Record<string, *string*>                                                                                                                                                                                                                                                 | :heavy_minus_sign:                                                                                                                                                                                                                                                       | N/A                                                                                                                                                                                                                                                                      |
| `priceUnit`                                                                                                                                                                                                                                                              | *string*                                                                                                                                                                                                                                                                 | :heavy_minus_sign:                                                                                                                                                                                                                                                       | price_unit is the code of the price unit to use for wallet creation<br/>If provided, the price unit will be used to set the currency and conversion rate of the wallet:<br/>- currency: set to price unit's base_currency<br/>- conversion_rate: set to price unit's conversion_rate |
| `topupConversionRate`                                                                                                                                                                                                                                                    | *string*                                                                                                                                                                                                                                                                 | :heavy_minus_sign:                                                                                                                                                                                                                                                       | topup_conversion_rate is the conversion rate for the topup to the currency<br/>ex if topup_conversion_rate is 1, then 1 USD = 1 credit<br/>ex if topup_conversion_rate is 2, then 1 USD = 0.5 credits<br/>ex if topup_conversion_rate is 0.5, then 1 USD = 2 credits     |
| `walletType`                                                                                                                                                                                                                                                             | [models.WalletType](../../sdk/models/wallet-type.md)                                                                                                                                                                                                                     | :heavy_minus_sign:                                                                                                                                                                                                                                                       | N/A                                                                                                                                                                                                                                                                      |