Business rules

What Shuttle actually does when something changes. Every operation that alters a payment, an agreement, an account or a provider connection follows one set of rules, whether it is reached from a screen your platform embeds or straight from the API. Those rules are written here once, and the screen guides and the API reference both link to them.

This is the reference for the behaviour you are integrating against. Use it when you need to know what Shuttle will accept, what it will refuse and why, what a call changes beyond the obvious, and what reaches your webhooks afterwards.

What is here and what is not

These pages describe the platform as Shuttle runs it. What your merchants can actually reach is narrower: many operations sit behind a control your platform can switch off, or behind a permission you assign, and some depend on the payment processor a merchant connected. A page describing an operation is not a promise that every merchant of yours can perform it.

Where a rule is enforced only by a screen and not by the API, the page says so, so you know what a direct API call would be allowed to do.

Who can do what

Each user is given one of four roles: see Roles and permissions. Every page opens its “Who can do this” section with the roles that can perform the operation. The permission names that follow are for platforms that manage permissions themselves; if you use the four roles as they come, you can ignore them.

How to read a page

They all follow the same shape. Where you can do this lists the screens and the API operations. Before you start is what must already be true. Inputs is what the call takes. Rules is what Shuttle checks, what you see when a check fails, and whether the check is the API or only a screen. What happens is the outcome, including what is sent to the customer and what reaches your webhooks. Who can do this is the roles, permissions and options.

Operations

Every operation, grouped by what it acts on.

Accounts (people and companies)

Saved payment methods

Archive a saved payment method

Notes and attachments

Contracts (recurring and scheduled agreements)

Charges (contract instalments)

Payments, refunds, captures and voids

Branded localisation strings

Payment gateways (provider connections)

Workflows (fraud screening connections)

Connect a fraud workflow

Legal entity routes (which provider serves each payment method at checkout)

Instance (merchant account settings: terms, wallets, merchant details)

Was this page helpful?