Providers
SVS
Information about working with Cardigan's SVS (Stored Value Solutions) integration.
Overview
SVS is available as a default provider option immediately on Cardigan installation.
SVS supports balance checks and redemption using a true authorize-and-capture flow, where funds are held against the card during checkout and only captured once the order is placed.
Provisioning not supported
Provisioning of new cards through Cardigan is not currently supported for SVS.
This means SVS profiles can be used for balance checks and redemption, but not for selling new digital gift cards through your online store or Shopify POS.
Setup
After installation, navigate to the "Profiles" section in your Cardigan settings and add a new "SVS" gift card provider.
Credentials
Documentation in progress
This section still needs detail on how merchants obtain their SVS credentials, the relationship between the Certification and Production environments, and any provider-side prerequisites or certification process.
If you're setting up SVS and need help in the meantime, please contact support.
API Endpoint
The endpoint to connect to. Two options are available:
- Certification (
svc-cert.storedvalue.com): use this for your staging environment and while validating your setup; - Production (
svc.storedvalue.com): use this once everything has been confirmed working.
Cardigan sets the matching authentication endpoint for you when you choose an API endpoint, so there's nothing extra to configure.
User ID
Your SVS API user ID.
Password
Your SVS API password.
Auth ID
The authentication identifier supplied alongside your API credentials.
Root key
The root key used to sign requests to SVS.
Configuration options
Merchant ID
Your SVS merchant identifier.
Store number
The store number to send with requests. This identifies the originating store in SVS reporting.
Currency
The currency that cards issued against this profile are denominated in.
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. 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.
As provisioning of new cards isn't supported for SVS, "Issue new" is not a usable option on this provider - we recommend either taking no action or refunding to the original card.
Usage
Once the SVS profile is set up and configured, you can add Cardigan's front end widgets to your store and test flows like balance lookups and redemptions.
Documentation in progress
This section still needs detail on where test cards come from for the Certification environment.