## List paykeys

`$ straddle paykeys list`

**get** `/v1/paykeys`

Returns a list of paykeys associated with a Straddle account. This endpoint supports advanced sorting and filtering options.

### Parameters

- `--created-from: optional string`

  Query param: Start date for filtering by creation date.

- `--created-to: optional string`

  Query param: End date for filtering by creation date.

- `--customer-id: optional string`

  Query param: Filter paykeys by related customer ID.

- `--page-number: optional number`

  Query param: Page number for paginated results. Starts at 1.

- `--page-size: optional number`

  Query param: Number of results per page. Maximum: 1000.

- `--search-text: optional string`

  Query param: General search term to filter paykeys.

- `--sort-by: optional "institution_name" or "expires_at" or "created_at"`

  Query param

- `--sort-order: optional "asc" or "desc"`

  Query param

- `--source: optional array of "bank_account" or "straddle" or "mx" or 3 more`

  Query param: Filter paykeys by their source.

- `--status: optional array of "pending" or "active" or "inactive" or 3 more`

  Query param: Filter paykeys by their current status.

- `--unblock-eligible: optional boolean`

  Query param: Filter paykeys by unblock eligibility. When true, returns only blocked paykeys eligible for client-initiated unblocking (blocked due to R29 returns and not previously unblocked). When false, returns only blocked paykeys that are not eligible for unblocking.

- `--correlation-id: optional string`

  Header param: Optional client generated identifier to trace and debug a series of requests.

- `--request-id: optional string`

  Header param: Optional client generated identifier to trace and debug a request.

- `--straddle-account-id: optional string`

  Header param: For use by platforms to specify an account id and set scope of a request.

### Returns

- `paykeySummaryPagedV1: object { data, meta, response_type }`

  - `data: array of object { id, config, created_at, 12 more }`

    - `id: string`

      Unique identifier for the paykey.

    - `config: object { processing_method, sandbox_outcome }`

      - `processing_method: optional "inline" or "background" or "skip"`

        - `"inline"`

        - `"background"`

        - `"skip"`

      - `sandbox_outcome: optional "standard" or "active" or "rejected" or "review"`

        - `"standard"`

        - `"active"`

        - `"rejected"`

        - `"review"`

    - `created_at: string`

      Timestamp of when the paykey was created.

    - `label: string`

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

    - `paykey: string`

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

    - `source: "bank_account" or "straddle" or "mx" or 3 more`

      - `"bank_account"`

      - `"straddle"`

      - `"mx"`

      - `"plaid"`

      - `"tan"`

      - `"quiltt"`

    - `status: "pending" or "active" or "inactive" or 3 more`

      - `"pending"`

      - `"active"`

      - `"inactive"`

      - `"rejected"`

      - `"review"`

      - `"blocked"`

    - `updated_at: string`

      Timestamp of the most recent update to the paykey.

    - `bank_data: optional object { account_number, account_type, routing_number }`

      - `account_number: string`

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

      - `account_type: "checking" or "savings"`

        - `"checking"`

        - `"savings"`

      - `routing_number: string`

        The routing number of the bank account.

    - `customer_id: optional string`

      Unique identifier of the related customer object.

    - `expires_at: optional string`

      Expiration date and time of the paykey, if applicable.

    - `external_id: optional string`

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

    - `institution_name: optional string`

      Name of the financial institution.

    - `status_details: optional object { changed_at, message, reason, 2 more }`

      - `changed_at: string`

        The time the status change occurred.

      - `message: string`

        A human-readable description of the current status.

      - `reason: "insufficient_funds" or "closed_bank_account" or "invalid_bank_account" or 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: "watchtower" or "bank_decline" or "customer_dispute" or 2 more`

        - `"watchtower"`

        - `"bank_decline"`

        - `"customer_dispute"`

        - `"user_action"`

        - `"system"`

      - `code: optional string`

        The status code if applicable.

    - `unblock_eligible: optional boolean`

      Indicates whether this paykey is eligible for client-initiated unblocking. Only present for blocked paykeys. True when blocked due to R29 returns and not previously unblocked, false otherwise. Null when paykey is not blocked.

  - `meta: object { api_request_id, api_request_timestamp, max_page_size, 6 more }`

    - `api_request_id: string`

      Unique identifier for this API request, useful for troubleshooting.

    - `api_request_timestamp: string`

      Timestamp for this API request, useful for troubleshooting.

    - `max_page_size: number`

      Maximum allowed page size for this endpoint.

    - `page_number: number`

      Page number for paginated results.

    - `page_size: number`

      Number of items per page in this response.

    - `sort_by: string`

      The field that the results were sorted by.

    - `sort_order: "asc" or "desc"`

      - `"asc"`

      - `"desc"`

    - `total_items: number`

    - `total_pages: number`

      The number of pages available.

  - `response_type: "object" or "array" or "error" or "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

```cli
straddle paykeys list \
  --api-key 'My API Key'
```

#### 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": "bank_account",
      "status": "pending",
      "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",
      "status_details": {
        "changed_at": "2019-12-27T18:11:19.117Z",
        "message": "Bank account sucesfully validated",
        "reason": "insufficient_funds",
        "source": "watchtower",
        "code": "code"
      },
      "unblock_eligible": true
    }
  ],
  "meta": {
    "api_request_id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
    "api_request_timestamp": "2019-12-27T18:11:19.117Z",
    "max_page_size": 0,
    "page_number": 0,
    "page_size": 0,
    "sort_by": "sort_by",
    "sort_order": "asc",
    "total_items": 0,
    "total_pages": 0
  },
  "response_type": "object"
}
```