Shuttle exposes several APIs depending on which product you're integrating. This page explains the structure and helps you find the right place to start.
Platform API
The Platform API is for platforms providing payments as an embedded, white-labeled feature within their own application. The platform owns the payment experience — merchants never interact with Shuttle directly. The platform provisions merchant instances, controls the full payment flow, and accesses all payment APIs using its own credentials.
It includes the full Merchant Instance API scoped to any merchant the platform manages, plus platform-specific endpoints for instance management.
Merchant Instance API
The Merchant Instance API is the core payment API. It is used directly by merchants with API access, and by platforms acting on behalf of a specific merchant they manage.
It covers all payment operations within a single merchant account: creating payments, managing subscriptions, handling payment methods, and more.
Payment Links for Platforms API
The Payment Links for Platforms API is for platforms that need payment collection features without a deep integration. Merchants set up and manage their own Shuttle account through the Shuttle Merchant Portal — including their payment experience, branding, and domain. They then connect that account to the platform via OAuth.
Once connected, the platform can create payment links on the merchant's behalf and receive webhook notifications when payments are completed. The merchant retains direct control of their Shuttle setup; the platform sits alongside it.
This is distinct from the Platform API: with the Platform API, the platform owns the merchant relationship and builds the payment experience. With the Payment Links for Platforms API, the merchant already has a Shuttle account and the platform connects to it.
Payment Links API
The Payment Links API is for merchants using the Shuttle Payment Links product directly. It is a focused subset of the Merchant Instance API covering exactly what's needed to create and manage payment links.
If you're integrating Payment Links for a single merchant, start here.
| If you're building... | Start with... |
|---|---|
| A platform embedding payments as a white-labeled feature in your app | Platform API |
| A direct merchant integration, or acting on behalf of a specific merchant | Merchant Instance API |
| A platform connecting to merchants' existing Shuttle accounts via OAuth | Payment Links for Platforms API |
| Payment Links for a single merchant | Payment Links API |