Straddle Docs

Documentation

API Reference

Dashboard

Cancel a charge to prevent it from being processed. Only charges in a `created` or `hold` status can be canceled.

Cancel a charge

Specific message regarding this exact request.

Array of error objects with more specific details.

Predefined general type of error (e.g. '/field_validation')

Detailed description of the specific error.

Identifier for the error (e.g., field name, error code).

Unique identifier for this API request, useful for troubleshooting.

Timestamp for this API request, useful for troubleshooting.

A human-readable description of the status.

Cancel a charge to prevent it from being originated for processing. The status of the charge must be `created`, `scheduled`, or `on_hold`.

Bearer

We're here to help you build better bank payments.

Welcome

Welcome to Straddle

A quick overview of how Straddle is structured

Core Concepts

Start building open banking payment experiences in minutes

Quickstart

Introduction to Straddle's unified API for account-to-account payments

Pay by Bank

A (really) big list of key terms and concepts for the Straddle platform

Glossary

If you can solve identity in payments, the rest is just accounting.

Overview

Customers

Understanding Straddle's risk assessment system, including decision logic, risk scores, and correlation scores

Models & Scoring

Understanding the reason codes returned by Straddle's Identity verification process

Reason Codes

Watchlists are used to prevent money-launding and terrorism.

Watchlists

Learn how to use the Bridge open-banking platform to securely connect identities to bank accounts and generate Paykeys for initiating payments

A new kind of token for secure account-to-account payments

Paykeys

Drop-in UI component to securely connect user bank accounts to your application.

Widget

Integrating Plaid with Straddle to create paykeys for account-to-account payments

Plaid Token

Plaid

The Bridge API allows you to create paykeys using raw bank account details.

Bank Account

Bank Accounts

Supercharge platform payments with Straddle Embed

Instantly onboard new merchants with Straddle Embed

Onboarding

Drop-in components for account onboarding

Components

Manage multiple accounts under a single umbrella

Organizations

Accounts

Manage representatives for your Straddle accounts

Representatives

Manage linked bank accounts for your users

Linked Bank Accounts

Capabilities

Learn about synthetic identity fraud, its impact on businesses, and how Straddle can help

Synthetic Identity Fraud

WALDO is Straddle's proprietary identity matching algorithm designed to securely and accurately verify that a customer's identity matches the ownership details of their bank account.

WALDO

WALDO: Identity Matching

An overview of the Straddle API structure and usage

Introduction

Understanding the structure of Straddle API responses

Response Format

Learn how to use Request ID and Correlation ID for debugging and tracing API requests

Request ID

Learn how to use metadata to attach custom information to Straddle objects

Metadata

Learn how to make API calls on behalf of your embedded accounts as a Straddle platform

Embedded Accounts

Use this endpoint to verify and onboard a new customer.

Create a customer

Use this endpoint to update an existing customer.

Update a Customer

Update a customer

Use this endpoint to retrieve a customer record by its unique `id`.

Lookup a customer

Retrieve a customer

Use this endpoint to review the identity and risk scores of an existing customer.

Review a customer

Use this endpoint to update the status of a customer who was flagged for [review](/api/customers/review). You can set the new status to `verified` or `rejected`.

Decision a customer

Use this endpoint to unmask a customer's sensitive PII data.

Unmask customer data

Permanently removes a customer record from the system. This action cannot be undone and should only be used to satisfy regulatory requirements or for privacy compliance.

Delete a customer

Use this endpoint to list or search for customers using filters or query parameters

List customers

Use this endpoint to generate a session token for the Bridge widget.

Initiate a widget session

Use this endpoint to use the Bridge API with a Plaid token.

Bridge a Plaid token

Use this endpoint to use the Bridge API with a 'raw' bank account.

Bridge a bank account

Use this endpoint to retrieve a paykey by its unique `id`.

Lookup a paykey

Use this endpoint to unmask a paykey's sensitive bank account data.

Unmask paykey data

Use this endpoint to search for paykeys using filters or query parameters.

Search paykeys

Create charges to collect payments from your customers for the goods or services you provide.

Create a charge

Update a charge to change the amount, date, or other details.

Update a charge

Use this endpoint to retrieve a charge by its unique `id`.

Lookup a charge

Place a charge on hold to prevent it from being processed. Only charges in `created` status can be placed on hold.

Hold a charge

Release a charge from hold to allow it to be processed. Only charges in `hold` status can be released.

Release a charge

Use payouts to send money to your customers.

Create a payout

Update a payout to change the amount, date, or other details.

Update a payout

Use this endpoint to retrieve a payout by its unique `id`.

Lookup a payout

Place a payout on hold to prevent it from being sent. Only payouts in `created` status can be placed on hold.

Hold a payout

Release a payout from hold to allow it to be processed. Only payouts in `hold` status can be released.

Release a payout

Cancel a payout to prevent it from being sent. Only payouts in `created` or `hold` status can be canceled.

Cancel a payout

Use this endpoint to list or search for funding events using filters or query parameters

List funding events

Use this endpoint to get line item details for every payment in a funding event.

Lookup funding details

Retrieves a list of organizations associated with your Straddle integration. The organizations are returned sorted by creation date, with the most recently created organizations appearing first. This endpoint supports filtering options to help you find specific organizations.

List organizations

Creates a new organization in the Straddle system. Organizations can be used to group related accounts and manage permissions across multiple users.

Create a new organization

Retrieves the details of an account that has previously been created. Supply the unique account ID that was returned from your previous request, and Straddle will return the corresponding account information.

Retrieve account details

Updates an existing account's information. This endpoint allows you to update various account details during onboarding or after the account has been created.

Update an existing account

Returns a list of accounts associated with your Straddle platform integration. The accounts are returned sorted by creation date, with the most recently created accounts appearing first. This endpoint supports pagination and sorting options to help you efficiently manage large numbers of accounts.

List all accounts

Creates a new account associated with your Straddle platform integration. This endpoint allows you to set up an account with specified details, including business information and access levels.

Create a new account

Initiates the onboarding process for a new account. This endpoint can only be used for accounts where at least one representative and one bank account have already been created.

Initiate account onboarding

Returns a list of representatives associated with a specific account or organization. The representatives are returned sorted by creation date, with the most recently created representatives appearing first. This endpoint supports pagination to handle accounts with multiple representatives.

List all representatives

Creates a new representative for an account or organization. Representatives are individuals who have legal authority or significant responsibility within the business.

Create a new representative

Retrieves the details of a representative that has previously been created. Supply the unique representative ID, and Straddle will return the corresponding representative information.

Retrieve representative details

Updates an existing representative's information. This can be used to update personal details, contact information, or the relationship to the account or organization.

Update a representative

Returns a list of bank accounts associated with a specific Straddle account. The linked bank accounts are returned sorted by creation date, with the most recently created appearing first. This endpoint supports pagination to handle accounts with multiple linked bank accounts.

List all linked bank accounts

Creates a new linked bank account for a Straddle account. This endpoint allows you to associate external bank accounts with a Straddle account for various payment operations such as payment deposits, payout withdrawals, and more.

Create a new linked bank account

Retrieves the details of a linked bank account that has previously been created. Supply the unique linked bank account ID, and Straddle will return the corresponding information. The response includes masked account details for security purposes.

Retrieve linked bank account details

Updates an existing linked bank account's information. This can be used to update account details during onboarding or to update metadata associated with the linked account. The linked bank account must be in 'created' or 'onboarding' status.

Update a linked bank account

Retrieves the unmasked details of a linked bank account that has previously been created. Supply the unique linked bank account ID, and Straddle will return the corresponding information, including sensitive details. This endpoint requires additional authentication and should be used with caution.

Retrieve unmasked linked bank account details

Retrieves a list of capability requests associated with an account. The requests are returned sorted by creation date, with the most recent requests appearing first. This endpoint supports filtering options to help you track the status of various capability requests.

List capability requests

Submits a new request to enable a specific capability for an account. Use this endpoint to request additional features or services for an account.

Fundamentals

Customers

Bridge

Paykeys

Charges

Payouts

Funding

Embed

Cancel a charge

Authorizations

Headers

Path Parameters

Body

Response