## Lookup a paykey

`PaykeyV1 Paykeys.Get(PaykeyGetParamsparameters, CancellationTokencancellationToken = default)`

**get** `/v1/paykeys/{id}`

Retrieves the details of an existing paykey. Supply the unique paykey `id` and Straddle will return the corresponding paykey record , including the `paykey` token value and masked bank account details.

### Parameters

- `PaykeyGetParams parameters`

  - `required string id`

  - `string correlationID`

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

  - `string requestID`

    Optional client generated identifier to trace and debug a request.

  - `string straddleAccountID`

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

### Returns

- `class PaykeyV1:`

  - `required 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 used to 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.

    - `Balance Balance`

      - `required Status Status`

        - `"pending"Pending`

        - `"completed"Completed`

        - `"failed"Failed`

      - `Int? AccountBalance`

        Account Balance when last retrieved

      - `DateTimeOffset? UpdatedAt`

        Last time account balance was updated.

    - `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.

    - `IReadOnlyDictionary<string, string>? Metadata`

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

    - `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 ResponseMetadata Meta`

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

    - `required string ApiRequestID`

      Unique identifier for this API request, useful for troubleshooting.

    - `required DateTimeOffset ApiRequestTimestamp`

      Timestamp for this API request, useful for troubleshooting.

  - `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
PaykeyGetParams parameters = new()
{
    ID = "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e"
};

var paykeyV1 = await client.Paykeys.Get(parameters);

Console.WriteLine(paykeyV1);
```

#### 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": "label",
    "paykey": "paykey",
    "source": "bank_account",
    "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"
    },
    "unblock_eligible": true
  },
  "meta": {
    "api_request_id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
    "api_request_timestamp": "2019-12-27T18:11:19.117Z"
  },
  "response_type": "object"
}
```