# WireDeposit

A deposit transfer using the wire mechanism

## Example Usage

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

let value: WireDeposit = {};
```

## Fields

| Field                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                 | Type                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  | Required                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              | Description                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                           | Example                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                               |
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `amount`                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              | [components.WireDepositAmount](../../models/components/wiredepositamount.md)                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          | :heavy_minus_sign:                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    | The amount of the wire deposit being issued to the investor in USD                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    | {<br/>"value": "10.00"<br/>}                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          |
| `bankReferenceId`                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                     | *string*                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              | :heavy_minus_sign:                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    | External reference identifier supplied by the bank                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    | 240109181237                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          |
| `fedReferenceNumber`                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  | *string*                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              | :heavy_minus_sign:                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    | The FedWire reference number for the deposit                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          | 20240215ABCDEFGH001234                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                |
| `name`                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                | *string*                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              | :heavy_minus_sign:                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    | Full name of the wire deposit which contains account_id and deposit transaction id                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    | accounts/01H8FB90ZRRFWXB4XC2JPJ1D4Y/wireDeposits/20230817000319                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       |
| `retirementContribution`                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              | [components.WireDepositRetirementContribution](../../models/components/wiredepositretirementcontribution.md)                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          | :heavy_minus_sign:                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    | The retirement contribution details                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                   |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       |
| `returnedWireWithdrawal`                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              | *boolean*                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                             | :heavy_minus_sign:                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    | Whether this wire deposit is a return of a wire withdrawal                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            | false                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                 |
| `state`                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                               | [components.WireDepositState](../../models/components/wiredepositstate.md)                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            | :heavy_minus_sign:                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    | The current state of the wire deposit                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                 |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       |
| `wireInstructions`                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    | *string*[]                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            | :heavy_minus_sign:                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    | The wire instructions received by Apex's bank for the wire deposit                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    | [<br/>"Incoming Money Transfer",<br/>"ORG=ACC-3962334059\|JANE DOUGH\|350 N ST PAUL ST, STE 1300\|DALLAS,TX,75201,US",<br/>"OGB=ABA-896073902\|CAPITAL ONE N.A.",<br/>"BNF=ACC-429737889148DD697\|JANE DOUGH\|350 N ST PAUL ST, STE 1300\|DALLAS,TX,75201,US",<br/>"DBT=CAPITAL ONE N.A.\|566763882410GL997",<br/>"CDT=APEX CLEARING CORP\|781435036193DD701",<br/>"SND=ABA-896073902\|CAPITAL ONE N.A.",<br/>"OBI=JANE DOUGH INDIVIDUAL BROKERAGE @FINFIRM #ABC1234",<br/>"SRC=FRB",<br/>"VDT=201028",<br/>"TRANSACTION AMOUNT=10.00,USD",<br/>"SBR=US240215583400",<br/>"RFB=MMOOPETQURZSPIB",<br/>"REF=20240215ABCDEFGH001234",<br/>"RTM=2024-02-15 17:19:57 -06:00",<br/>"ITM=2024-02-15 17:20:01 -06:00"<br/>] |