Skip to main content
Use the Straddle CLI to inspect payments, call the Pay by Bank and Embed APIs, and answer questions from a local copy of your data.

Install and connect the CLI

Install the CLI, configure your API key and account context, and verify an API read.

​
Find the command for your task

Discover payment workflows and inspect their options:
For API operations, inspect the resource’s commands with straddle customers --help. Coding agents can read the full command description from straddle agent-context.

​
Choose how to work

Configure credentials and context

Select sandbox or production, your integration type, and an acting account.

Use the CLI with agents

Discover commands, preview requests, and consume JSON output.

Synchronize and query data

Prepare a local SQLite store for search, SQL, and payment analysis.

Investigate a payment question

Follow a playbook for payment progress, reconciliation, returns, or charge and payout volume.
In a terminal, resource commands show readable output. Add --agent for compact JSON and automation defaults, or --json for JSON without changing confirmation behavior. See output modes.