Dashboard guide

The VINR dashboard is where your team runs the business day to day — searching payments, refunding a customer, inviting a colleague, and switching between live and sandbox data. This page maps the layout so you can find the right screen fast and know which action belongs to which role.

Live vs. sandboxAskCopy

A mode switch sits in the top-left of every screen. Sandbox is a fully isolated copy of your account: separate objects, separate API keys, no real money. Use it to rehearse a refund flow or test a webhook before touching production.

Home and reportingAskCopy

The home screen summarizes the metrics most teams check first:

Every tile honors the date-range and currency filters at the top. Export any view to CSV for finance reconciliation.

Payments and searchAskCopy

The Payments list is the operational workhorse. Search accepts an object ID (pay_, re_, dp_), a customer email, or the last four digits of a card, and you can stack filters by status, amount, currency, and date.

Open a payment to see its full timeline — authorization, capture, 3DS result, and any refunds or disputes — plus the raw event payload. From here an agent can:

Customers and methodsAskCopy

The Customers screen lists every cust_ with lifetime volume, default payment method, and linked loyalty account. Open a customer to manage their stored cards, view their invoices and subscriptions, and start a refund without leaving the record.

Most dashboard actions have an API equivalent, so what you do by hand is reproducible in code:

import { Vinr } from '@vinr/sdk';
const vinr = new Vinr({ secretKey: process.env.VINR_SECRET_KEY });

// The same lookup the Customers search performs.
const customer = await vinr.customers.retrieve('cust_8Qa2');

// And the refund the timeline's "Refund" button issues.
const refund = await vinr.refunds.create({
  payment: 'pay_3Nf91',
  amount: 1000,            // €10.00, partial refund in minor units
});                        // -> "re_..."

Team and rolesAskCopy

Invite teammates from Settings → Team. Each member gets a role that scopes what they can see and do:

SettingsAskCopy

Settings is grouped so you rarely hunt for a control:

• Account — business name, branding for hosted pages and receipts, default currency.
• API keys — create, roll, and revoke secret and publishable keys per mode.
• Webhooks — register we_ endpoints, pick events, and replay deliveries. See Webhooks.
• Payouts — bank account and settlement schedule.
• Tax and compliance — tax registrations and data-export controls.

Next stepsAskCopy