Envoy

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

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, and payout fulfillment has a working implementation. Use Envoy through Hyperswitch Payouts, not for accepting payments.

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 in the connector source. The labels come from [envoy_payout.connector_auth.BodyKey]; 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. 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.

Payout status cannot be tracked through Hyperswitch either. Of the payout flows, only fulfillment is implemented: payout create 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 and Envoy transformers.