Unzer

{/* Generated by scripts/generate-integration-catalog.mjs. Do not edit by hand. */}

At a glance

  • Availability: Experimental (how to enable).
  • Authentication: Basic auth.
  • Connection: HTTP Basic auth with UNZER_PRIVATE_KEY as the username and UNZER_API_PASSWORD as the password.
  • Provider documentation: Authentication reference.

Credentials

Set these per environment. See Connect an integration.

VariableRequiredDescription
UNZER_PRIVATE_KEYYesUnzer private API key (s-priv-.... for sandbox, p-priv-.... for production), used as the HTTP Basic username Docs.
UNZER_API_PASSWORDNoHTTP Basic password for the Unzer API - always empty, leave as the default empty string Docs.

Setup

  1. Get Unzer API keys: Request a free test account at https://docs.unzer.com/ (or sign an Unzer contract for production). You receive a key pair per environment: a public key (s-pub-.... / p-pub-...) and a private key (s-priv-.... / p-priv-...).
  2. Set environment variables: Add UNZER_PRIVATE_KEY=s-priv-.... (sandbox) or p-priv-.... (production) to your .env. Leave UNZER_API_PASSWORD empty - the API authenticates with HTTP Basic using the private key as the username and an empty password.
  3. Create a payment type: Charges require a payment type ID (e.g. s-crd-.... for a card) created client-side via Unzer UI components or the payment types API, so that raw card data never touches your server.
  4. Verify access: Run Get Payment with a known payment ID, or create a small test charge in sandbox with a test payment type ID.

Provider notes

  • Never use the public key (s-pub-/p-pub-) for server-side calls; only the private key authenticates this API. Keep it secret.
  • Sandbox keys (s-priv-...) and production keys (p-priv-...) both target https://api.unzer.com - the key prefix determines the environment.
  • Amounts are in the currency's major units (e.g. 49.99 EUR).

Provider API reference.

Tools

ToolAccessDescription
Get Payment<br /><code className="reference-identifier">unzer__get_payment</code>ReadGet payment
Get Charge<br /><code className="reference-identifier">unzer__get_charge</code>ReadGet charge
Create Charge<br /><code className="reference-identifier">unzer__create_charge</code>WriteCreate charge
Refund Charge<br /><code className="reference-identifier">unzer__refund_charge</code>WriteRefund charge
Authorize Payment<br /><code className="reference-identifier">unzer__authorize_payment</code>WriteAuthorize payment (approximately seven-day hold)
Charge Authorization<br /><code className="reference-identifier">unzer__charge_authorization</code>WriteCapture authorized payment
Cancel Authorization<br /><code className="reference-identifier">unzer__cancel_authorization</code>WriteCancel uncaptured authorization

Verify the connection

Call a read tool such as unzer__get_payment with arguments for your account. Confirm that the result comes from the intended account or workspace before enabling write tools.