## List paykeys

`PaykeySummaryPagedV1 Paykeys.List(PaykeyListParams?parameters, CancellationTokencancellationToken = default)`

**get** `/v1/paykeys`

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

### Parameters

- `PaykeyListParams parameters`

  - `string customerID`

    Query param: Filter paykeys by related customer ID.

  - `Int pageNumber`

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

  - `Int pageSize`

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

  - `string searchText`

    Query param: General search term to filter paykeys.

  - `SortBy sortBy`

    Query param

    - `"institution_name"InstitutionName`

    - `"expires_at"ExpiresAt`

    - `"created_at"CreatedAt`

  - `SortOrder sortOrder`

    Query param

    - `"asc"Asc`

    - `"desc"Desc`

  - `IReadOnlyList<Source> source`

    Query param: Filter paykeys by their source.

    - `"bank_account"BankAccount`

    - `"straddle"Straddle`

    - `"mx"Mx`

    - `"plaid"Plaid`

    - `"tan"Tan`

    - `"quiltt"Quiltt`

  - `IReadOnlyList<Status> status`

    Query param: Filter paykeys by their current status.

    - `"pending"Pending`

    - `"active"Active`

    - `"inactive"Inactive`

    - `"rejected"Rejected`

    - `"review"Review`

    - `"blocked"Blocked`

  - `Boolean unblockEligible`

    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.

  - `string correlationID`

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

  - `string requestID`

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

  - `string straddleAccountID`

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

### Returns

- `class PaykeySummaryPagedV1:`

  - `required IReadOnlyList<Data> Data`

    - `required string ID`

      Unique identifier for the paykey.

    - `required Config Config`

      - `ProcessingMethod ProcessingMethod`

        - `"inline"Inline`

        - `"background"Background`

        - `"skip"Skip`

      - `SandboxOutcome SandboxOutcome`

        - `"standard"Standard`

        - `"active"Active`

        - `"rejected"Rejected`

        - `"review"Review`

    - `required DateTimeOffset CreatedAt`

      Timestamp of when the paykey was created.

    - `required string Label`

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

    - `required string Paykey`

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

    - `required Source Source`

      - `"bank_account"BankAccount`

      - `"straddle"Straddle`

      - `"mx"Mx`

      - `"plaid"Plaid`

      - `"tan"Tan`

      - `"quiltt"Quiltt`

    - `required Status Status`

      - `"pending"Pending`

      - `"active"Active`

      - `"inactive"Inactive`

      - `"rejected"Rejected`

      - `"review"Review`

      - `"blocked"Blocked`

    - `required DateTimeOffset UpdatedAt`

      Timestamp of the most recent update to the paykey.

    - `BankData BankData`

      - `required string AccountNumber`

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

      - `required AccountType AccountType`

        - `"checking"Checking`

        - `"savings"Savings`

      - `required string RoutingNumber`

        The routing number of the bank account.

    - `string? CustomerID`

      Unique identifier of the related customer object.

    - `DateTimeOffset? ExpiresAt`

      Expiration date and time of the paykey, if applicable.

    - `string? ExternalID`

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

    - `string? InstitutionName`

      Name of the financial institution.

    - `StatusDetails StatusDetails`

      - `required DateTimeOffset ChangedAt`

        The time the status change occurred.

      - `required string Message`

        A human-readable description of the current status.

      - `required Reason Reason`

        - `"insufficient_funds"InsufficientFunds`

        - `"closed_bank_account"ClosedBankAccount`

        - `"invalid_bank_account"InvalidBankAccount`

        - `"invalid_routing"InvalidRouting`

        - `"disputed"Disputed`

        - `"payment_stopped"PaymentStopped`

        - `"owner_deceased"OwnerDeceased`

        - `"frozen_bank_account"FrozenBankAccount`

        - `"risk_review"RiskReview`

        - `"fraudulent"Fraudulent`

        - `"duplicate_entry"DuplicateEntry`

        - `"invalid_paykey"InvalidPaykey`

        - `"payment_blocked"PaymentBlocked`

        - `"amount_too_large"AmountTooLarge`

        - `"too_many_attempts"TooManyAttempts`

        - `"internal_system_error"InternalSystemError`

        - `"user_request"UserRequest`

        - `"ok"Ok`

        - `"other_network_return"OtherNetworkReturn`

        - `"payout_refused"PayoutRefused`

        - `"cancel_request"CancelRequest`

        - `"failed_verification"FailedVerification`

        - `"require_review"RequireReview`

        - `"blocked_by_system"BlockedBySystem`

        - `"watchtower_review"WatchtowerReview`

        - `"validating"Validating`

        - `"auto_hold"AutoHold`

      - `required Source Source`

        - `"watchtower"Watchtower`

        - `"bank_decline"BankDecline`

        - `"customer_dispute"CustomerDispute`

        - `"user_action"UserAction`

        - `"system"System`

      - `string? Code`

        The status code if applicable.

    - `Boolean? UnblockEligible`

      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.

  - `required Meta Meta`

    - `required string ApiRequestID`

      Unique identifier for this API request, useful for troubleshooting.

    - `required DateTimeOffset ApiRequestTimestamp`

      Timestamp for this API request, useful for troubleshooting.

    - `required Int MaxPageSize`

      Maximum allowed page size for this endpoint.

    - `required Int PageNumber`

      Page number for paginated results.

    - `required Int PageSize`

      Number of items per page in this response.

    - `required string SortBy`

      The field that the results were sorted by.

    - `required SortOrder SortOrder`

      - `"asc"Asc`

      - `"desc"Desc`

    - `required Int TotalItems`

    - `required Int TotalPages`

      The number of pages available.

  - `required ResponseType ResponseType`

    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"Object`

    - `"array"Array`

    - `"error"Error`

    - `"none"None`

### Example

```csharp
PaykeyListParams parameters = new();

var page = await client.Paykeys.List(parameters);
await foreach (var item in page.Paginate())
{
    Console.WriteLine(item);
}
```

#### 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"
}
```