> For the complete documentation index, see [llms.txt](https://docs.hyperswitch.io/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.hyperswitch.io/integration-guide/control-center/developers.md).

# Developers

## Developers

The **Developers** section is the bridge between the dashboard and your code. It's where you get the **API keys** that authenticate your integration, set up **webhooks** so your systems hear about payment events, and tune **payment settings** that govern how payments behave.

Everything here is scoped to a **Business Profile** and to your current **mode (Test/Live)**

This section covers:

* API Keys
* Webhooks
* Payment settings

***

### API Keys

API keys authenticate requests from your servers to Hyperswitch. Your integration can't do anything without one.

#### Managing keys

1. Go to **Developers → API Keys**.
2. **Create a key**, give it a name, and (optionally) an expiry.
3. **Copy it immediately** — the secret is shown only once at creation.
4. Use **Test keys** while developing; generate **Live keys** only when you go to production.

{% embed url="<https://scribehow.com/o/qzpN4gAaRXWhBwFWaO3hnQ/viewer/How_To_Create_A_New_API_Key_In_Hyperswitch__yCo1jmdPS_yVVcMUh1eTYQ>" %}

#### Good practices

* **Never commit keys** to source control or expose them in client-side code.
* **Rotate** keys periodically and whenever one may have leaked — create a new key, switch your integration over, then revoke the old one.
* **Revoke** any key that's unused or compromised.

> 🔑 There's a difference between your **secret API key** (server-side, full access) and the **publishable key** used by the client-side SDK. Keep the secret key server-side only.

***

### Webhooks

**Webhooks** let Hyperswitch notify *your* server when something happens — a payment succeeds, a refund completes, a dispute opens — so you don't have to poll.

#### Setting up a webhook

1. Go to **Developers → Payment Settings -> Payment Behaviour**.
2. Add your **endpoint URL** (an HTTPS endpoint on your server that receives events).
3. For live mode, your webhook URL needs to be whitelisted by the Hyperswitch team
4. Save and send a **test event(eg. test payment)** to confirm your endpoint responds.

{% embed url="<https://scribehow.com/o/qzpN4gAaRXWhBwFWaO3hnQ/viewer/Configuring_and_Testing_Webhooks_in_Hyperswitch__px5kHeD6TVelR0EZVXihXw>" %}

***

### Payment settings

**Payment settings** control default payment behavior for the profile — the knobs that shape how payments are created and handled.

Typical settings include:

* **Capture behavior** — automatic capture vs. manual (authorize now, capture later).
* **Return / redirect URLs** — where customers land after completing payment.
* **Payment-method and tokenization behavior** — including **network tokenization** (see Vault).
* **Profile-level defaults** applied to payments created under this profile.

> These defaults affect every payment on the profile, so change them deliberately and validate in **Test mode** first.


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://docs.hyperswitch.io/integration-guide/control-center/developers.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
