Skip to main content

At a glance

Credentials

Set these per environment. See Connect an integration.

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.
  • 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: https://docs.unzer.com/server-side-integration/api-basics/

Tools

Example prompts

  • Look up an Unzer payment I specify and summarize its state and the total, charged, canceled, and remaining amounts.
  • Refund a charge on an Unzer payment I specify and confirm the refunded amount.