Changelog

Every dated, breaking, and additive change to the VINR API, SDKs, and products. Use this page to track what shipped, what's deprecated, and when removals land — so an integration that works today keeps working after you upgrade.

The VINR API is versioned by date. Your account is pinned to the version you onboarded with; nothing on this page changes your integration's behavior until you explicitly upgrade. See Versioning policy below.

Subscribe (RSS / webhook)AskCopy

Stay ahead of changes without polling this page.

curl https://api.vinr.com/v1/changelog.rss

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

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

await vinr.webhookEndpoints.create({
  url: 'https://yoursite.com/hooks/vinr-changelog',
  enabledEvents: ['changelog.published'],
});

Versioning policyAskCopy

VINR uses date-based API versions (for example 2026-04-01). Your account is pinned at onboarding and stays there until you upgrade.

• Additive changes — new endpoints, new optional request fields, new response fields, and new event types — ship continuously to all versions and are never considered breaking. Write parsers that ignore unknown fields.
• Breaking changes — removing or renaming a field, changing a type, tightening validation, or altering default behavior — only ever appear behind a new dated version.
• Upgrading is explicit. Set the version per request with the Vinr-Version header, or set the account default in the Dashboard.

curl https://api.vinr.com/v1/payments \
  -H "X-Api-Key: $VINR_SECRET_KEY" \
  -H "Vinr-Version: 2026-04-01"

Deprecation policyAskCopy

When a field or endpoint is deprecated we commit to a minimum 12-month support window before removal.

Recent changesAskCopy

2026-06-01 — additive

Major documentation expansion: VINR payments docs reach Stripe / Adyen / Viva parity across five new areas.

• In-person payments — full Terminal API documentation covering cloud and local modes; terminal hardware guide (Nexgo N92, N86Pro, CT20, CT20P; Ciontek CM30); Tap to Pay on iOS and Android; in-person features (tipping, DCC, cashback, MOTO, offline, installments, gift cards); terminal fleet management and remote actions. See In-person payments.
• Unified commerce — cross-channel shopper recognition and shared payment tokens; Click & Collect (BOPIS); Buy Online Return In Store (BORIS); Endless Aisle; Pay by Link in-store; MOTO; cross-channel loyalty; digital receipts; shopper insights. See Unified commerce.
• Plugins — pre-built payment plugins for WooCommerce, Adobe Commerce (Magento 2), and Salesforce Commerce Cloud (LINK cartridge). See Plugins.
• Deeper online payments — new pages for tokenization, 3D Secure (native / redirect / data-only / standalone), authorization adjustment, reversal, surcharging, installments, partial authorization, partial payments, donations, and auto-rescue. Integration models overview (Checkout vs Elements vs API-only) and advanced flow guide added. Result codes reference added to Troubleshooting.
• API reference — new In-person API group: Terminals, Terminal Payments, Terminal Actions. New Tokens resource (network tokens, account updater). Payments API extended with POST /v1/payments/{id}/adjust and POST /v1/payments/{id}/reverse.
• Task guides — three new how-to guides: Collect an in-person payment, Go omnichannel, Install the WooCommerce plugin.

2026-05-28 — additive

• Engagement: added loyalty.points.expiring webhook, fired 30 days before a points balance expires so you can prompt redemption. See Points expiry.
• Billing: subscriptions.create now accepts trialEndsAt (RFC 3339) as an alternative to trialDays.

2026-05-12 — fix

• Fixed a case where invoice.paid could fire twice for invoices settled by a saved card during a retry. Consumers that were already idempotent were unaffected; the duplicate is now suppressed at source.
• Refund objects (re_…) now always include paymentId even for partial refunds created via the Dashboard.

2026-04-20 — additive

• Payments: new payment.requires_action event surfaces 3DS step-ups initiated after creation. Pairs with the 3D Secure guide.
• Added mbu_ usage-record listing with cursor pagination to support high-volume metered billing.

2026-04-01 — breaking (new version 2026-04-01)

• amount is now rejected when not an integer. Previously decimal strings were silently floored — all amounts must be integers in minor units (1000 = EUR 10.00).
• payment.status value pending was split into requires_action and processing. Update any switch statements over status. See the payment lifecycle.
• The legacy customer.email top-level field on payment objects is removed; read it from the expanded customer object instead.

2026-03-09 — deprecated

• The vinr.charges.* namespace is deprecated in favor of vinr.payments.*. Sunset date 2027-03-09. Method names map one-to-one; only the namespace changed.

Next stepsAskCopy