---
updatedAt: 2026-06-30T14:31:00.000Z
agentTools:
  projectIndex: https://developer.optimove.com/llms.txt
---

# Standard Withdrawal

## Event Key

`ootb_withdrawal`

This event should be sent when a user conducts a withdrawal.

| **Event Key**     | **Event Name**  | **Type**     |
| ----------------- | --------------- | ------------ |
| `ootb_withdrawal` | OOTB Withdrawal | Simple event |

## Event Structure

The **mandatory properties** (`tenant`, `timestamp`, `event`, and `customer`) are required for all events and documented in detail on the [Mandatory Properties page](https://developer.optimove.com/docs/mandatory-properties-for-standard-events). Below is the JSON structure for the **context-specific properties** of the Standard Withdrawal Event:

```json
{
  "context": {
        "ootb_transaction_id": "11228836059",
        "ootb_withdrawal_timestamp": "2022-04-09T20:01:51.887000Z",
        "ootb_start_balance": 200.00,
        "ootb_withdrawal_amount": 50.00,
        "ootb_withdrawal_method": "bank_transfer",
        "ootb_withdrawal_status": "pending",
        "ootb_language": "en",
        "ootb_country": "US",
        "ootb_platform": "iOS",
        "ootb_channel": "mobile",
        "ootb_brand": "skin123",
        "ootb_license": "licenseXYZ"
    }
}
```

## Parameters

<Callout icon="📘" theme="info">
  ### Events-based Integration (EBI): parameter classification
  The **Events-based Integration** column shows how each parameter is treated when you onboard using an Events-based Integration:
 
  - **Mandatory** — required for the event to be ingested and processed correctly.
  - **Mandatory if required for the execution channel integration** — required only when the relevant execution channel (e.g., email, SMS, push, WhatsApp) is part of your integration.
  - **Enrichment- used for out-of-the-box attribute** — not required, but when provided it powers an Optimove out-of-the-box attribute.
  - **Optional** — accepted and stored when provided; not required and not tied to an OOTB attribute.
</Callout>

| **Parameter Key**           | **Parameter Name**   | **Type**      | **Description**                                                            | Events-based Integration                      |
| :-------------------------- | :------------------- | :------------ | :------------------------------------------------------------------------- | :-------------------------------------------- |
| `ootb_transaction_id`       | Transaction ID       | String/Number | Unique identifier for the transaction that resulted in the balance update. | Mandatory                                     |
| `ootb_withdrawal_timestamp` | Withdrawal Timestamp | String        | ISO 8601 datetime of the withdrawal request.                               | Mandatory                                     |
| `ootb_start_balance`        | Start Balance        | Number        | The user’s balance before the withdrawal.                                  | Optional                                      |
| `ootb_withdrawal_amount`    | Withdrawal Amount    | Number        | The amount of the withdrawal.                                              | Enrichment- used for out-of-the-box attribute |
| `ootb_withdrawal_method`    | Withdrawal Method    | String        | The method used for the withdrawal (e.g., bank\_transfer).                 | Optional                                      |
| `ootb_withdrawal_status`    | Withdrawal Status    | String        | The status of the withdrawal (e.g., pending).                              | Mandatory                                     |
| `ootb_language`             | Language             | String        | The language preference (e.g., en).                                        | Optional                                      |
| `ootb_country`              | Country              | String        | The country code (e.g., US).                                               | Optional                                      |
| `ootb_platform`             | Platform             | String        | The platform used (e.g., iOS, Android).                                    | Enrichment- used for out-of-the-box attribute |
| `ootb_channel`              | Channel              | String        | The channel used for the withdrawal (e.g., mobile, web).                   | Optional                                      |
| `ootb_brand`                | Brand                | String        | The skin ID associated with the withdrawal.                                | Optional                                      |
| `ootb_license`              | License              | String        | The license string associated with the withdrawal.                         | Optional                                      |