Skip to main content

Create an API key

Generate, refresh, or delete API keys on Scale or Enterprise, then build with the API docs.

On the Scale and Enterprise plans, you create your own API keys in Settings > Integrations. The API docs at docs.streamlinedpayments.com explain how to use them.

Create an API key

  1. Go to Settings > Integrations.

  2. On the Streamlined API card, click Manage API Keys.

  3. Click Generate API key.

  4. Copy the App ID and API Key, and store them somewhere safe, such as your password manager.

  5. Click Close.

Note: The full key is shown only once. You need both the App ID and the API Key to make a request. If you lose the key, refresh it to get a new one.

The Streamlined API card shows how many active keys you have and when one was last used.

Refresh or delete a key

On the API connection settings page, each key has two buttons:

  • Refresh replaces the key with a new one. Anything still using the old key stops working, so update your systems right away.

  • Delete removes the key for good.

If a key may have been shared or exposed, refresh or delete it right away.

Keep your keys safe

  • Treat a key like a password. Anyone with it can read and change data in your account.

  • Use a separate key for each system you connect, so you can replace one without affecting the others.

  • Delete keys you no longer use.

Get API access on Starter or Legacy

On these plans, the Streamlined API card says the API is part of the Scale and Enterprise plans. To upgrade, go to Settings > Account > Plans & Billing. See change your plan.

Build with the API

Endpoints, examples, and guides are at docs.streamlinedpayments.com. For help with an integration, email help@streamlinedpayments.com with your business name, the request you're making, and the response you get. Never include your API key.


Who can use this feature?

  • Team members with Settings access

  • Available on Scale and Enterprise

Did this answer your question?