Lookup a paykey

cURL

curl --request GET \
  --header 'Authorization: Bearer YOUR_SECRET_API_KEY' \
  --url https://sandbox.straddle.com/v1/paykeys/<uuid>

{
  "meta": {
    "api_request_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "api_request_timestamp": "2023-11-07T05:31:56Z"
  },
  "response_type": "object",
  "data": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "label": "<string>",
    "source": "bank_account",
    "status": "active",
    "created_at": "2023-11-07T05:31:56Z",
    "updated_at": "2023-11-07T05:31:56Z",
    "paykey": "<string>",
    "config": {
      "sandbox_outcome": "standard",
      "processing_method": "inline"
    },
    "customer_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "institution_name": "Bank of America",
    "status_details": {
      "message": "Bank account sucesfully validated",
      "reason": "insufficient_funds",
      "source": "watchtower",
      "changed_at": "2023-11-07T05:31:56Z",
      "code": "<string>"
    },
    "expires_at": "2023-11-07T05:31:56Z",
    "bank_data": {
      "routing_number": "021000021",
      "account_number": "****1234",
      "account_type": "checking"
    },
    "metadata": {},
    "balance": {
      "status": "pending",
      "account_balance": 123,
      "updated_at": "2023-11-07T05:31:56Z"
    },
    "external_id": "<string>"
  }
}

GET

paykeys

{id}

cURL

curl --request GET \
  --header 'Authorization: Bearer YOUR_SECRET_API_KEY' \
  --url https://sandbox.straddle.com/v1/paykeys/<uuid>

{
  "meta": {
    "api_request_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "api_request_timestamp": "2023-11-07T05:31:56Z"
  },
  "response_type": "object",
  "data": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "label": "<string>",
    "source": "bank_account",
    "status": "active",
    "created_at": "2023-11-07T05:31:56Z",
    "updated_at": "2023-11-07T05:31:56Z",
    "paykey": "<string>",
    "config": {
      "sandbox_outcome": "standard",
      "processing_method": "inline"
    },
    "customer_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "institution_name": "Bank of America",
    "status_details": {
      "message": "Bank account sucesfully validated",
      "reason": "insufficient_funds",
      "source": "watchtower",
      "changed_at": "2023-11-07T05:31:56Z",
      "code": "<string>"
    },
    "expires_at": "2023-11-07T05:31:56Z",
    "bank_data": {
      "routing_number": "021000021",
      "account_number": "****1234",
      "account_type": "checking"
    },
    "metadata": {},
    "balance": {
      "status": "pending",
      "account_balance": 123,
      "updated_at": "2023-11-07T05:31:56Z"
    },
    "external_id": "<string>"
  }
}

Authorizations

Authorization

string

header

required

Use your Straddle API Key in the Authorization header as Bearer to authorize API requests.

Headers

Straddle-Account-Id

string<uuid>

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

Request-Id

string

Optional client generated identifier to trace and debug a request.

Correlation-Id

string

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

Path Parameters

string<uuid>

required

Response

meta

object

required

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

Show child attributes

meta.api_request_id

string<uuid>

required

Unique identifier for this API request, useful for troubleshooting.

meta.api_request_timestamp

string<date-time>

required

Timestamp for this API request, useful for troubleshooting.

response_type

enum<string>

required

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.

Available options:

object,

array,

error,

none

data

object

required

Show child attributes

data.id

string<uuid>

required

Unique identifier for the paykey.

data.label

string

required

Human-readable label used to represent this paykey in a UI.

data.source

enum<string>

required

Available options:

bank_account,

straddle,

mx,

plaid,

tan,

quiltt

data.status

enum<string>

default:active

required

Available options:

pending,

active,

inactive,

rejected,

review

data.created_at

string<date-time>

required

Timestamp of when the paykey was created.

data.updated_at

string<date-time>

required

Timestamp of the most recent update to the paykey.

data.paykey

string

required

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

data.config

object

required

Show child attributes

data.config.sandbox_outcome

enum<string>

Available options:

standard,

active,

rejected,

review

data.config.processing_method

enum<string>

Available options:

inline,

background,

skip

data.customer_id

string<uuid> | null

Unique identifier of the related customer object.

data.institution_name

string | null

Name of the financial institution.

Example:

"Bank of America"

data.status_details

object

Show child attributes

data.status_details.message

string

required

A human-readable description of the current status.

Example:

"Bank account sucesfully validated"

data.status_details.reason

enum<string>

required

Available options:

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

data.status_details.source

enum<string>

required

Available options:

watchtower,

bank_decline,

customer_dispute,

user_action,

system

data.status_details.changed_at

string<date-time>

required

The time the status change occurred.

data.status_details.code

string | null

The status code if applicable.

data.expires_at

string<date-time> | null

Expiration date and time of the paykey, if applicable.

data.bank_data

object

Show child attributes

data.bank_data.routing_number

string

required

The routing number of the bank account.

Required string length: 9

Example:

"021000021"

data.bank_data.account_number

string

required

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

Example:

"****1234"

data.bank_data.account_type

enum<string>

required

Available options:

checking,

savings

data.metadata

object

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

Show child attributes

data.metadata.{key}

string

data.balance

object

Show child attributes

data.balance.status

enum<string>

required

Available options:

pending,

completed,

failed

data.balance.account_balance

integer<int32> | null

Account Balance when last retrieved

data.balance.updated_at

string<date-time> | null

Last time account balance was updated.

data.external_id

string | null

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

Bridge a bank account

Unmask paykey data

⌘I

Fundamentals

SDKs

Customers

Bridge

Paykeys

Charges

Payouts

Funding

Payments

Embed

Authorizations

Headers

Path Parameters

Response