iGivePay is a collection of solutions provided for handling payments using giftcards from iGive.
There are several types of flows supported:
- Customer Web Checkout
Intended for webshops that want to integrate payment with giftcards from iGive as a payment option in their checkout. Support requires integrating with iGivePay through API calls and redirecting users to a web interface where they provide details about their payment cards. - Point of Sale Web UI
Intended as a standalone solution with some or no integration with vendor POS systems. Payments are created through an API, but the rest of the flow for the payment is handled through a Web Interface provided by iGive. The provided user interface is intended to be used by the employees handling payment. - In-store mobile UI
Non-integration based solutions where giftcard owners scan specific QR codes provided to stores. The giftcard owners can initiate and perform the whole purchase through their own mobile device, and when finished they will get a reciept page with a control code the store can use to confirm the payment. The whole point of this solution is to provide support for giftcard payments without any integration towards iGivePay.
IGivePay is still under development and all documentation on this wiki is subject to be changed. We will strive to version pages containing any API information and also document changes to APIs when necessary. We are currently in the progress of stabilizing our APIs, and will
The flows will also not be all available at the same time, and documentation for the different flows might be more or less mature than the other flows.
¶ Customer Web Checkout
The webshop creates a payment request to iGivePay where key details like total amount and return address (upon completion) is provided as well as authentication headers used to identify the caller (api-key and api-secret). iGivePay responds with a Payment ID and an URL to the payment in iGivePay. The webshop will then have to redirect the user to this payment page in order to let the user enter their giftcard details. Using the initially provided return URL the user is redirected back to the webshop after they have completed (or cancelled) their iGivePay-payment.
Please also note that users may have giftcards not covering the complete order amount, so users may have paid only a part of the total sum when they get back to the store. It is the responsibility of the webshop to confirm payment status when the user is redirected back to the webshop. iGivePay provides API's which will return results of the payment.
For technical information on how to integrate the hosted payment solution follow the link to Hosted payment
¶ Point of Sale Web UI
Provides a web interface where employees can scan the customers gift cards and process them as the payment of the full order sum, or for partial payments. Integrations between iGivePay and the Point of Sale (POS) system are provided so that the POS-system and iGivePay can correlate the payments. The flow is typically:
- POS creates a new Payment by calling iGivePay API
- API responds with a Payment Identifier and a deeplink URL to where the payment can be performed
- POS system must open the deeplink URL in a browser window
- The cashier handles scanning gift cards and executes the gift card payment
- iGivePay will deduct money from the appropriate gift cards and store results
- Based on configuration in the original call to create the Payment, iGivePay can redirect the browser or call an API through a webhook, or the POS system can manually call the API and query the status of the payment.
Technical information about integrating with the Point of Sale Web UI can be found here.