The Payment Links for Platforms API is for platforms that need payment collection features without a deep integration. Rather than embedding a payment experience, the platform directs merchants to create their own Shuttle account through the Shuttle Merchant Portal. Merchants manage their own payment experience there — including branding, domain, and checkout styling.
Once a merchant has a Shuttle account, they connect it to the platform via OAuth. The platform can then create payment links on the merchant's behalf and send customers to a Shuttle-hosted checkout. Webhooks notify the platform when payments are completed so it can take any follow-on action.
This is a lighter integration than the Platform API. The merchant has a direct relationship with Shuttle and retains control of their payment setup. The platform connects alongside that via OAuth.
This API consists of:
- OAuth 2.0: The authorization flow merchants use to connect their Shuttle account to your platform.
- Authentication: How to authenticate API requests on behalf of a connected merchant.
- Payment Links API: Create and manage payment links on behalf of the merchant.
- Webhooks: Subscribe to payment events on a merchant's instance.