# ~~TransferState~~

Deprecated: use state instead

> :warning: **DEPRECATED**: This will be removed in a future release, please migrate away from it as soon as possible.

## Example Usage

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

let value: TransferState = {};
```

## Fields

| Field                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    | Type                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                     | Required                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                 | Description                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              | Example                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  |
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| `actor`                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  | *string*                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                 | :heavy_minus_sign:                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       | The user or service that triggered the state update.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                     | Apex Transfers                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                           |
| `message`                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                | *string*                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                 | :heavy_minus_sign:                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       | Additional description of the transfer state.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            | The transfer is being validated                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          |
| `metadata`                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                               | Record<string, *any*>                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    | :heavy_minus_sign:                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       | Additional metadata relating to the transfer state. Included data depends on the state, e.g.:<br/> - Rejection reasons are included when the `state` is `REJECTED`<br/> - Reason and comment are included when `state` is `CANCELED`                                                                                                                                                                                                                                                                                                                                                                                                                                     | <nil>                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    |
| `state`                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  | [components.IctDepositTransferStateState](../../models/components/ictdeposittransferstatestate.md)                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       | :heavy_minus_sign:                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       | The high level state of a transfer, one of:<br/>- `PROCESSING` - The transfer is being processed and will be posted if successful.<br/>- `PENDING_REVIEW` - The transfer is pending review and will continue processing if approved.<br/>- `POSTED` - The transfer has been posted to the ledger and will be completed at the end of the processing window if not canceled first.<br/>- `COMPLETED` - The transfer has been batched and completed.<br/>- `REJECTED` - The transfer was rejected.<br/>- `CANCELED` - The transfer was canceled.<br/>- `RETURNED` - The transfer was returned.<br/>- `POSTPONED` - The transfer is postponed and will resume processing during the next processing window. | PROCESSING                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                               |
| `updateTime`                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                             | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date)                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            | :heavy_minus_sign:                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       | The time of the state update.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            | 2023-05-17T18:29:37.116Z                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                 |