Account setup

Before you can charge a customer or issue a single loyalty point, you need a VINR account, a team with the right roles, and a clear understanding of the wall between your sandbox and live environments. This page walks you through all of it.

Create an accountAskCopy

Your account is the top-level container for everything in VINR: customers, payments, billing, loyalty programs, and payouts. One account can hold multiple environments and team members, but it maps to a single legal entity.

Sandbox vs. liveAskCopy

VINR gives every account two isolated environments. They never share data, keys, or money.

Switch environments using the toggle in the top-left of the dashboard. Each environment has its own API keys and webhook secrets, so a sandbox secret can never accidentally move real money.

Always exercise the failure paths in sandbox before launch. The reserved test cards drive deterministic outcomes:

A minimal smoke test against sandbox:

import { Vinr } from '@vinr/sdk';

// Note the sk_test_ key — this client can only ever touch sandbox.
const vinr = new Vinr({ secretKey: process.env.VINR_SECRET_KEY });

const payment = await vinr.payments.create({
  amount: 1000, // €10.00 in minor units
  currency: 'EUR',
  description: 'Sandbox smoke test',
});

console.log(payment.id, payment.status); // pay_… requires_payment_method

Team and rolesAskCopy

Invite teammates under Settings → Team. Roles are scoped per environment, so you can give an engineer full sandbox access while keeping their live permissions read-only.

Connecting your bank accountAskCopy

Payouts are the funds VINR settles to you after fees. To receive them, add a verified business bank account under Settings → Payouts. This is only available once business verification has cleared.

const payouts = await vinr.payouts.list({ limit: 5, status: 'paid' });

for (const po of payouts.data) {
  console.log(`${po.id}: ${po.amount} ${po.currency} → ${po.arrivalDate}`);
}

Next stepsAskCopy