Skip to content

Tour the portals

The Admin portal, where your team operates the platform, and the Merchant portal, where your merchants manage their own business.

Your platform has two portals. Your team works in the Admin portal: you board merchants, set what they may do and support them. Your merchants work in the Merchant portal: they follow their payments, refund, and manage their own projects and users. This page shows what you find where.

The Admin portal

The Admin portal is your operating console. The main menu works across all merchants. When you open a merchant, the menu narrows to that merchant: that's where most of the daily work happens. The search box at the top finds any merchant, project, order or user by keyword.

GroupItemsWhat you do there
DashboardThe newest active merchants and a list of live projects, ten of each.
GeneralMerchants, Projects, UsersSearch and export across all merchants. Create Merchant starts boarding a new merchant.
OrdersOrders, Transactions, Payouts, Payment linksSearch payments across all merchants.
API callsAPI Calls, Webhook CallsEvery request to the API, and every webhook sent, across all merchants.
PlatformRisk & Fraud, Plugins, Payment acceptance, System usersThe settings of your platform: fraud prevention, plugin configuration, the platform-wide settings of the hosted payment page (a project's own style is set with the Boarding API), and the users and roles of your own staff.

Payouts only appears when Ginger Payout is switched on for your platform, on request.

Inside a merchant

Open a merchant and the menu shows its name, with Back to return to the merchant list.

Overview

  • Details: the merchant itself, in tabs:

    • General: company details, tags, configuration and the merchant status.
    • Integration: the main contract of the merchant.
    • Payout: payout settings, when your platform uses Ginger Payout.
    • Payment Methods: the payment method contracts, with their start and end dates.
    • Permissions: the base permissions, the ceiling of what the merchant may do.

    Edit changes the merchant.

  • Projects: one per webshop or app. Each project has the tabs General (with the webhook URL), Integration (the API key), Payment Methods, Payment Method Contracts, Permissions and Fraud prevention.

  • Users: create users, give them roles, and reset their multi-factor authentication.

  • Roles: define sets of permissions and give them to users.

Payments

  • Orders: search by date, amount, status, payment method, reference or card number. An order has the tabs General, Order summary, Platform / Browser info, Transactions, API calls and Webhook calls, and a timeline of its statuses. It also shows its flags and the linked captures, refunds and chargebacks. Show JSON shows the order as the API returns it.
  • Transactions: the payment attempts behind the orders, with the card details, fees, fraud and processing outcomes, and a timeline of every event, such as the 3-D Secure result.
  • Payment links: the links the merchant sent to request a payment, and the orders paid through them.

Developer

  • API calls: every request the merchant's systems made, with the request and the response.
  • Webhooks: every notification sent to the merchant, with the response of their server. Start here when a merchant says they didn't receive a status. Webhooks are retried, but not guaranteed: merchants should check orders that aren't final yet. See Retries in the payment acceptance docs.

The Merchant portal

Your merchants' users log in to a simpler portal that only shows their own merchant.

GroupItemsWhat merchants do there
DashboardRecent orders, recent refunds and recent failed API calls.
PaymentsOrdersSearch, view and export orders. Refund, capture and void payments.
Payment linksCreate payment links and follow them.
Payouts, InvoicesTheir payouts and your invoices, when your platform uses Ginger Payout.
IntegrationAPI calls, WebhooksThe logs of their API calls and webhooks, to debug their integration.
Developer portalA link to the payment acceptance docs.
AccountSettingsCompany details, projects and their API keys, payment methods and hosted payment page, users and roles.

Within their base permissions, merchants manage themselves:

  • Their company details, users and roles.
  • Their projects: create them, regenerate API keys, switch payment methods on and off, and brand the hosted payment page.

Only you can change the processor contracts and the base permissions, in the Admin portal.

Who does what

TaskYou, in the Admin portalYour merchant, in the Merchant portal
Create the merchant and set its statusYesNo
Base permissions and payment method contractsYesNo
Create projects, users and rolesYesYes
Generate a new API key for a projectYesYes
Switch payment methods on or off per projectYesYes
Style a project's hosted payment pageNo, use the Boarding APIYes
Refund, capture and voidNoYes
Read the API call and webhook logsYesYes

Next steps