API Reference

View as Markdown

View as Markdown

Copy Markdown

---

Open in Claude

Open in ChatGPT

Paykeys

Lookup a paykey

client.paykeys.get(stringid, PaykeyGetParams { correlationID, requestID, straddleAccountID } params?, RequestOptionsoptions?): PaykeyV1 { data, meta, response_type }

get/v1/paykeys/{id}

Unmask a paykey

client.paykeys.unmasked(stringid, PaykeyUnmaskedParams { correlationID, requestID, straddleAccountID } params?, RequestOptionsoptions?): PaykeyUnmaskedV1 { data, meta, response_type }

get/v1/paykeys/{id}/unmasked

List paykeys

client.paykeys.list(PaykeyListParams { customer_id, page_number, page_size, 7 more } params?, RequestOptionsoptions?): PageNumberSchema<Data { id, config, created_at, 11 more } >

get/v1/paykeys

Retrieve an unmasked paykey

client.paykeys.reveal(stringid, PaykeyRevealParams { correlationID, requestID, straddleAccountID } params?, RequestOptionsoptions?): PaykeyRevealResponse { data, meta, response_type }

get/v1/paykeys/{id}/reveal

Cancel

client.paykeys.cancel(stringid, PaykeyCancelParams { reason, correlationID, idempotencyKey, 2 more } params?, RequestOptionsoptions?): PaykeyV1 { data, meta, response_type }

put/v1/paykeys/{id}/cancel

Update a paykey's balance

client.paykeys.updateBalance(stringid, PaykeyUpdateBalanceParams { correlationID, idempotencyKey, requestID, straddleAccountID } params?, RequestOptionsoptions?): PaykeyV1 { data, meta, response_type }

put/v1/paykeys/{id}/refresh_balance

ModelsExpand Collapse

PaykeySummaryPagedV1 { data, meta, response_type }

data: Array<Data { id, config, created_at, 11 more } >

id: string

Unique identifier for the paykey.

formatuuid

config: Config { processing_method, sandbox_outcome }

processing_method?: "inline" | "background" | "skip"

Accepts one of the following:

"inline"

"background"

"skip"

sandbox_outcome?: "standard" | "active" | "rejected" | "review"

Accepts one of the following:

"standard"

"active"

"rejected"

"review"

created_at: string

Timestamp of when the paykey was created.

formatdate-time

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" | "straddle" | "mx" | 3 more

Accepts one of the following:

"bank_account"

"straddle"

"mx"

"plaid"

"tan"

"quiltt"

status: "pending" | "active" | "inactive" | 2 more

Accepts one of the following:

"pending"

"active"

"inactive"

"rejected"

"review"

updated_at: string

Timestamp of the most recent update to the paykey.

formatdate-time

bank_data?: BankData { 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" | "savings"

Accepts one of the following:

"checking"

"savings"

routing_number: string

The routing number of the bank account.

minLength9

maxLength9

customer_id?: string | null

Unique identifier of the related customer object.

formatuuid

expires_at?: string | null

Expiration date and time of the paykey, if applicable.

formatdate-time

external_id?: string | null

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

institution_name?: string | null

Name of the financial institution.

status_details?: StatusDetails { changed_at, message, reason, 2 more }

changed_at: string

The time the status change occurred.

formatdate-time

message: string

A human-readable description of the current status.

reason: "insufficient_funds" | "closed_bank_account" | "invalid_bank_account" | 17 more

Accepts one of the following:

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

source: "watchtower" | "bank_decline" | "customer_dispute" | 2 more

Accepts one of the following:

"watchtower"

"bank_decline"

"customer_dispute"

"user_action"

"system"

code?: string | null

The status code if applicable.

meta: Meta { api_request_id, api_request_timestamp, max_page_size, 6 more }

api_request_id: string

Unique identifier for this API request, useful for troubleshooting.

formatuuid

api_request_timestamp: string

Timestamp for this API request, useful for troubleshooting.

formatdate-time

max_page_size: number

Maximum allowed page size for this endpoint.

formatint32

page_number: number

Page number for paginated results.

formatint32

page_size: number

Number of items per page in this response.

formatint32

sort_by: string

The field that the results were sorted by.

sort_order: "asc" | "desc"

Accepts one of the following:

"asc"

"desc"

total_items: number

total_pages: number

The number of pages available.

formatint32

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

Accepts one of the following:

"object"

"array"

"error"

"none"

PaykeyUnmaskedV1 { data, meta, response_type }

data: Data { id, config, created_at, 13 more }

id: string

Unique identifier for the paykey.

formatuuid

config: Config { processing_method, sandbox_outcome }

processing_method?: "inline" | "background" | "skip"

Accepts one of the following:

"inline"

"background"

"skip"

sandbox_outcome?: "standard" | "active" | "rejected" | "review"

Accepts one of the following:

"standard"

"active"

"rejected"

"review"

created_at: string

Timestamp of when the paykey was created.

formatdate-time

label: string

Human-readable label used to 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" | "straddle" | "mx" | 3 more

Accepts one of the following:

"bank_account"

"straddle"

"mx"

"plaid"

"tan"

"quiltt"

status: "pending" | "active" | "inactive" | 2 more

Accepts one of the following:

"pending"

"active"

"inactive"

"rejected"

"review"

updated_at: string

Timestamp of the most recent update to the paykey.

formatdate-time

balance?: Balance { status, account_balance, updated_at }

status: "pending" | "completed" | "failed"

Accepts one of the following:

"pending"

"completed"

"failed"

account_balance?: number | null

Account Balance when last retrieved

formatint32

updated_at?: string | null

Last time account balance was updated.

formatdate-time

bank_data?: BankData { account_number, account_type, routing_number }

account_number: string

The bank account number

account_type: "checking" | "savings"

Accepts one of the following:

"checking"

"savings"

routing_number: string

The routing number of the bank account.

minLength9

maxLength9

customer_id?: string | null

Unique identifier of the related customer object.

formatuuid

expires_at?: string | null

Expiration date and time of the paykey, if applicable.

formatdate-time

external_id?: string | null

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

institution_name?: string | null

Name of the financial institution.

metadata?: Record<string, string> | null

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

status_details?: StatusDetails { changed_at, message, reason, 2 more }

changed_at: string

The time the status change occurred.

formatdate-time

message: string

A human-readable description of the current status.

reason: "insufficient_funds" | "closed_bank_account" | "invalid_bank_account" | 17 more

Accepts one of the following:

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

source: "watchtower" | "bank_decline" | "customer_dispute" | 2 more

Accepts one of the following:

"watchtower"

"bank_decline"

"customer_dispute"

"user_action"

"system"

code?: string | null

The status code if applicable.

meta: ResponseMetadata { api_request_id, api_request_timestamp }

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

api_request_id: string

Unique identifier for this API request, useful for troubleshooting.

formatuuid

api_request_timestamp: string

Timestamp for this API request, useful for troubleshooting.

formatdate-time

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

Accepts one of the following:

"object"

"array"

"error"

"none"

PaykeyV1 { data, meta, response_type }

data: Data { id, config, created_at, 13 more }

id: string

Unique identifier for the paykey.

formatuuid

config: Config { processing_method, sandbox_outcome }

processing_method?: "inline" | "background" | "skip"

Accepts one of the following:

"inline"

"background"

"skip"

sandbox_outcome?: "standard" | "active" | "rejected" | "review"

Accepts one of the following:

"standard"

"active"

"rejected"

"review"

created_at: string

Timestamp of when the paykey was created.

formatdate-time

label: string

Human-readable label used to 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" | "straddle" | "mx" | 3 more

Accepts one of the following:

"bank_account"

"straddle"

"mx"

"plaid"

"tan"

"quiltt"

status: "pending" | "active" | "inactive" | 2 more

Accepts one of the following:

"pending"

"active"

"inactive"

"rejected"

"review"

updated_at: string

Timestamp of the most recent update to the paykey.

formatdate-time

balance?: Balance { status, account_balance, updated_at }

status: "pending" | "completed" | "failed"

Accepts one of the following:

"pending"

"completed"

"failed"

account_balance?: number | null

Account Balance when last retrieved

formatint32

updated_at?: string | null

Last time account balance was updated.

formatdate-time

bank_data?: BankData { 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" | "savings"

Accepts one of the following:

"checking"

"savings"

routing_number: string

The routing number of the bank account.

minLength9

maxLength9

customer_id?: string | null

Unique identifier of the related customer object.

formatuuid

expires_at?: string | null

Expiration date and time of the paykey, if applicable.

formatdate-time

external_id?: string | null

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

institution_name?: string | null

Name of the financial institution.

metadata?: Record<string, string> | null

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

status_details?: StatusDetails { changed_at, message, reason, 2 more }

changed_at: string

The time the status change occurred.

formatdate-time

message: string

A human-readable description of the current status.

reason: "insufficient_funds" | "closed_bank_account" | "invalid_bank_account" | 17 more

Accepts one of the following:

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

source: "watchtower" | "bank_decline" | "customer_dispute" | 2 more

Accepts one of the following:

"watchtower"

"bank_decline"

"customer_dispute"

"user_action"

"system"

code?: string | null

The status code if applicable.

meta: ResponseMetadata { api_request_id, api_request_timestamp }

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

api_request_id: string

Unique identifier for this API request, useful for troubleshooting.

formatuuid

api_request_timestamp: string

Timestamp for this API request, useful for troubleshooting.

formatdate-time

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

Accepts one of the following:

"object"

"array"

"error"

"none"

PaykeysReview

Update a paykey's status

client.paykeys.review.decision(stringid, ReviewDecisionParams { status, correlationID, idempotencyKey, 2 more } params, RequestOptionsoptions?): PaykeyV1 { data, meta, response_type }

patch/v1/paykeys/{id}/review

Get paykey review details

client.paykeys.review.get(stringid, ReviewGetParams { correlationID, requestID, straddleAccountID } params?, RequestOptionsoptions?): ReviewGetResponse { data, meta, response_type }

get/v1/paykeys/{id}/review

Update a paykey's identity review decision

client.paykeys.review.refreshReview(stringid, ReviewRefreshReviewParams { correlationID, idempotencyKey, requestID, straddleAccountID } params?, RequestOptionsoptions?): PaykeyV1 { data, meta, response_type }

put/v1/paykeys/{id}/refresh_review