Skip to content
straddle API Docs
Get started
API Reference
Paykeys

Unmask a paykey

PaykeyUnmaskedV1 Paykeys.Unmasked(PaykeyUnmaskedParamsparameters, CancellationTokencancellationToken = default)
GET/v1/paykeys/{id}/unmasked

Retrieves the unmasked details of an existing paykey. Supply the unique paykey id and Straddle will return the corresponding paykey record, including the unmasked bank account details. This endpoint needs to be enabled by Straddle for your account and should only be used when absolutely necessary.

ParametersExpand Collapse
PaykeyUnmaskedParams 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.

formatuuid
ReturnsExpand Collapse
class PaykeyUnmaskedV1:
required Data Data
required string ID

Unique identifier for the paykey.

formatuuid
required Config Config
ProcessingMethod ProcessingMethod
One of the following:
"inline"Inline
"background"Background
"skip"Skip
SandboxOutcome SandboxOutcome
One of the following:
"standard"Standard
"active"Active
"rejected"Rejected
"review"Review
required DateTimeOffset CreatedAt

Timestamp of when the paykey was created.

formatdate-time
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
One of the following:
"bank_account"BankAccount
"straddle"Straddle
"mx"Mx
"plaid"Plaid
"tan"Tan
"quiltt"Quiltt
required Status Status
One of the following:
"pending"Pending
"active"Active
"inactive"Inactive
"rejected"Rejected
"review"Review
"blocked"Blocked
required DateTimeOffset UpdatedAt

Timestamp of the most recent update to the paykey.

formatdate-time
Balance Balance
required Status Status
One of the following:
"pending"Pending
"completed"Completed
"failed"Failed
Int? AccountBalance

Account Balance when last retrieved

formatint32
DateTimeOffset? UpdatedAt

Last time account balance was updated.

formatdate-time
BankData BankData
required string AccountNumber

The bank account number

required AccountType AccountType
One of the following:
"checking"Checking
"savings"Savings
required string RoutingNumber

The routing number of the bank account.

minLength9
maxLength9
string? CustomerID

Unique identifier of the related customer object.

formatuuid
DateTimeOffset? ExpiresAt

Expiration date and time of the paykey, if applicable.

formatdate-time
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.

formatdate-time
required string Message

A human-readable description of the current status.

required Reason Reason
One of the following:
"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
One of the following:
"watchtower"Watchtower
"bank_decline"BankDecline
"customer_dispute"CustomerDispute
"user_action"UserAction
"system"System
string? Code

The status code if applicable.

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.

formatuuid
required DateTimeOffset ApiRequestTimestamp

Timestamp for this API request, useful for troubleshooting.

formatdate-time
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.
One of the following:
"object"Object
"array"Array
"error"Error
"none"None

Unmask a paykey

PaykeyUnmaskedParams parameters = new()
{
    ID = "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e"
};

var paykeyUnmaskedV1 = await client.Paykeys.Unmasked(parameters);

Console.WriteLine(paykeyUnmaskedV1);
{
  "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": "123456789",
      "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"
}
Returns Examples
{
  "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": "123456789",
      "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"
}