For the complete documentation index, see llms.txt. This page is also available as Markdown.

Coingate

Connect Coingate through Hyperswitch.

Coingate gives merchants an alternative payment method integration in Hyperswitch. It declares crypto support in the capability block below, with method-specific capture, refund, mandate, region, and currency details there. Use the status and webhook declaration in that block when deciding whether to enable it.

To connect Coingate to your Hyperswitch account, follow Activate a connector on Hyperswitch, then return here for connector-specific behavior.

Status and capabilities

Integration status: sandbox

Category: alternative payment method

Webhook flows: payments

Payment method
Type
Mandates
Refunds
Capture methods
Countries
Currencies

crypto

Crypto

not supported

supported

automatic, sequential automatic

59

EUR, GBP, USD

Authentication

Enter the connector credentials API Key and Merchant Token. Both are used on the payment path, not just for callbacks.

The API key is sent as Authorization: Bearer <API key>. The Merchant Token is sent in the body of every payment creation request, as the token field of CoingatePaymentsRequest, and the same value is what CoinGate webhooks are checked against. A wrong Merchant Token therefore fails payments, not only callbacks. These labels come from [coingate.connector_auth.BodyKey]; the auth mapping is CoingateAuthType, and the header is built in get_auth_header().

Refund metadata

Refunds need more than the two credentials, from two different places, and a refund fails if either set is incomplete.

Three values come from the connector metadata you configure once: currency_id, platform_id, and ledger_account_id, from CoingateConnectorMetadataObject. These are not authentication values and are not currency-scoped credentials.

Three more come from the refund request itself: address and email are read out of refund_connector_metadata, and reason is the refund's own reason field. CoingateRefundRequest rejects the refund with a missing-field error if refund_connector_metadata is absent, or if it lacks address or email, or if the refund carries no reason. Supply all three per refund.

Before you start

  1. Create or sign in to your CoinGate account and obtain the API Key and Merchant Token.

  2. Sign in to the Hyperswitch control center and open CoinGate.

  3. Enter the two connector credentials.

No provider dashboard path beyond account setup was verified for this page.

Webhooks

CoinGate maps webhook statuses to payment outcomes: Pending becomes processing, Confirming and New require payment action, Paid succeeds, and Invalid, Expired, and Canceled fail. It verifies the webhook by comparing the request token with the configured Merchant Token. See get_webhook_event_type() and verify_webhook_source().

Source reference

Authentication and webhook behavior on this page is tied to Hyperswitch ec9d1d22bf0257b7de4d4d8bbba4e27fd520bdf7. See Coingate connector source and Coingate transformers.

Last updated

Was this helpful?