Integration Guide

The Payment Links for Platforms integration is for platforms where merchants have (or will set up) their own Shuttle account. Merchants configure their own payment experience — including branding, domain, and checkout styling — through the Shuttle Merchant Portal. They then connect their account to your platform via OAuth.

Once connected, your platform can create payment links on the merchant's behalf and direct customers to a Shuttle-hosted checkout. Webhooks notify your platform when payments complete.

This is distinct from Embedded Payments for Platforms. With Embedded Payments, the platform owns the full payment experience and merchants never interact with Shuttle directly. With Payment Links for Platforms, the merchant has a direct relationship with Shuttle and retains control of their own setup — your platform connects alongside it via OAuth.

This section is intended for multi-tenant workflow applications, Integration Platform as a Service (iPaaS) providers, MCP servers, and SaaS platforms integrating Shuttle Payment Links on behalf of multiple merchants.

Important: To achieve Shuttle certification, integrators must follow our requirements exactly as specified (unless otherwise agreed with Shuttle). Deviation from prescribed implementations, field names, or integration patterns will prevent certification approval.

What You'll Learn

This guide covers the complete integration process for multi-tenant platforms:

  • Authentication: How to implement OAuth 2.0 for multiple merchants with sandbox and live environment support
  • Actions / Events: Prescriptive implementation requirements for the Shuttle Payment Links API. This section defines exact expectations for field names, field ordering, integration completeness, and additional requirements that must be met for Shuttle to certify your integration.
  • Webhooks: How to attach and detach webhooks to receive real-time notifications for payment link events across your connected merchant instances

Certification Requirements

To achieve Shuttle certification for your multi-tenant integration, you must:

  • Follow exact implementation specifications outlined in the API Endpoints section
  • Use prescribed field names and ordering as defined in our requirements
  • Implement complete integration coverage for all required Payment Links functionality
  • Meet additional undocumented requirements that will be provided during the certification process

Note: Live environment Client ID and Client Secret will only be provided upon successful certification completion.

Prerequisites

Before starting this integration:

  • Your platform supports OAuth 2.0 client flows
  • You can securely store and manage credentials for multiple merchants
  • You have the ability to prompt users for environment selection (sandbox vs live)
  • Contact Shuttle support to obtain OAuth credentials for both environments