Standard Withdrawal

Event Key

ootb_withdrawal

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

Event KeyEvent NameType
ootb_withdrawalOOTB WithdrawalSimple 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. Below is the JSON structure for the context-specific properties of the Standard Withdrawal Event:

{
    "context": {
        "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

Parameter KeyParameter NameTypeDescription
ootb_withdrawal_timestampWithdrawal TimestampStringISO 8601 datetime of the withdrawal request.
ootb_start_balanceStart BalanceNumberThe user’s balance before the withdrawal.
ootb_withdrawal_amountWithdrawal AmountNumberThe amount of the withdrawal.
ootb_withdrawal_methodWithdrawal MethodStringThe method used for the withdrawal (e.g., bank_transfer).
ootb_withdrawal_statusWithdrawal StatusStringThe status of the withdrawal (e.g., pending).
ootb_languageLanguageStringThe language preference (e.g., en).
ootb_countryCountryStringThe country code (e.g., US).
ootb_platformPlatformStringThe platform used (e.g., iOS, Android).
ootb_channelChannelStringThe channel used for the withdrawal (e.g., mobile, web).
ootb_brandBrandStringThe skin ID associated with the withdrawal.
ootb_licenseLicenseStringThe license string associated with the withdrawal.

Explanation

  • event: The event name is set to ootb_withdrawal, reflecting that a user has initiated or completed a withdrawal of funds.
  • context: Contains all parameters relevant to the withdrawal event.
    • ootb_withdrawal_timestamp: The exact date and time when the withdrawal was requested or processed.
    • ootb_start_balance: The user's account balance before this withdrawal transaction.
    • ootb_withdrawal_amount: The monetary value being withdrawn by the user.
    • ootb_withdrawal_method: The method chosen by the user to receive the withdrawn funds (e.g., bank transfer, e-wallet).
    • ootb_withdrawal_status: The current status of the withdrawal request (e.g., pending review, completed successfully, failed).
    • ootb_language: The language setting of the user or platform at the time of the withdrawal.
    • ootb_country: The country associated with the user or the withdrawal transaction.
    • ootb_platform: The platform (e.g., iOS, Android, Web) from which the withdrawal was initiated.
    • ootb_channel: The channel (e.g., mobile app, website) used for the withdrawal.
    • ootb_brand: The specific brand or skin ID associated with the user's account or the withdrawal transaction.
    • ootb_license: Any relevant gaming or financial license identifier associated with the transaction.