# Payout Created

**Webhook:** `PayoutCreated`

Triggered when a payout request has been successfully created for a trader. This webhook is typically used to notify finance systems, and confirmation emails, or update dashboards and records related to user earnings.

```json
{
  "webhookType"          : "PayoutCreated",
  "testMode"             : false,
  "userId"               : "<user_id>",
  "userFirstname"        : "<user_firstname>",
  "userLastname"         : "<user_lastname>",
  "userEmail"            : "<user_email>",
  "userCountryCode"      : "<user_country>",
  "programId"            : "<program_id>",
  "programName"          : "<program_name>",
  "accountId"            : "<account_id>",
  "accountLogin"         : "<account_login>",
  "payoutMethod"         : "<payout_method>",
  "payoutCurrency"       : "<payout_currency>",
  "payoutAmount"         : "<payout_amount>",
  "payoutProfitSplit"    : "<payout_profitsplit>",
  "payoutCommission"     : "<payout_commission>",
  "payoutTraderReceive"  : "<payout_earning>",
  "payoutDetails"        : "<payout_details>",
  "requestTimestamp"     : "<request_timestamp>"
}
```

## Payload Structure

| Field                 | Type    | Description                                                                                                                                                                                                                                                                                                                                                                                                                      |
| --------------------- | ------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `webhookType`         | String  | Type of webhook event. Always `PayoutCreated` for this webhook.                                                                                                                                                                                                                                                                                                                                                                  |
| `testMode`            | Boolean | Flag to indicate whether this payload is a test `true` or live `false`. Currently, only `false` is supported.                                                                                                                                                                                                                                                                                                                    |
| `userId`              | String  | Unique identifier for the user within YourPropFirm SaaS platform.                                                                                                                                                                                                                                                                                                                                                                |
| `userFirstname`       | String  | First name of the user.                                                                                                                                                                                                                                                                                                                                                                                                          |
| `userLastname`        | String  | Last name of the user.                                                                                                                                                                                                                                                                                                                                                                                                           |
| `userEmail`           | String  | Email address of the user, also the user unique identifier for authentication.                                                                                                                                                                                                                                                                                                                                                   |
| `userCountryCode`     | String  | ISO 3166-1 alpha-2 country code (e.g., `US`, `SG`, `GB`) of the user’s address.                                                                                                                                                                                                                                                                                                                                                  |
| `programId`           | String  | Unique identifier for the trading program or plan the user enrolled in.                                                                                                                                                                                                                                                                                                                                                          |
| `programName`         | String  | Display name of the trading program of the user joined.                                                                                                                                                                                                                                                                                                                                                                          |
| `accountId`           | String  | Internal ID used to reference the created trading account.                                                                                                                                                                                                                                                                                                                                                                       |
| `accountLogin`        | String  | Login ID or number for accessing the trading account on the platform.                                                                                                                                                                                                                                                                                                                                                            |
| `payoutMethod`        | String  | <p>Method used for payout (e.g., <code>BankTransfer</code>,<br><code>USDTWalletTransfer</code>,<br><code>BTCWalletTransfer</code>,<br><code>Rise</code>,<br><code>Email</code>,<br><code>EmailBankTransfer</code>).</p>                                                                                                                                                                                                          |
| `payoutCurrency`      | String  | Currency used for the payout (e.g., `USD`).                                                                                                                                                                                                                                                                                                                                                                                      |
| `payoutAmount`        | Number  | Total payout amount before deductions.                                                                                                                                                                                                                                                                                                                                                                                           |
| `payoutProfitSplit`   | Number  | The number of profit split for the trader in percentage (e.g., `80`).                                                                                                                                                                                                                                                                                                                                                            |
| `payoutCommission`    | Number  | Any commission or fee deducted from the payout.                                                                                                                                                                                                                                                                                                                                                                                  |
| `payoutTraderReceive` | Number  | Final amount the trader will receive after profit split and commission.                                                                                                                                                                                                                                                                                                                                                          |
| `payoutDetails`       | String  | <p>Additional payout information (e.g., bank or crypto wallet details).</p><p>Bank</p><p><code>{ "BankName": "Santander Uk Plc", "BankCity": "Bootle", "BankCountry": "United Kingdom", "Currency": "USD", "AccountHolderName": "John Doe", "SwiftBic": "ABBYGB2L", "AccountNumber": "\<Bank Account Number>" }</code></p><p>Crypto Wallet</p><p><code>{ "WalletAddress" : "\<Wallet Address>", "Currency" : "USDT" }</code></p> |
| `requestTimestamp`    | String  | ISO 8601. Timestamp of when the payout request was made.                                                                                                                                                                                                                                                                                                                                                                         |