Keys and Credentials

Every key, ID and token Super issues, what each one is for, and where to find it in the Business Portal.

Super issues several credentials, and which ones you need depends on how you integrate. This page lists all of them in one place.

CredentialPrefixUsed forWhere to find itKeep secret
Super keysk_prod_
sk_test_
Authenticating server-side API requests.Developers → API Keys → Super KeysYes
Publishable keyPUB_Front-end integrations.Developers → API Keys → Publishable API KeysNo
Confirmation IDPWH_Telling your e-commerce platform that transactions from Super are legitimate.Developers → Integrations → View integration detailsYes
Plugin API keyPSK_Letting your plugin send payment details to Super.Developers → Integrations → View integration detailsYes
Webhook signing keywhsk_Verifying that a webhook came from Super and has not been tampered with.Developers → Webhooks → select a webhook → Signing keysYes
Checkout session token–Initialising the embedded checkout component in the browser.Returned by POST /checkout-sessionsNo
Brand ID–Identifying which brand a payment, payment link or customer belongs to.Developers → API Keys → Brand payment initiators and IDsNo
Payment initiator ID–Required in the request body when creating payments via the API.Developers → API Keys → Brand payment initiators and IDsNo

Which credentials do I need?

Building a custom API integration

You are calling the Super API directly from your own server and checkout.

Super key, Publishable key, Brand ID and Payment initiator ID. Add a Checkout session token per payment if you are using the embedded component.

Installing an e-commerce plugin

You are using one of Super's plugins for Shopify, WooCommerce, Magento or BigCommerce.

Confirmation ID and Plugin API key. These belong to the integration rather than your account, so each store you connect has its own pair.

Third party integration

You are connecting Super to a platform we do not provide a plugin for, where that platform calls our API on your behalf.

Super key, Confirmation ID, Webhook signing key, Brand ID and Payment initiator ID.

Receiving webhooks

Any of the above can receive webhooks. Each endpoint you create has its own Webhook signing key, used to verify the request came from Super.


Things worth knowing

⚠️

The plugin API key is shown once

Your PSK_ key is displayed only at the moment you generate it. Copy it straight into your e-commerce platform before generating another. Your Confirmation ID stays the same for the life of the integration.

📘

Keys are issued per API version

Super keys and publishable keys are tied to an API version. Use the API version selector on the API Keys page to see the keys for the version you are integrating against. If you move to a newer version, generate new keys for it.

📘

Test credentials are separate

Your sandbox uses its own credentials - a Super key starting sk_test_ and separate integration keys. A live key will not work in the sandbox, and the reverse is also true. See Sandbox Environment.


Next steps


Did this page help you?