Skip to main content
The MerchantSpring Public API uses API keys for authentication. Every request must include your key in the x-api-key request header.

​
Getting your API key

API keys are provisioned automatically by MerchantSpring — they are not generated from this documentation site. To access your key, you must be an Owner or Administrator of an organisation that has API access enabled.
  1. Sign in to MerchantSpring.
  2. Go to Settings → API.
  3. Click the reveal (eye) icon, then copy your key and store it securely — treat it like a password.
Each Owner and Administrator has their own individual key. The same page also shows your current plan and API usage.
Don’t see the API tab? It’s only visible to Owners and Administrators in organisations with API access enabled. If you are an Owner/Administrator and do not have access, contact MerchantSpring.
Keep your API key secret. Never embed it in client-side code, mobile apps, or public repositories. There is no self-service rotation — if a key is exposed, contact MerchantSpring to have it rotated.

​
Making authenticated requests

Pass your key in the x-api-key header on every request:
You can also try any endpoint directly from the browser using the playground on each API Reference page — paste your key into the x-api-key field and press Send.

​
What your key determines

Your key is associated with:
  • Your user — requests return data only for the channels your user can access.
  • Endpoint access — some endpoints require additional access enabled on your key and is available on request — contact MerchantSpring to enable them.

​
Error responses

Usage limits (request rate and volume) are governed by the limits attached to your API key. If you need higher limits, talk to your MerchantSpring representative.