Gateways

gateways

A gateway is a merchant’s connection to a payment processor. While a processor represents the integration type (e.g., Stripe, Adyen), a gateway is the specific connection a merchant has made to that processor with their own credentials.

What a Gateway Defines

Each gateway connection defines:

• Payment methods supported (VISA, Mastercard, AMEX, ACH, SEPA, etc.)
• Features available per payment method (authorise, capture, refund, save card, etc.)
• Currencies the merchant can accept through this connection

Connection Types

Gateways are connected in one of two ways:

• OAuth: the merchant authenticates with the processor via a login flow (e.g., Stripe Connect, PayPal). The oauth_url from the Processors API initiates this
• API Keys: the merchant enters their credentials directly (e.g., Adyen, Checkout.com)

Both connection types are handled by the Merchant Setup UX component, or can be managed via this API.

Multiple Gateways

A merchant can connect multiple gateways to:

• Switch processors while retaining the old connection for saved cards and refunding old transactions
• Route payment types to different processors (e.g., cards via Stripe, direct debit via GoCardless)

Payment method routing is controlled by legal entity routes.

Status Flow

Status	Description
CREATED	Gateway has been created but not yet connected
SETUP	Gateway is being configured
LINKED	Gateway is connected but has not yet processed a payment
ACTIVE	Gateway is connected and has processed payments
RUNDOWN	Gateway is being phased out — no new payment methods, but saved cards can still be used
ARCHIVE	Gateway has been disconnected — no payments will be processed

Operations

GET

/gateways

POST

/gateways

GET

/gateways/{gateway_id}

PUT

/gateways/{gateway_id}

GET

/gateways/{gateway_id}/connection

GET

/gateways/{gateway_id}/settings

GET

/gateways/{gateway_id}/payment_method_count