# BankRelationshipState

The state of the bank relationship.

## Example Usage

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

let value: BankRelationshipState = {};
```

## Fields

| Field                                                                                                                                                                                                                                         | Type                                                                                                                                                                                                                                          | Required                                                                                                                                                                                                                                      | Description                                                                                                                                                                                                                                   | Example                                                                                                                                                                                                                                       |
| --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `actor`                                                                                                                                                                                                                                       | *string*                                                                                                                                                                                                                                      | :heavy_minus_sign:                                                                                                                                                                                                                            | The user or service that triggered the state update.                                                                                                                                                                                          | Apex Transfers                                                                                                                                                                                                                                |
| `metadata`                                                                                                                                                                                                                                    | Record<string, *any*>                                                                                                                                                                                                                         | :heavy_minus_sign:                                                                                                                                                                                                                            | Additional metadata relating to the bank relationship state. Included data will depend on the state. Examples:<br/> - rejection reasons are included when the state is `REJECTED`<br/> - comment and reason are included when the state is `CANCELED` | {<br/>"fields": {<br/>"comment": "Cancel via mobile API",<br/>"reason": {<br/>"string_value": "USER"<br/>}<br/>}<br/>}                                                                                                                        |
| `state`                                                                                                                                                                                                                                       | [components.BankRelationshipStateState](../../models/components/bankrelationshipstatestate.md)                                                                                                                                                | :heavy_minus_sign:                                                                                                                                                                                                                            | The high level state of the bank relationship.                                                                                                                                                                                                | CANCELED                                                                                                                                                                                                                                      |
| `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                                                                                                                                                                                                                      |