# TopUpWalletRequest

## Example Usage

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

let value: TopUpWalletRequest = {
  transactionReason: "INVOICE_PAYMENT",
};
```

## Fields

| Field                                                                                                                                                                                                                                                                                                                                                                                    | Type                                                                                                                                                                                                                                                                                                                                                                                     | Required                                                                                                                                                                                                                                                                                                                                                                                 | Description                                                                                                                                                                                                                                                                                                                                                                              |
| ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `amount`                                                                                                                                                                                                                                                                                                                                                                                 | *string*                                                                                                                                                                                                                                                                                                                                                                                 | :heavy_minus_sign:                                                                                                                                                                                                                                                                                                                                                                       | amount is the amount in the currency of the wallet to be added<br/>NOTE: this is not the number of credits to add, but the amount in the currency<br/>amount = credits_to_add * conversion_rate<br/>if both amount and credits_to_add are provided, amount will be ignored<br/>ex if the wallet has a conversion_rate of 2 then adding an amount of<br/>10 USD in the wallet wil add 5 credits in the wallet |
| `bonusCreditsExpiryDateUtc`                                                                                                                                                                                                                                                                                                                                                              | *string*                                                                                                                                                                                                                                                                                                                                                                                 | :heavy_minus_sign:                                                                                                                                                                                                                                                                                                                                                                       | bonus_credits_expiry_date_utc is the expiry (UTC, full precision) applied to the bonus<br/>credits transaction. Independent of expiry_date_utc, which governs the purchase credits.<br/>Only honored when bonus credits are actually granted (explicit BonusCreditsToAdd or slab).                                                                                                       |
| `bonusCreditsToAdd`                                                                                                                                                                                                                                                                                                                                                                      | *string*                                                                                                                                                                                                                                                                                                                                                                                 | :heavy_minus_sign:                                                                                                                                                                                                                                                                                                                                                                       | bonus_credits_to_add is an explicit override for the bonus credits granted alongside this<br/>purchase. When nil/omitted, the bonus is resolved from the tenant's<br/>bonus_credits_topup_config slabs (if enabled). When set, it must be greater than 0 and is<br/>used as-is, skipping slab resolution. To grant no bonus, omit this field entirely.                                   |
| `checkout`                                                                                                                                                                                                                                                                                                                                                                               | [models.CheckoutParams](../../sdk/models/checkout-params.md)                                                                                                                                                                                                                                                                                                                             | :heavy_minus_sign:                                                                                                                                                                                                                                                                                                                                                                       | N/A                                                                                                                                                                                                                                                                                                                                                                                      |
| `creditsToAdd`                                                                                                                                                                                                                                                                                                                                                                           | *string*                                                                                                                                                                                                                                                                                                                                                                                 | :heavy_minus_sign:                                                                                                                                                                                                                                                                                                                                                                       | credits_to_add is the number of credits to add to the wallet                                                                                                                                                                                                                                                                                                                             |
| `description`                                                                                                                                                                                                                                                                                                                                                                            | *string*                                                                                                                                                                                                                                                                                                                                                                                 | :heavy_minus_sign:                                                                                                                                                                                                                                                                                                                                                                       | description to add any specific details about the transaction                                                                                                                                                                                                                                                                                                                            |
| `expiryDateUtc`                                                                                                                                                                                                                                                                                                                                                                          | *string*                                                                                                                                                                                                                                                                                                                                                                                 | :heavy_minus_sign:                                                                                                                                                                                                                                                                                                                                                                       | expiry_date_utc is the expiry date in UTC timezone<br/>ex 2025-01-01 00:00:00 UTC                                                                                                                                                                                                                                                                                                        |
| `forceSyncInvoice`                                                                                                                                                                                                                                                                                                                                                                       | *boolean*                                                                                                                                                                                                                                                                                                                                                                                | :heavy_minus_sign:                                                                                                                                                                                                                                                                                                                                                                       | N/A                                                                                                                                                                                                                                                                                                                                                                                      |
| `idempotencyKey`                                                                                                                                                                                                                                                                                                                                                                         | *string*                                                                                                                                                                                                                                                                                                                                                                                 | :heavy_minus_sign:                                                                                                                                                                                                                                                                                                                                                                       | idempotency_key is a unique key for the transaction                                                                                                                                                                                                                                                                                                                                      |
| `metadata`                                                                                                                                                                                                                                                                                                                                                                               | Record<string, *string*>                                                                                                                                                                                                                                                                                                                                                                 | :heavy_minus_sign:                                                                                                                                                                                                                                                                                                                                                                       | N/A                                                                                                                                                                                                                                                                                                                                                                                      |
| `priority`                                                                                                                                                                                                                                                                                                                                                                               | *number*                                                                                                                                                                                                                                                                                                                                                                                 | :heavy_minus_sign:                                                                                                                                                                                                                                                                                                                                                                       | priority is the priority of the transaction<br/>lower number means higher priority<br/>default is nil which means no priority at all                                                                                                                                                                                                                                                     |
| `transactionReason`                                                                                                                                                                                                                                                                                                                                                                      | [models.TransactionReason](../../sdk/models/transaction-reason.md)                                                                                                                                                                                                                                                                                                                       | :heavy_check_mark:                                                                                                                                                                                                                                                                                                                                                                       | N/A                                                                                                                                                                                                                                                                                                                                                                                      |