# BankRelationship

A relationship between a bank account and an Apex account.

## Example Usage

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

let value: BankRelationship = {};
```

## Fields

| Field                                                                                                                                                                                                                                                | Type                                                                                                                                                                                                                                                 | Required                                                                                                                                                                                                                                             | Description                                                                                                                                                                                                                                          | Example                                                                                                                                                                                                                                              |
| ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `bankAccount`                                                                                                                                                                                                                                        | [components.BankAccount](../../models/components/bankaccount.md)                                                                                                                                                                                     | :heavy_minus_sign:                                                                                                                                                                                                                                   | The bank account for the relationship. This field must be set on create requests **except** when using the `PLAID_TOKEN` verification method. In which case, the bank account will be retrieved by the service based on the `plaid_processor_token`. | <nil>                                                                                                                                                                                                                                                |
| `createTime`                                                                                                                                                                                                                                         | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date)                                                                                                                                                        | :heavy_minus_sign:                                                                                                                                                                                                                                   | Creation time of the bank relationship.                                                                                                                                                                                                              | 2023-05-17T18:29:37.116Z                                                                                                                                                                                                                             |
| `name`                                                                                                                                                                                                                                               | *string*                                                                                                                                                                                                                                             | :heavy_minus_sign:                                                                                                                                                                                                                                   | The resource name of the bank relationship.                                                                                                                                                                                                          | accounts/01H8FB90ZRRFWXB4XC2JPJ1D4Y/bankRelationships/651ef9de0dee00240813e60e                                                                                                                                                                       |
| `nickname`                                                                                                                                                                                                                                           | *string*                                                                                                                                                                                                                                             | :heavy_minus_sign:                                                                                                                                                                                                                                   | The nickname of the bank relationship.                                                                                                                                                                                                               | My Primary Bank                                                                                                                                                                                                                                      |
| `plaidProcessorToken`                                                                                                                                                                                                                                | *string*                                                                                                                                                                                                                                             | :heavy_minus_sign:                                                                                                                                                                                                                                   | A processor token from Plaid (vendor). Required if using `PLAID_TOKEN` verification method.                                                                                                                                                          | processor-sandbox-b03434a75-801-4000-990c-eb404cc                                                                                                                                                                                                    |
| `state`                                                                                                                                                                                                                                              | [components.BankRelationshipState](../../models/components/bankrelationshipstate.md)                                                                                                                                                                 | :heavy_minus_sign:                                                                                                                                                                                                                                   | The state of the bank relationship.                                                                                                                                                                                                                  |                                                                                                                                                                                                                                                      |
| `verificationMethod`                                                                                                                                                                                                                                 | [components.BankRelationshipVerificationMethod](../../models/components/bankrelationshipverificationmethod.md)                                                                                                                                       | :heavy_minus_sign:                                                                                                                                                                                                                                   | The verification method of the bank relationship.                                                                                                                                                                                                    | MICRO_DEPOSIT                                                                                                                                                                                                                                        |