A processor is a payment gateway integration available on the Shuttle platform (e.g., Stripe, Adyen, PayPal). This is different from a gateway — a processor is the integration type, while a gateway is a specific merchant's connection to that processor.
Listing Processors
The list endpoint returns all processors, including ones not available for new connections. Filter for visible: true to get processors your merchants can connect to. Invisible processors are included so you can display information for all processors used by your instances, even legacy or pre-release ones.
Connection Types
Each processor connects via one of two methods:
- OAuth (
oauth: true): the merchant authenticates through a login flow. Use theoauth_urlto initiate the process, replacing#SUCCESSURL#and#CANCELURL#with your redirect URLs. On success, anoauth_dataparameter is returned that you pass toPOST /gatewaysto complete the connection - API Keys (
oauth: false): the merchant enters their processor credentials. Use the processor settings endpoint to get the form schema
Available Information
Each processor includes:
- Countries where it can acquire merchants
- Payment method types it supports (cards, ACH, SEPA, wallets, etc.)
- Category (
RECOMMENDED,STD,BETA) indicating maturity level - Logo URL for rendering in your UI
- Instructions (markdown) for how to configure it