Vii

Information about working with Cardigan's Vii integration.

Overview

Vii is available as a default provider option immediately on Cardigan installation.

Vii supports the full range of Cardigan functionality: provisioning new digital gift cards, balance checks, and redemption using a true authorize-and-capture flow where funds are held against the card during checkout and captured once the order is placed.

Setup

After installation, navigate to the "Profiles" section in your Cardigan settings and add a new "Vii" gift card provider.

Credentials

API Endpoint

The endpoint to connect to. Two options are available:

• Staging (stage.viicloud.com.au): use this for your staging environment and while validating your setup;
• Production (www.vii.com.au): use this once everything has been confirmed working.

Vii exposes a second endpoint for card ordering, which Cardigan sets automatically to match the environment you select - there's nothing extra to configure.

Store ID

Your Vii store identifier.

Username

Your Vii API username.

Password

Your Vii API password.

Configuration options

Source ID

The source identifier sent with requests to Vii, identifying Cardigan as the originating system.

Card BIN

The bank identification number prefix used for cards issued against this profile.

Default card design

The card design to use when provisioning newly purchased digital gift cards.

Refund card design

The card design to use when issuing a new gift card in response to a refund. This allows refund cards to be visually distinguished from purchased cards.

Refund behaviour

Select the desired behaviour when a refund is triggered against a gift card redemption transaction (either manually from the Shopify admin or via the Shopify API). Options include:

• Take no action, in which case Cardigan will ignore the refund;
• Issue new, in which case Cardigan will provision a new digital gift card for the refunded amount using the refund card design. Note that the new digital gift card will be issued back to the customer that placed the order being refunded -- this will likely be a different customer to the original purchaser;
• Refund to original, in which case Cardigan will return the funds to the original gift card used to pay for the order.

Usage

Once the Vii profile is set up and configured, you can add Cardigan's front end widgets to your store and test flows like balance lookups, purchases and redemptions.