> 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/integrations/connectors-integrations/payment-processor-capabilities/available-connectors/envoy.md).

# Envoy

Envoy is a payout processor. It is registered as a payment gateway connector, but its payment-side flows are not implemented.

{% hint style="warning" %}
**Envoy is a payout processor.** Although Envoy is registered as a payment gateway connector, its payment-side flows are unimplemented stubs: the connector declares no payment methods, and every payment flow (authorize, sync, capture, refund) fails with a "not implemented" error. What Envoy actually implements is payouts. It is one of the [`PayoutConnectors`](https://github.com/juspay/hyperswitch/blob/502bfe8ddbe6a9a9619dc4e0b88900a780c2aac5/crates/api_models/src/enums.rs#L48-L70), and payout fulfillment has a working implementation. Use Envoy through [Hyperswitch Payouts](/integrations/connectors-integrations/payouts.md), not for accepting payments.
{% endhint %}

### Status and capabilities

**Integration status:** live

**Category:** payment gateway

**Webhook flows:** None declared in code

*This connector declares no payment methods. Its payment flows are stubs; see the warning above.*

### Authentication

Envoy requires two credentials, which Envoy provides when you set up your account with them: **Username** and **Password**. Both are sent with each API request as body-key fields. See [`EnvoyAuthType`](https://github.com/juspay/hyperswitch/blob/502bfe8ddbe6a9a9619dc4e0b88900a780c2aac5/crates/hyperswitch_connectors/src/connectors/envoy/transformers.rs#L83-L98) in the connector source. The labels come from [`[envoy_payout.connector_auth.BodyKey]`](https://github.com/juspay/hyperswitch/blob/502bfe8ddbe6a9a9619dc4e0b88900a780c2aac5/crates/connector_configs/toml/sandbox.toml#L8731-L8733); note that the configuration key is `envoy_payout`, because Envoy is registered for payouts rather than payments.

### Before you start

1. Set up an Envoy account and obtain the **Username** and **Password**.
2. Envoy is not offered in the control-center payment connector list (it appears only as a payout connector), so contact the Hyperswitch team to arrange setup.
3. Configure Envoy as a payout connector and initiate payouts through [Hyperswitch Payouts](/integrations/connectors-integrations/payouts.md). Payout fulfillment is the only implemented flow; see the note under Webhooks.

### Webhooks

Webhooks are not currently supported. All three webhook handlers return `WebhooksNotImplemented`; see [`IncomingWebhook`](https://github.com/juspay/hyperswitch/blob/502bfe8ddbe6a9a9619dc4e0b88900a780c2aac5/crates/hyperswitch_connectors/src/connectors/envoy.rs#L675-L698).

Payout status cannot be tracked through Hyperswitch either. Of the payout flows, only fulfillment is implemented: [payout create](https://github.com/juspay/hyperswitch/blob/502bfe8ddbe6a9a9619dc4e0b88900a780c2aac5/crates/hyperswitch_connectors/src/connectors/envoy.rs#L86-L98) returns a not-implemented error for the eligibility check, and payout sync has no implementation at all, so it never reaches Envoy. Check payout status with Envoy directly.

### Source reference

Authentication and webhook behavior on this page is tied to Hyperswitch `502bfe8ddbe6a9a9619dc4e0b88900a780c2aac5`. See [Envoy connector source](https://github.com/juspay/hyperswitch/blob/502bfe8ddbe6a9a9619dc4e0b88900a780c2aac5/crates/hyperswitch_connectors/src/connectors/envoy.rs) and [Envoy transformers](https://github.com/juspay/hyperswitch/blob/502bfe8ddbe6a9a9619dc4e0b88900a780c2aac5/crates/hyperswitch_connectors/src/connectors/envoy/transformers.rs).


---

# 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/integrations/connectors-integrations/payment-processor-capabilities/available-connectors/envoy.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.