Digital receipts

VINR generates and delivers a receipt for every payment, regardless of whether the shopper bought online, tapped a card at a terminal, or paid via a link sent to their phone. A unified receipt template means the shopper sees the same merchant brand, the same structure, and the same return link whether they bought in store or on a laptop at midnight. Receipts automatically include the core transaction details, earned loyalty points when the loyalty module is active, and a return or exchange link that routes back to your configured returns policy URL.

Receipt channelsAskCopy

VINR supports four delivery channels. Which channels are available depends on how the payment was initiated; some are triggered automatically and others are presented to the shopper as a choice.

Configure receipt settingsAskCopy

Global defaults are configured in Dashboard → Settings → Receipts. You can override defaults per-payment on both terminal and online payment calls.

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

const vinr = new Vinr({ secretKey: process.env.VINR_SECRET_KEY });

const payment = await vinr.terminal.payments.create({
  terminalId: 'term_01HZ5QXYZ',
  amount: 3500,
  currency: 'GBP',
  reference: 'order_1042',
  receipt: {
    channels: ['email', 'sms'],
    requireConsent: true,
  },
});

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

const vinr = new Vinr({ secretKey: process.env.VINR_SECRET_KEY });

const payment = await vinr.payments.create({
  amount: 3500,
  currency: 'GBP',
  shopperEmail: 'shopper@example.com',
  shopperReference: 'cust_xyz789',
  receipt: {
    channels: ['email', 'sms'],
    requireConsent: true,
  },
});

When requireConsent: true is set, VINR checks the shopper profile for a stored consent record before dispatching. If no consent is on file and none was passed on the request, the receipt is queued but not sent until consent is confirmed. See GDPR and consent below.

Per-channel settings — such as the SMS sender name and the email reply-to address — are configured in Dashboard → Settings → Receipts → Channel settings.

BrandingAskCopy

Upload your logo, choose a brand colour, and set custom footer text in Dashboard → Settings → Receipts → Branding. These settings apply across all receipt channels — email, SMS link, and QR-hosted receipt — so your shopper sees the same look regardless of how they received the receipt.

Custom receipt fieldsAskCopy

Append order-specific data to any receipt by passing a receiptData object on the payment. The fields appear as a labelled section at the bottom of the receipt, above the footer text.

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

const vinr = new Vinr({ secretKey: process.env.VINR_SECRET_KEY });

const payment = await vinr.payments.create({
  amount: 8900,
  currency: 'EUR',
  shopperEmail: 'shopper@example.com',
  shopperReference: 'cust_xyz789',
  receiptData: {
    orderId: 'ORD-20260531-0042',
    itemSummary: '2x Wireless Headphones, 1x USB-C Cable',
    returnByDate: '2026-06-30',
  },
});

The itemSummary field accepts plain text only (max 500 characters). For structured line-item rendering, use a custom receipt template — see the Advanced section below.

Loyalty on receiptsAskCopy

When loyalty is enabled for your account and a shopperReference is supplied on the payment, VINR automatically appends a loyalty summary to the receipt. The summary shows the points earned on this transaction and the shopper's updated balance.

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

const vinr = new Vinr({ secretKey: process.env.VINR_SECRET_KEY });

const payment = await vinr.payments.create({
  amount: 5000,
  currency: 'USD',
  shopperEmail: 'shopper@example.com',
  shopperReference: 'cust_xyz789',
  receipt: {
    channels: ['email'],
  },
});

No additional configuration is needed — VINR resolves the loyalty account from shopperReference and populates the earned points and current balance fields automatically. If the shopper is not enrolled in your loyalty programme, the loyalty section is omitted from the receipt silently.

See Cross-channel loyalty for how to set up the loyalty module and configure earning rules across channels.

GDPR and consentAskCopy

Email and SMS receipt delivery requires a lawful basis under GDPR and equivalent privacy regulations. The recommended approach is to capture explicit consent at the point of collection — for example, a tick-box at online checkout or a screen prompt at the terminal.

Pass the consent flag alongside the shopper's contact details:

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

const vinr = new Vinr({ secretKey: process.env.VINR_SECRET_KEY });

const payment = await vinr.payments.create({
  amount: 4200,
  currency: 'EUR',
  shopperEmail: 'shopper@example.com',
  shopperReference: 'cust_xyz789',
  shopperConsent: {
    receiptEmail: true,
    receiptSms: false,
    capturedAt: new Date().toISOString(),
    method: 'checkout_checkbox',
  },
  receipt: {
    channels: ['email'],
  },
});

VINR stores the consent record with the shopper profile. On future payments that reference the same shopperReference, stored consent is applied automatically — you do not need to pass shopperConsent again unless the shopper updates their preferences.

Next stepsAskCopy