Givex (Shift4)

Information about working with Cardigan's Givex (Shift4) integration.

Overview

Givex (acquired by Shift4) is available as a default provider option immediately on Cardigan installation.

Setup

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

Credentials

Your Givex API credentials will be provided to you by your Givex account manager, if you don't already have them. Typically, Givex will provide you with Beta environment credentials for your staging environment, and subsequently the appropriate production credentials once everything has been confirmed working.

As Cardigan has already been certified for use with Givex's APIs across a range of use cases, no fresh certification will typically be required.

Note that your Givex API user will need to have specific API methods enabled, depending on the piece of functionality you are using. These include:

994 Secure Balance: if using balance check or redemption flows;
920 Pre-Auth and 921 Post-Auth if using redemption flows;
956 E-Cert Order if using purchase flows or issuing refunds to a new card;
927 Merchadise Credit if issuing refunds back to the original card;
906 Activation if activating physical gift cards after purchase on Shopify POS.

API Endpoint

The endpoint to connect to - this will almost always be Beta (beta-dataconnect.givex.com) for a staging environment, and the appropriate data center for your production deployment.

User ID

Your Givex API user ID.

Password

Your Givex API password.

Configuration options

Default card face ID

Only required if you are supporting purchase flows, or are issuing new gift cards in response to gift card refunds. This specifies the gift card template Givex will use to send a provisioned gift card, and is also known as the CWS Item Ref.

Refund behaviour

Select the desired behaviour when a refund is triggered against a gift card redemption transaction (when 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. Note that you will need to have the 927 Merchandise Credit API method enabled on your Givex account for this to work.

Usage

Once the Givex 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. You will need to have test card numbers provided to you by Givex (or issue them yourself) to test the balance check and redemption flows.