## Create Tan

`bridge.link.create_tan(LinkCreateTanParams**kwargs)  -> LinkCreateTanResponse`

**post** `/v1/bridge/tan`

### Parameters

- `account_type: Literal["checking", "savings"]`

  - `"checking"`

  - `"savings"`

- `customer_id: str`

  Unique identifier of the related customer object.

- `routing_number: str`

  Bank routing number.

- `tan: str`

  Tokenized account number.

- `config: Optional[Config]`

  - `processing_method: Optional[Literal["inline", "background", "skip"]]`

    - `"inline"`

    - `"background"`

    - `"skip"`

  - `sandbox_outcome: Optional[Literal["standard", "active", "rejected", "review"]]`

    - `"standard"`

    - `"active"`

    - `"rejected"`

    - `"review"`

- `external_id: Optional[str]`

  Unique identifier for the paykey in your database, used for cross-referencing between Straddle and your systems.

- `metadata: Optional[Dict[str, str]]`

  Up to 20 additional user-defined key-value pairs. Useful for storing additional information about the paykey in a structured format.

- `correlation_id: Optional[str]`

- `idempotency_key: Optional[str]`

- `request_id: Optional[str]`

- `straddle_account_id: Optional[str]`

### Returns

- `class LinkCreateTanResponse: …`

  - `data: Data`

    - `id: str`

      Unique identifier for the paykey.

    - `config: DataConfig`

      - `processing_method: Optional[Literal["inline", "background", "skip"]]`

        - `"inline"`

        - `"background"`

        - `"skip"`

      - `sandbox_outcome: Optional[Literal["standard", "active", "rejected", "review"]]`

        - `"standard"`

        - `"active"`

        - `"rejected"`

        - `"review"`

    - `created_at: datetime`

      Timestamp of when the paykey was created.

    - `label: str`

      Human-readable label that combines the bank name and masked account number to help easility represent this paykey in a UI

    - `paykey: str`

      The tokenized paykey value. This token is used to create payments and should be stored securely.

    - `source: Literal["bank_account", "straddle", "mx", 3 more]`

      - `"bank_account"`

      - `"straddle"`

      - `"mx"`

      - `"plaid"`

      - `"tan"`

      - `"quiltt"`

    - `status: Literal["pending", "active", "inactive", 3 more]`

      - `"pending"`

      - `"active"`

      - `"inactive"`

      - `"rejected"`

      - `"review"`

      - `"blocked"`

    - `updated_at: datetime`

      Timestamp of the most recent update to the paykey.

    - `balance: Optional[DataBalance]`

      - `status: Literal["pending", "completed", "failed"]`

        - `"pending"`

        - `"completed"`

        - `"failed"`

      - `account_balance: Optional[int]`

        Account Balance when last retrieved

      - `updated_at: Optional[datetime]`

        Last time account balance was updated.

    - `bank_data: Optional[DataBankData]`

      - `account_number: str`

        Bank account number. This value is masked by default for security reasons. Use the /unmask endpoint to access the unmasked value.

      - `account_type: Literal["checking", "savings"]`

        - `"checking"`

        - `"savings"`

      - `routing_number: str`

        The routing number of the bank account.

    - `customer_id: Optional[str]`

      Unique identifier of the related customer object.

    - `expires_at: Optional[datetime]`

      Expiration date and time of the paykey, if applicable.

    - `external_id: Optional[str]`

      Unique identifier for the paykey in your database, used for cross-referencing between Straddle and your systems.

    - `institution_name: Optional[str]`

      Name of the financial institution.

    - `metadata: Optional[Dict[str, str]]`

      Up to 20 additional user-defined key-value pairs. Useful for storing additional information about the paykey in a structured format.

    - `status_details: Optional[DataStatusDetails]`

      - `changed_at: datetime`

        The time the status change occurred.

      - `message: str`

        A human-readable description of the current status.

      - `reason: Literal["insufficient_funds", "closed_bank_account", "invalid_bank_account", 24 more]`

        - `"insufficient_funds"`

        - `"closed_bank_account"`

        - `"invalid_bank_account"`

        - `"invalid_routing"`

        - `"disputed"`

        - `"payment_stopped"`

        - `"owner_deceased"`

        - `"frozen_bank_account"`

        - `"risk_review"`

        - `"fraudulent"`

        - `"duplicate_entry"`

        - `"invalid_paykey"`

        - `"payment_blocked"`

        - `"amount_too_large"`

        - `"too_many_attempts"`

        - `"internal_system_error"`

        - `"user_request"`

        - `"ok"`

        - `"other_network_return"`

        - `"payout_refused"`

        - `"cancel_request"`

        - `"failed_verification"`

        - `"require_review"`

        - `"blocked_by_system"`

        - `"watchtower_review"`

        - `"validating"`

        - `"auto_hold"`

      - `source: Literal["watchtower", "bank_decline", "customer_dispute", 2 more]`

        - `"watchtower"`

        - `"bank_decline"`

        - `"customer_dispute"`

        - `"user_action"`

        - `"system"`

      - `code: Optional[str]`

        The status code if applicable.

  - `meta: ResponseMetadata`

    Metadata about the API request, including an identifier and timestamp.

    - `api_request_id: str`

      Unique identifier for this API request, useful for troubleshooting.

    - `api_request_timestamp: datetime`

      Timestamp for this API request, useful for troubleshooting.

  - `response_type: Literal["object", "array", "error", "none"]`

    Indicates the structure of the returned content.

    - "object" means the `data` field contains a single JSON object.
    - "array" means the `data` field contains an array of objects.
    - "error" means the `data` field contains an error object with details of the issue.
    - "none" means no data is returned.

    - `"object"`

    - `"array"`

    - `"error"`

    - `"none"`

### Example

```python
import os
from straddle import Straddle

client = Straddle(
    api_key=os.environ.get("STRADDLE_API_KEY"),  # This is the default and can be omitted
)
response = client.bridge.link.create_tan(
    account_type="checking",
    customer_id="182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
    routing_number="routing_number",
    tan="tan",
)
print(response.data)
```

#### Response

```json
{
  "data": {
    "id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
    "config": {
      "processing_method": "inline",
      "sandbox_outcome": "standard"
    },
    "created_at": "2019-12-27T18:11:19.117Z",
    "label": "Bank of America ****1234",
    "paykey": "paykey",
    "source": "straddle",
    "status": "pending",
    "updated_at": "2019-12-27T18:11:19.117Z",
    "balance": {
      "status": "pending",
      "account_balance": 0,
      "updated_at": "2019-12-27T18:11:19.117Z"
    },
    "bank_data": {
      "account_number": "****1234",
      "account_type": "checking",
      "routing_number": "021000021"
    },
    "customer_id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
    "expires_at": "2019-12-27T18:11:19.117Z",
    "external_id": "external_id",
    "institution_name": "Bank of America",
    "metadata": {
      "foo": "string"
    },
    "status_details": {
      "changed_at": "2019-12-27T18:11:19.117Z",
      "message": "Bank account sucesfully validated",
      "reason": "insufficient_funds",
      "source": "watchtower",
      "code": "code"
    }
  },
  "meta": {
    "api_request_id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
    "api_request_timestamp": "2019-12-27T18:11:19.117Z"
  },
  "response_type": "object"
}
```