Givex Gift Cards Guide
This guide details how to setup and use the Givex Gift Card additional payment method.
Introduction
The Givex Gift Card integration integrates with Aurora's multi-payment architecture to allow one or more gift cards to be used to pay for orders in a standalone capacity or in conjunction with a supported primary payment method.
Please see our Payment Providers guide for more details about which primary payment integrations support multi-payment.
Getting Started
First, you must set Givex Gift Cards as an Accepted Additional Payment Provider here:
Store > Settings > Payment Providers > Accepted Additional Payment Providers
Then proceed to enter your Givex account details within the Givex Gift Cards integration settings here:
Store > Settings > Payment Providers > Givex Gift Cards
Once this is complete, see Certification Testing and Order Placement.
Integration Settings
| Field Name | Description | Default |
|---|---|---|
| Enabled? | When selected, the Givex Gift Cards integration can be used. | No |
| Live? | When selected, the live Givex API details will be used. When not selected, the integration is in test mode and the test Givex API details will be used. | No |
| Live | ||
| Live Primary Endpoint | Determines the live primary Givex API endpoint. | |
| Live Secondary Endpoint | Determines the live secondary Givex API endpoint, used when the primary endpoint cannot be contacted. | |
| Live User ID | Determines the user ID used when sending requests to the live Givex API endpoints. | |
| Live Password | Determines the password used when sending requests to the live Givex API endpoints. | |
| Test | ||
| Test Primary Endpoint | Determines the test primary Givex API endpoint. | |
| Test Secondary Endpoint | Determines the test secondary Givex API endpoint, used when the primary endpoint cannot be contacted. | |
| Test User ID | Determines the user ID used when sending requests to the test Givex API endpoints. | |
| Test Password | Determines the password used when sending requests to the test Givex API endpoints. | |
| Logging | ||
| Log Requests? | Determines if API requests are logged within: Store > Logs > API Integration Log | No |
Certification Testing
Aurora provides a user interface to facilitate Givex Acceptance/Certification Testing which allows you to send requests to the Givex API and report the results back to Givex for validation.
Please coordinate with your Givex account coordinator for instructions on how to complete certification testing.
This interface is not designed to be used for arbitrary operations and should not be used with live card details.
All operations performed using the Certification Testing interface will only be recorded within the API Integration Log if Givex Logging is enabled. Absolutely no transactional records are maintained and all operations executed using this tool will not be attributed to any order.
Order Placement
You can use the Aurora New Order interface to place orders using Givex Gift Cards immediately after you have completed the integration settings, however in order to support gift cards within your checkout, you will need to instruct your template developers / agency to modify your checkout template accordingly.
Please see Multi-payment Templates (including Gift Cards) for more details.
Refunds
When using Givex Gift Cards in a multi-payment capacity, order level refunds are attributed according to a specific strategy.
Please see Automatic and Multi Payment Refunds for more details.
Updated over 2 years ago