Skip to main content
The Fintoc CLI lets you make API requests and listen to webhooks from the command line. You can use the Fintoc CLI to:
  • Create, retrieve, update, or delete any of your Fintoc resources in test mode.
  • Receive real-time webhooks at localhost without a public tunnel and without creating new webhook endpoints.

Choose an installation method

npm

The CLI is published to npm and runs on macOS, Linux, and Windows. It requires Node.js >= 22. On Windows, install with npm, since Homebrew is not available. To install with npm run:
npm install -g @fintoc/cli works in PowerShell and Command Prompt on Windows.

Homebrew

Homebrew is available on macOS and Linux. To install with Homebrew run:
To update run:

Log in to the CLI

Authenticate the CLI with a Fintoc API key.
This opens an interactive flow. If you don’t want to use a browser, pass the API key inline with the --api-key flag:
By default, fintoc login authenticates in test mode. Pass --mode live to log in to live mode instead. You can also skip persisting the credential by exporting the FINTOC_API_KEY environment variable; the CLI picks it up automatically. See Fintoc CLI keys for the full precedence order.

Verify your setup

fintoc doctor verifies your CLI setup. It checks the resolved API key, the Node.js version, the path of the config file, and reachability of api.fintoc.com. Run it to debug authentication or connectivity errors.