Skip to content
straddle API Docs
  • Auto
  • Light
  • Dark
Get started
API Reference
Overview

API Reference

Libraries

TypeScript
0.3.0
npm install @straddlecom/straddle
Read Docs
Python
0.3.0
pip install straddle
Read Docs
Ruby
0.3.0
gem "straddle"
Read Docs

API Overview

Embed

EmbedAccounts

Lookup an account
get/v1/accounts/{account_id}
Update an account
put/v1/accounts/{account_id}
Create an account
post/v1/accounts
List accounts
get/v1/accounts
Onboard an account
post/v1/accounts/{account_id}/onboard
Simulate status transitions for a sandbox account
post/v1/accounts/{account_id}/simulate

EmbedAccountsCapability Requests

Request a capability
post/v1/accounts/{account_id}/capability_requests
List capability requests
get/v1/accounts/{account_id}/capability_requests

EmbedLinked Bank Accounts

Create a linked bank account
post/v1/linked_bank_accounts
List linked bank accounts
get/v1/linked_bank_accounts
Update a linked bank account
put/v1/linked_bank_accounts/{linked_bank_account_id}
Lookup a linked bank account
get/v1/linked_bank_accounts/{linked_bank_account_id}
Unmask a linked bank account
get/v1/linked_bank_accounts/{linked_bank_account_id}/unmask
Cancel a linked bank account
patch/v1/linked_bank_accounts/{linked_bank_account_id}/cancel

EmbedOrganizations

Create an organization
post/v1/organizations
List organizations
get/v1/organizations
Retrieve organization details
get/v1/organizations/{organization_id}

EmbedRepresentatives

Create a representative
post/v1/representatives
List representatives
get/v1/representatives
Update a representative
put/v1/representatives/{representative_id}
Lookup a representative
get/v1/representatives/{representative_id}
Retrieve unmasked representative details
get/v1/representatives/{representative_id}/unmask

Bridge

Create a Widget session token
post/v1/bridge/initialize
Bridge a bank account
post/v1/bridge/bank_account
Bridge a Plaid token
post/v1/bridge/plaid
Create Tan
post/v1/bridge/tan
Create a paykey from a Quiltt token
post/v1/bridge/quiltt

Customers

Lookup a customer
get/v1/customers/{id}
Update a customer
put/v1/customers/{id}
Delete a customer
delete/v1/customers/{id}
List customers
get/v1/customers
Create a customer
post/v1/customers
Unmask customer data
get/v1/customers/{id}/unmasked

CustomersReview

Review a customer's identity results
get/v1/customers/{id}/review
Update a customer's verification status
patch/v1/customers/{id}/review
Update a customer's identity decision
put/v1/customers/{id}/refresh_review

Paykeys

Lookup a paykey
get/v1/paykeys/{id}
Unmask a paykey
get/v1/paykeys/{id}/unmasked
List paykeys
get/v1/paykeys
Retrieve an unmasked paykey
get/v1/paykeys/{id}/reveal
Cancel
put/v1/paykeys/{id}/cancel
Update a paykey's balance
put/v1/paykeys/{id}/refresh_balance

PaykeysReview

Update a paykey's status
patch/v1/paykeys/{id}/review
Get paykey review details
get/v1/paykeys/{id}/review
Update a paykey's identity review decision
put/v1/paykeys/{id}/refresh_review

Charges

Lookup a charge
get/v1/charges/{id}
Update a charge
put/v1/charges/{id}
Create a charge
post/v1/charges
Hold a charge
put/v1/charges/{id}/hold
Release a charge
put/v1/charges/{id}/release
Cancel a charge
put/v1/charges/{id}/cancel
Get a charge by id.
get/v1/charges/{id}/unmask

Funding Events

List funding events
get/v1/funding_events
Lookup a funding event
get/v1/funding_events/{id}

Payments

Search payments
get/v1/payments

Payouts

Lookup a payout
get/v1/payouts/{id}
Update a payout
put/v1/payouts/{id}
Create a payout
post/v1/payouts
Hold a payout
put/v1/payouts/{id}/hold
Release a payout
put/v1/payouts/{id}/release
Cancel a payout
put/v1/payouts/{id}/cancel
Get a payout by id.
get/v1/payouts/{id}/unmask

Reports

post/v1/reports/total_customers_by_status