API credentials

To integrate FlowAlp Pay via the Merchant API (or plugins that require a key), you need an API Secret associated with your instance.

Prerequisites

• Active merchant account at login.pay.flowalp.com (https://login.pay.flowalp.com)
• Permission to manage API and Plugins on the account

Create an API key

• Sign in to the merchant dashboard.
• Open API and Plugins.
• Choose Add API Key to create a new API-based integration.
• Assign a recognizable name and confirm with Add.
• In the list you will find the new key with these actions:

• Copy — copies the key value;
• Logs — lists requests associated with this key;
• Configuration — rename the integration or regenerate the key.

TODO FlowAlp: acquisire screenshot equivalente nell'account FlowAlp Pay — schermata API and Plugins con pulsante Add API Key

TODO FlowAlp: acquisire screenshot — dialog nome integrazione + Add

TODO FlowAlp: acquisire screenshot — riga chiave con Copy / Logs / Configuration

What the credential contains

Element | Use
API Secret | Secret value used to authenticate requests (`X-API-KEY` or `ApiSignature` calculation)
Integration name | Operational label in the dashboard
Instance | Separate from the key: see Instance name

Never put real secrets in documentation or versioned code. Use placeholders:

# text
<api-secret>

In application examples:

# javascript
const apiSecret = process.env.FLOWALP_PAY_API_SECRET;
const instanceName = process.env.FLOWALP_PAY_INSTANCE; // e.g. "demo-shop"

Request logs

For every integration (plugin or manual API), logs record requests between FlowAlp Pay and the third-party system, including errors.

• Go to API and Plugins.
• Click Logs next to the relevant row.
• Select a row to view request details.

TODO FlowAlp: acquisire screenshot — lista log e dettaglio request

Plugin vs manual API

Case | Action
Supported platform (WooCommerce, Shopify, Shopware, …) | Follow the plugin guide; it usually creates/links the API key automatically
System without a plugin | Create the key manually and integrate the Merchant API

Plugin list: Choose an integration.

In some technical screens, packages, or plugin names you may still see Payrexx, because FlowAlp Pay uses that technology as the payment infrastructure.

API version

TODO FlowAlp: the source merchant guide mentions API version "1.13", while the current API Reference exposes v1.16 as the server URL. Confirm which version to recommend officially to FlowAlp Pay merchants before publication.

In examples in this documentation, unless otherwise verified, use:

# text
https://api.pay.flowalp.com/v1.16/

Security

• Store the API Secret in a secret manager or environment variables.
• Do not expose the API Secret in the frontend, mobile apps, or repositories.
• If a key is compromised, regenerate it from Configuration and update connected systems.
• Restrict access to logs (they may contain sensitive payloads).

Next steps

• Authentication
• First API request