FocusGift API: Activating Cards
The FocusGift API allows integrators to activate gift cards via the restaurant's website or the integrator's eCommerce gateway.
FocusGift Integrators must have valid FocusGift API Credentials before attempting to use the FocusGift API.
For assistance with becoming a registered FocusGift integrator, please contact Focus CA Client Ops at firstname.lastname@example.org.
FocusGift Activation Endpoint:
- Required Headers:
- FocusGift utilizes Basic Authentication
- Using your unique License Key & License Secret, concatenate the values separated by a colon (":") > Base64 Encode the concatenated value. Prepend the word "Basic" to the value. Use this as your Authorization header.
License Key: Your-License-Key
License Secret: Your-Super-Secret-License-Key
Authorization Header: Basic WW91ci1MaWNlbnNlLUtleTpZb3VyLVN1cGVyLVNlY3JldC1MaWNlbnNlLUtleQ==
JSON Post Body properties:
- The card number that you wish to activate
- If you have been provided with a StoreId to utilize throughout your integration, place the storeId here. If you have NOT been provided with a StoreId, you may omit this property.
- Reference number for your transaction. This value should be something that the Merchant can use to validate a transaction or match a transaction against your eCommerce Platform.
- The dollar amount that the guest wishes to activate on their gift card.
Sample Response (200 - successfull call):
"Message": "Account 4343434535345 activated successfully for 15"
Sample Response (Error 200 - card already exists):
"status": "Not Acceptable",
"message": "Gift card already exists."
Sample Response (Error 500 - invalid License Credentials):
"error": "License not found"
Please sign in to leave a comment.