Platform API

Platform API 1.0.0

The Platform API is for platforms that provide payments as an embedded feature within their own application. The platform owns the payment experience — merchants interact with the platform’s UI, and Shuttle operates in the background. Merchants have no direct relationship with Shuttle; the platform provisions and manages everything on their behalf.

Read the full Platform API introduction.

Information

• License: Proprietary
• OpenAPI version: 3.0.0

Operations

GET

/instances

POST

/instances

GET

/instances/{instance_id}

PUT

/instances/{instance_id}

DELETE

/instances/{instance_id}

GET

/instances/{instance_id}/capabilities

Authentication

basicAuth

Basic Authentication using secret key

Security scheme type: http

bearerAuth

OAuth 2.0 Bearer Token Authentication

Security scheme type: http