Salesforce Commerce Cloud
Install and configure the VINR LINK cartridge for Salesforce Commerce Cloud (SFCC / Demandware).
VINR for Salesforce Commerce Cloud is delivered as a LINK cartridge certified by Salesforce. It supports both SFRA (Storefront Reference Architecture) and SiteGenesis storefronts, and is available from the Salesforce AppExchange or directly from the VINR merchant dashboard. A single cartridge installation covers all VINR online payment methods; in-person acceptance is available through the VINR OMS connector described in the In person section below.
This is illustrative content. Plugin availability and exact menu paths may differ; refer to your VINR account manager for production details.
Supported payment methodsAsk
Prop
Type
RequirementsAsk
Before installing the cartridge, confirm every item below is in place.
Prop
Type
InstallAsk
Download the VINR cartridge
Obtain the latest cartridge package from the Salesforce AppExchange listing (search "VINR Payments LINK Cartridge") or from your VINR dashboard under Integrations → Plugins → Salesforce Commerce Cloud. The download is a .zip containing int_vinr_sfra (for SFRA) and int_vinr_sg (for SiteGenesis).
unzip vinr-sfcc-cartridge-latest.zip
cd vinr-sfcc-cartridge-latest
npm install
npm run buildUpload the cartridge via WebDAV
Upload the built cartridge directory to your SFCC instance. Using the VS Code Prophet Debugger extension, add the cartridge root to your dw.json workspace config and trigger an upload. Using the SFCC CLI:
sgmf-scripts --uploadCartridge int_vinr_sfraFor SiteGenesis storefronts, replace int_vinr_sfra with int_vinr_sg. Confirm the upload succeeded in Business Manager → Administration → Site Development → Development Setup.
Add the cartridge to the site cartridge path
In Business Manager, navigate to Administration → Sites → Manage Sites → {your-site} → Settings. In the Cartridges field, add int_vinr_sfra to the path, positioned before app_storefront_base:
int_vinr_sfra:app_storefront_base:modulesFor SiteGenesis: add int_vinr_sg before app_storefront in the same field. Save and apply.
Cartridge path order is load order. int_vinr_sfra must appear before app_storefront_base — reversing this order causes the cartridge controllers and templates to be shadowed by the base storefront and VINR payment methods will not appear at checkout.
Import the cartridge metadata
Navigate to Administration → Site Development → Import & Export. Under Import, upload the metadata/ package from the cartridge archive. This imports the VINR payment method definitions, custom site preferences, and job schedules into your Business Manager instance.
Select the target site(s) when prompted. For multi-site setups, repeat the import for each site that will use VINR.
Configure the VINR API service credentials
Navigate to Administration → Operations → Services. Locate the VINR API Service profile (imported in the previous step). Click the service credential and enter:
- API URL:
https://api.vinr.com/v1(test) orhttps://api.vinr.com/v1(live — update when going live) - API Key: your VINR secret key from Dashboard → Developers → API keys
- Webhook Secret: the signing secret for your SFCC webhook endpoint
Save the credential. The service will now be available to the cartridge at runtime.
ConfigureAsk
Payment methods
Navigate to Merchant Tools → Ordering → Payment Methods → VINR Payments. Each payment method imported by the cartridge metadata appears as a separate entry. For each method:
- Set Enabled to
Yesto activate it at checkout - Under Assignments, assign the method to the relevant site(s) and restrict by locale or currency where needed
To control which payment methods are available per storefront locale (for example, showing iDEAL only on the NL locale), set the Currencies and Countries fields on each payment method entry rather than creating separate methods per locale.
Capture mode
VINR supports two capture modes, configurable per site via Business Manager custom preferences:
Navigate to Merchant Tools → Site Preferences → Custom Preferences → VINR Payment Settings.
Prop
Type
When VINR_CaptureMode is on_shipment, the cartridge registers a capture job that runs on a schedule. Confirm the VINR Order Capture job is active under Administration → Operations → Jobs before going live.
3D Secure
3DS2 authentication is handled automatically by the cartridge for all card payments. No additional configuration is required. The cartridge passes the SFCC session's browser fingerprint and device data to VINR, which completes the frictionless or challenge flow transparently.
If your storefront uses a custom checkout controller that bypasses the VINR ISML templates, you must ensure the cartridge's 3DS device-data collection script is included on the payment step page. See the Advanced section for the SFRA controller extension pattern.
Webhooks
The cartridge registers a webhook receiver at:
https://yoursite.com/on/demandware.store/Sites-{site}-Site/default/VINR-NotifyRegister this URL in your VINR dashboard under Developers → Webhooks. Copy the webhook signing secret into the VINR API Service credential in Business Manager (Administration → Operations → Services → VINR API Service → credential → Webhook Secret).
SFCC order status is mapped from VINR payment events as follows:
Prop
Type
Multi-site
One cartridge installation supports multiple SFCC sites. Each site has its own set of custom site preferences under Merchant Tools → Site Preferences → Custom Preferences → VINR Payment Settings. Configure VINR_Enabled, VINR_CaptureMode, and payment method assignments independently per site.
API key credentials are shared at the service level (Administration → Operations → Services) unless you require separate VINR merchant accounts per site — in that case, create separate service credentials and reference them from the per-site custom preference VINR_ServiceCredentialId.
Tokenization and saved cardsAsk
The VINR cartridge integrates with the SFCC Customer Payment Instruments vault. When a customer is logged in and selects Save for future use at checkout, the cartridge stores the VINR pm_ token as a Customer Payment Instrument against the SFCC customer profile. On subsequent visits, saved methods appear in the payment step without requiring card re-entry.
Prop
Type
Saved tokens are compatible with Salesforce Order Management subscription orders. The cartridge exposes a VINRPaymentHelper.chargeStoredToken(customerId, paymentInstrumentId, amount, currency) script API that OMS order jobs can call to charge a stored instrument on a recurring schedule.
For the full tokenization model and network token lifecycle, see Tokenization.
In personAsk
Terminal payments can be triggered from Salesforce Order Management (OMS) using the VINR OMS connector — a separate module that is not included in the LINK cartridge. The OMS connector exposes a B2C Commerce order flow that routes a terminal payment request to a VINR reader assigned to the fulfillment location.
To enable in-person payments via OMS:
- Contact your VINR account manager to obtain the VINR OMS connector package.
- Install and configure the connector following the connector's own setup guide.
- Assign VINR readers to SFCC locations in the VINR dashboard under Hardware → Terminals.
- In OMS, configure the VINR payment action on the order workflow where terminal collection should occur (typically at order pick-up or ship-from-store fulfillment).
For terminal hardware setup, reader assignment, and the full in-person payment flow, see In-person payments.
The VINR OMS connector is a separate licensed module. It is not required to accept online payments through the LINK cartridge.
Go liveAsk
Switch service credentials to live
In Business Manager, navigate to Administration → Operations → Services → VINR API Service → credential. Replace the test secret key with your live secret key (sk_live_…) from VINR Dashboard → Developers → API keys. Save the credential.
Set capture mode for production
Review VINR_CaptureMode under Merchant Tools → Site Preferences → Custom Preferences → VINR Payment Settings for each live site. Confirm the mode matches your fulfillment model. If using on_shipment, verify the VINR Order Capture job schedule under Administration → Operations → Jobs.
Clear SFCC caches
Navigate to Administration → Sites → Clear Cache and clear all cache tiers (template cache, content asset cache, and CDN edge cache if applicable). Stale cached responses from the test environment can cause checkout rendering issues on first live load.
Place a test order
Place a real order using a low-value live card. Confirm the payment method selection renders correctly, the authorization completes, and the order appears in Business Manager under Merchant Tools → Ordering → Orders.
Verify in Business Manager and VINR dashboard
Open the order in Business Manager and confirm the payment status is OPEN (authorized) or COMPLETED (captured, depending on your capture mode). Cross-reference the payment in VINR Dashboard → Payments — confirm the payment ID and amount match. Verify the webhook delivery log under Developers → Webhooks shows a successful payment.authorized or payment.completed delivery to your SFCC site.
Submit go-live request to Salesforce LINK team (if required)
If you intend to list your store on the Salesforce AppExchange or require Salesforce LINK certification for your deployment, submit a go-live request to the Salesforce LINK team through your Salesforce partner portal. Provide your VINR account manager contact details and your B2C Commerce instance URL. This step is only required for AppExchange listing — it is not required to accept live payments.
TroubleshootingAsk
Prop
Type
Next stepsAsk
WooCommerce plugin
Install and configure the VINR payment gateway plugin for WooCommerce on WordPress.
Tokenization
How VINR replaces raw card numbers with tokens to reduce PCI scope and enable one-click reuse.
In-person go live
Complete the go-live checklist before taking your first real card-present payment with VINR.
Last updated on
