Merchant View - Operations

Merchant View is the console your platform embeds so a merchant can look after their own customers. It runs in two modes. This guide covers Operations, the day-to-day side: finding a customer, taking or refunding a payment, and managing their agreements and saved payment methods.

It is written for you, the integrator, not for the merchant staff who will use it: it describes what each screen can do so you can decide what yours offers and what your own help material should say. Nothing here is end-user instructions to hand on as they stand.

The other mode is Admin, where the wording customers read is edited.

What you control

Most of what follows can be switched off. Refunds, captures, taking a payment, editing a payer, amending an agreement: each is an option you set per application or per embed, so a merchant of yours may never see a control described here, and a second merchant may see a different set. Options narrow what the console offers; they never grant anything the signed-in user could not already do.

Read these pages as what the console can do, then decide what yours does. The switches are listed in Merchant View Options, and each page names the option behind a control under "Who can do this".

Embedding it

The console is embedded as an iFrame through shuttle.js, so card data and PCI scope stay inside Shuttle. A deep link decides both the mode and what the merchant lands on: set mode to enquiry in the deep link’s context for these screens, and add action with an id or alt_key to open one account, agreement, payment or saved payment method directly. Create the link with the Deep Link Creation API and pass the id it returns to data-shuttle-embed. module is accepted as a synonym for mode. See Merchant View.

How to read these pages

There is a page per screen, and a page per family of screen sections. Sections that appear in several places, such as searching and filtering, the contract statement, comments and the audit history, are described once in the sections pages and linked from every screen that uses them. Where a control changes something, the page links to the rule behind it in Business Rules, which is the same rule the API follows.