# WireWithdrawalCreate

A withdrawal transfer using the wire mechanism

## Example Usage

```typescript
import { RecipientBankBankIdCreateType, WireWithdrawalCreate } from "@apexfintechsolutions/ascend-sdk/models/components";

let value: WireWithdrawalCreate = {
  beneficiary: {
    account: "73849218650987",
  },
  clientTransferId: "ABC-123",
  recipientBank: {
    bankId: {
      id: "ABNANL2AXXX",
      type: RecipientBankBankIdCreateType.Bic,
    },
  },
};
```

## Fields

| Field                                                                                                                                                                                                                                                                                                                                                        | Type                                                                                                                                                                                                                                                                                                                                                         | Required                                                                                                                                                                                                                                                                                                                                                     | Description                                                                                                                                                                                                                                                                                                                                                  | Example                                                                                                                                                                                                                                                                                                                                                      |
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| `amount`                                                                                                                                                                                                                                                                                                                                                     | [components.DecimalCreate](../../models/components/decimalcreate.md)                                                                                                                                                                                                                                                                                         | :heavy_minus_sign:                                                                                                                                                                                                                                                                                                                                           | A representation of a decimal value, such as 2.5. Clients may convert values into language-native decimal formats, such as Java's [BigDecimal][] or Python's [decimal.Decimal][].<br/><br/> [BigDecimal]:<br/> https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/math/BigDecimal.html<br/> [decimal.Decimal]: https://docs.python.org/3/library/decimal.html |                                                                                                                                                                                                                                                                                                                                                              |
| `beneficiary`                                                                                                                                                                                                                                                                                                                                                | [components.WireWithdrawalBeneficiaryCreate](../../models/components/wirewithdrawalbeneficiarycreate.md)                                                                                                                                                                                                                                                     | :heavy_check_mark:                                                                                                                                                                                                                                                                                                                                           | The person or entity taking receipt of the wired funds                                                                                                                                                                                                                                                                                                       |                                                                                                                                                                                                                                                                                                                                                              |
| `clientTransferId`                                                                                                                                                                                                                                                                                                                                           | *string*                                                                                                                                                                                                                                                                                                                                                     | :heavy_check_mark:                                                                                                                                                                                                                                                                                                                                           | External identifier supplied by the API caller. Each request must have a unique pairing of client_transfer_id and account                                                                                                                                                                                                                                    | ABC-123                                                                                                                                                                                                                                                                                                                                                      |
| `fullDisbursement`                                                                                                                                                                                                                                                                                                                                           | *boolean*                                                                                                                                                                                                                                                                                                                                                    | :heavy_minus_sign:                                                                                                                                                                                                                                                                                                                                           | Whether the entire account balance is being withdrawn. If this field is set to True, a transfer amount must not be specified                                                                                                                                                                                                                                 | false                                                                                                                                                                                                                                                                                                                                                        |
| `intermediary`                                                                                                                                                                                                                                                                                                                                               | [components.WireWithdrawalIntermediaryCreate](../../models/components/wirewithdrawalintermediarycreate.md)                                                                                                                                                                                                                                                   | :heavy_minus_sign:                                                                                                                                                                                                                                                                                                                                           | An intermediary party                                                                                                                                                                                                                                                                                                                                        |                                                                                                                                                                                                                                                                                                                                                              |
| `iraDistribution`                                                                                                                                                                                                                                                                                                                                            | [components.RetirementDistributionCreate](../../models/components/retirementdistributioncreate.md)                                                                                                                                                                                                                                                           | :heavy_minus_sign:                                                                                                                                                                                                                                                                                                                                           | A distribution from a retirement account.                                                                                                                                                                                                                                                                                                                    |                                                                                                                                                                                                                                                                                                                                                              |
| `recipientBank`                                                                                                                                                                                                                                                                                                                                              | [components.WireWithdrawalRecipientBankCreate](../../models/components/wirewithdrawalrecipientbankcreate.md)                                                                                                                                                                                                                                                 | :heavy_check_mark:                                                                                                                                                                                                                                                                                                                                           | A recipient bank / financial institution                                                                                                                                                                                                                                                                                                                     |                                                                                                                                                                                                                                                                                                                                                              |