2017.11.09

• Documentation updated to reflect consistency between the v1.5 fields table and the PHP examples provided. The corrections were made to the following pages:
  
  • Customer Import - Batch
  • Campaigns - List
  • Deactivated Campaigns - List

2014.03.05

• Various fixes to the documentation.

2013.06.13

• Added the an API call to be able to update a transaction that has already been recorded with based on up to three search criteria.

2013.06.12

• Added a <last_redemption> node to the output of the Customer Balance API call.
• Various performance tweaks and fixes.

2013.06.08

• Fixed an issue where under some conditions, batch transactions with the same card_number withing the same import data would result in duplicate customer entries.

2013.05.24

• Added a new API call: Users - Remove from Campaign, to batch-remove a list of users from having permissions to access a particular campaign.

2013.05.23

• Added a new API call: Users - Add to Campaign, to batch-add a list of users to have permissions to access a particular campaign.

2013.05.10

• Added a new API call: Dashboard - Info, to display key summary info about an account for custom interfaces.

2013.04.22

• Added an include_balances parameter to the Customer - Info API call to restrict the listing of the campaigns and their balances.

2013.04.05

• Fixed the issue where renaming the "Addt'l info" field for customers in the Customer - Field Update also renamed the account users' "Addt'l Info" field.

2013.03.26

• Added the XML nodes <master_campaign> and <two_tier_percentage> to the Account - Info API call return XML when the account is a two-tier account.

2013.03.20

• Fix to issue where under certain conditions, customer records were not being properly created during Transaction - Batch API calls for transactions without matching customers.

2013.03.11

• Added ability restrict by user_name the All Transactions report as well as be able to show the activation transactions.
• Removed the 32-character limit on Unique custom text fields.
• Fix to recently introduced bug where emails were being sent to the account owner when a new customer was created though the API call Customer - New even though the send_no_email parameter was passed.

2013.03.05

• Added a validity (date) range to promotions which affects the following API calls:.
  • Campaign - New Promo
  • Campaign - Update Promo
  • Campaign - List Promos

2013.03.03

• Added ability to request that a Customer - Balance & History API call for a coalition account returns all transactions across all campaigns.

2013.03.02

• Added the ability for promotions to have a custom "Promo ID" which affects the following API calls:
  • Campaign - New Promo
  • Campaign - Update Promo
  • Campaign - List Promos

2013.02.26

• Added functionality that allows the use of the RewardID (Campaign - Update Reward and Campaign - New Reward) field to specify a campaign and an amount to be accrued when that rewards is selected in the form campaign_id||amount. Ex: "1234567890123456||25.95"

2013.02.21

• Fixed minor issue where is some cases, when a customer was registered through the Customer - New API call with a "code" and without a "card_number", the pre-existing card number would be replaced by a blank value.

2013.02.21

• Fixed minor issue where is some cases, when a customer was registered through the Customer - New API call with a "code" and without a "card_number", the pre-existing card number would be replaced by a blank value.

2013.02.20

• Fixed issue XML error messages that had numeric nodes (and which caused parsing errors on some recipient's programs).
• Fixed issue with the Transaction - Batch import of BuyX redemptions that assumed the stated quantity of items redeemed would always be one.

2013.02.11

• Fixed issue with the "flooring" of point values for refunds which resulted in some cases in a negative (-1) balance.

2013.02.01

• Fixed issue with output of large numbers which would exhibit precision issues as well as exponential notation in some cases.

2013.01.30

• Fixed issue where a negative reward could be defined but caused an incorrect balance calculation.

2013.01.29

• Fixed issue where in some accounts, certain fields were not able to be part of the undo-data for customers when importing transactions which have customers that don't yet exist in the database.

2013.01.26

• Fixed issue with Gift Card ampaigns balances where the balance and the maximum amount that is allowed to be deducted might differ by one cent due to "computer math" issues with precision.

2013.01.25

• Fixed minor issue with the undo functionality of imports in the unusual case where some pre-existing records had a blank/null entry in a field marked Unique.

2013.01.10

• Fixed issue where users who created a new campaign did not see it in their Campaigns - List.results unless they had "all" permissions.

2012.11.30

• Added the campaing creation date-time stamp to the output of the Campaigns - List API call.

2012.11.27

• Added the card number to the email that is sent when a new customer registers through an API call / integration.

2012.11.15

• Minor fix to the historical results across several API calls where Gift Card (Stored Value) redemption (spend) transactions were being reported with a flag of either "off" or "N" instead of just "N".

2012.10.26

• Fix to the Customer - Search API Call where the functionality of setting the first custom field (custom_field_1 or "custom1") was not working properly.

2012.10.05

• Minor fix to the Campaign - Update API call for Visits/Events-based campaigns to address issue where in some cases, an update to the campaign settings was not fully processed.
• The User - Info API call now returns the actions and campaigns the user has permissions to access.

2012.09.28

• Added to the Customer - New API call:
  • Ability to force 16-digit customer code generation (UID) instead of using the card number as UID.
• Added to the Campaign - New and Campaign - Update API call:
  • API-only fields Latitude, Longitude, and Description fields for Geo-Fencing applications.

2012.09.25

• The Customer - Info API call now returns an XML node if the account is a coalition or two-tier.

2012.09.18

• Added a campaign ID restrictor to the Customer - Info API call.

2012.09.12

• Fix to very specific Customer - Find API call issue that was matching card numbers such as "11111" to others with leading zeros (ex: "00011111")

2012.09.08

• Added ability to specify an offset and limit to the Customer Balances API call.

2012.09.05

• Update to return the account creation date as part of the Account - Info API call..

2012.08.18

• Minor documentation clarification to the following API calls:
  • Customer Field - Create
  • Customer Field - Update
  • Transaction Field - Create
  • Transaction Field - Update
• In each case, the name of the custom fields parameters have been clarified.

2012.08.09

• The Customer - Info API call now correctly returns the coalition balance for campaigns that the customer does not "belong to" (ie: has no previous transactions in.)
• All the Reports now allow you to specify an invalide date (ex: June 31st or Feb 30th) and will instead use the closest previous date (ie: June 30th, Feb 29th/Feb 28th)

2012.07.17

• After much work and many delays, the points and currency depreciation and recurring fee functionality has been added! The new calls are:
   
  • Campaign - List Depreciations
  • Campaign - Add Depreciation
  • Campaign - Update Depreciation
  • Campaign - Delete Depreciation
     
  • Campaign - List Fees
  • Campaign - Add Fee
  • Campaign - Update Fee
  • Campaign - Delete Fee

2012.07.13

• Quick correction to the documentation in the Campaigns - List call, which had a <campaigns> node documented that was not being returned. Rather than fix the actual XML return which might break existing integrations, the documentation was adjusted to reflect actual output.

2012.06.21

• Two new API calls: Token - Get, and Token - Validate, which provide a unique, self-expiring time token that can be used to authenticate that a series of API calls is performed by a user within a given time frame.

2012.06.11

• The second part of this month's many upgrades and updates: 22 files changed. Over 2500 new lines of code.
  • Transactions - Batch has been upgraded to v1.5 and can now take custom additional fields as input.
  • Points campaigns Promotions can now be added to Transactions - Batch
  • Clarifications and changes to the "apply_ratio" parameter in Transactions - Batch
  • Transaction emails can now use Replacement Codes!
  • Separated permissions for API batches from Dashboard-based imports.
  • UTF-8 support for outgoing emails generated by the new v1.5 Transactions - Batch
  • Minor fix to the Customer Balances report Excel export where the column headers did not match the column data.

2012.06.01

• Large update! 35 changed files. Over 4000 lines of code changed. What for? To be able to export all those yummy custom additional fields (in both customers and transactions) as well as import/batch customers with the additional fields. Importing transactions with additional fields coming very soon! like asap! All this work however, changes only these few calls:
  • Customer - Batch – Upgraded to v1.5. Changes to some of the parameters
  • All Transactions Report – Now exports both transaction and customer additional fields.
  • Customer Balances – Now exports the customer additional fields
  • All Customers Report – You can now drop the campaign and dates and really get ALL customers. Also now exports the customer additional fields.
  • New Customers Report – Now exports the customer additional fields
  • Frequent Customers Report – Now exports the customer additional fields
  • Missing Customers Report – Now exports the customer additional fields
  • Birthdays Report – Now exports the customer additional fields
  • Custom Date Report – Now exports the customer additional fields
  • Customer Search Report – Now exports the customer additional fields

2012.05.18

• Update to fix issue where Customer - Find was not returning customers with no transactions in any campaign to those users making the call that had with permissions to all campaigns.

2012.05.15

• Fixed a misspelling in the documentation for Customer Search report: The "search_text" parameter had been misspelled as "search_test".

2012.05.14

• The User - Info API call has been updated to allow retreiving informaiton on other users within the same account -- if permissions allow -- and also includes the ability to supress the permissions XML section/node from being returned.

2012.05.07

• Several isoteric bugs have been fixed, related to the additional custom fields.
• The Campaigns - List Deactivated API call has been added.
• Fix to the issue where coalition Gift Card campaigns were not reporting coalition balances to allow redemption from a store a customer had not yet been to.

2012.04.07

• While we were working on coalition and two-tier bugs, we added the ability for a points or stored-value (giftcard) campaign to opt out of being part of the coalition or two-tier programs -- This should allow agencies that manage a coalition or two-tier account to offer their clients (merchants) the ability to have their own points or added-value campaigns. This has affected two API calls: Campaign - New Campaign and Campaign - Update Campaign.

2012.04.04

• There have been a lot of small updates -- mostly outlying bugs that affect unusual and specific scenarios.
• Of these, the most notable are::
  • The coalition account merchant lookup of a new customer to their store by a child card number stored in a list in one of the custom addtional fields. This now works as intended, as long as the card numbers are separated by spaces or commas.
  • Giftcard coalition reports now output without artifacts.

2012.02.09

• New Customer Fields - Add and Customer Fields - Update functionality: Custom fields can now be defined to set as "ID"s (searchable) -- Normally, all fields are searchable with the Customer - Find and Customer - Search API calls. This setting is different -- It applies only to certain situations, like coalition accounts, where the ability to pull up a customer record is limited by the user's permissions. This field allows to mark a field as being like an "ID" field in that a user can pull up this customer in a coaltion account even though the customer doesn't yet "belong" to that campaign. In non-coalition situations, this would enable the user of Master/Slave customer IDs that allow multiple customers (family, businesses) to earn in a single customer account.

2012.02.06

• Upgraded Campaigns - List Promos to v1.5: Now includes searching, ordering, and pagination.
• Upgraded Campaigns - List BuyX Items to v1.5: Now includes searching, ordering, and pagination.

2012.01.30

• Added the ability to define custom additional fields to customers and transactions. This has resulted in the following new API calls:
  • Customer Field - Create
  • Customer Fields - List
  • Customer Field - Update
  • Customer Field - Delete
  • Transaction Field - Create
  • Transaction Fields - List
  • Transaction Field - Update
  • Transaction Field - Delete
• and modifications to the following existing API calls:
  • Customer - New / Update
  • Customer - Info
  • Customer - Balance & History
  • Transaction - Record
  • Transaction - Redeem
• NOTE: Reporting, Exporting, and Importing (batch) of both customer and transactions do not yet work with the custom additional fields. This is being worked on right now, but by popular demand, we felt we could release the ability to defined and record custom additional fields as soon as possible.

2011.12.27

• Fix to the User - New API call that required campaigns to be listed as an array which caused some problems in some environments. Campaign IDs should now be passed as a comma-separated list, though the old way will still be accepted.

2011.12.11

• Fix to the User - New API call that prevented a new user to be created under certain conditions.

2011.12.07

• Update to the Reports - Audit Totals and Reports - Customers Balances API calls. BuyX-style campaigns were outputting incorrect XML, which has been corrected.

2011.11.17

• Initial release of API version 1.5 -- Mostly involves the addition of Enterprise API calls, which are accessible only to Enterprise-Level accounts. Please contact us for credentials to enter that section of the site. Previously existing Enterprise-level calls have been moved to the new section, and updated with new credentialization parameters. Existing integrations depending on those calls wil not be affected for now, but if the methods to access them have been deprecated.

2011.11.15

• Added an <earned> result to the Customer - Balance & History API call and an <earned> and <redeemed> result to the Customer - Info API call for Buy-X-Get-1-Free campaigns. More specfic explanations about these new results are found in the Notes sections of each API call.

2011.11.14

• Added to documentation the ability (that already existed) to use the "item_identifier" provided in the Campaign - New BuyX Item API call as the "service_product" in the Transactions - Record and Transactions Redeem API calls
• Added <glyph> to Customer - Info, Account - Info, Customer - Search, and Customer - Find results.
• Fixed the ability to skip setting an Earned Ratio (or set it equal to 0) through the API for Earn-per-Event campaigns in the Campaign - New calls. It should be 0.01 at least.
• Fixed the api returning blank campaign names in old style campaigns in the Customer - Info campaigns list.
• Fixed XML validation errors when BuyX Item contains "&" in their name by HTML encoding ampersands.

2011.10.28

• Multiple campaigns can now be specificed when recording a new customer in the Customer - New API call.
• Added a new API call: Customer - Generate Card # -- which results in a card number of a given length that is unique to the account.

2011.10.25

• The Campaign ID is no longer required in the Customer - New/Update API call.
• The Customers - Information API call now properly returns only the campaigns the customer belongs to and that user has access to, rather than all the campaigns the customer belongs to.

2011.10.20

• The Customer - Find, Customer - Search, Customer - Info, and Customer - Balance & History API calls now return the date of the last transaction in a campaign. (For Customer - Find and Customer - Search, when the "include_balances" parameter is set to 'Y')
• The User - Update API call has been updated to include a custom language flag, if needed, which is the returned in the User - Info, Users - List and other related API calls.

2011.10.15

• The User - Info and User - List API calls have been updated to include a permissions list.

2011.09.05

• A documentation error was corrected in the Users - List API call: location_restrice is supposed to be restrict_location.

2011.09.02

• The reporting API calls have changed slightly in their structure. The ID of the item is no longer the tag, but a subtag within. This way it does not violate one of the XML rules.

2011.09.01

• The User - List API call now has the ability to restrict the listing by the value in the custom field (referred to as the "location" in the Dashboard, and shows as the "user_addtl_info" tag in the XML list.)

2011.08.26

• Both the Transaction - Record and Transaction - Redeem API calls now return the transaction ID as part of the success XML receipt.

2011.08.19

• Implemented the Transactions - Delete API call.

2011.08.15

• There's a lot that's going on behind the scenes. We are working hard on a few new features but these are taking a bit longer than anticipated (what in software development doesn't!?)
• In the meantime, and by popular request, we have made the existing reports available to the API. We'll have a more robust reporting engine in the near future, but for now, these are the available reports:
  • Audit Reports
    • All Transactions Report
    • All Redeemed Transactions Report
    • Campaign Totals Report
    • Customer Balances Report
  • Marketing Reports
    • All Customers Report
    • New Customers Report
    • Frequent Customers Report
    • Missing Customers Report
    • Customer Birthdays Report
    • Custom Date Report
    • Customer Search Report

2011.06.10

• The Depreciation feature is out of Beta an is now available to everyone. Four new API calls have been implemented to support it:
  • Campaign - New Depreciation
  • Campaign - Update Depreciation
  • Campaign - List Depreciations
  • Campaign - Delete Depreciations
• Balances for campaigns that have depreciations defined are automatically calculated.

2011.06.02

• The Campaign - Update Campaign, Campaign - Update Reward, Campaign - Update Promotion, and Campaign - Update BuyX Item API calls have been implemented.

2011.06.01

• The Campaign - Delete Reward, Campaign - Delete Promotion, and Campaign - Delete BuyX Item API calls have been implemented.

2011.05.20

• The Customer - Search now has a parameter that allows you to sepcify if the search is to be an exact match and case-sensitive or not.

2011.05.18

• Updated the User validation for coalition and two-tier accounts: For those type of accounts a user's PIN must have a subset of matching permissions to the user (Manager, usually) that is making the validation call. This is address the issue that in those accounts, the campaigns are individual stores and random PIN entry could result in unwanted cross-store (campaign) login.
• Fixed a couple minor bugs on the User - Update API call:
  • The call now does not allow user PINs to have duplicates in the same account.
  • The call now does not require some parameters that were marked "optional".

2011.05.17

• Fixed a couple issues with the Customer - Search API call: The call now properly searches by customer_username, and the customer_username is also now properly returned in the search results.

2011.05.10

• We've been doing a lot of under-the-hood tweaking to prepare for the additional customer fields capability and the new reporting API. Mainly, the API code has been finally separated from the original web service code, resulting in lighter and faster loads for both. As a result, some API calls have been renamed to keep a more consistent naming convention, while the old names will still work for backward compatibility to existing applications and deployments. The affected / updated calls are:
  • Account - Update (renamed, and removed legacy requirements)
  • User - New (renamed, and removed legacy requirements)
  • User - Update (renamed, and removed legacy requirements)
  • Customer - Balance (renamed)
  • Customer - Find (renamed)

2011.05.05

• Added new "keep_which" parameter to the Card - Replace call in the case where a new_code matches an existing code (which must be unique) in order to select which customer data record to keep.

2011.04.16

• Added new API call: Campaign - New Reward.
• Added new API call: Campaign - New Promo.
• Added new API call: Campaign - New BuyX Item.

2011.04.15

• Added new API call: Campaign - New Campaign.
• Added new API call: Campaign - Deactivate.
• Added new API call: Campaign - Reactivate.
• Added new API call: Campaign - Delete.

2011.04.13

• Added new API call: User - Delete.
• Added new "check_override" parameter to Card - Replace call to allow "card_replace" call to be used to join two cards into one.

2011.04.12

• Added new API call: Customer - Delete.

2011.03.09

• Added new API call: User - Info.

2011.03.08

• Update to the two non-public API calls for user login and PIN validation: Removed restriction for only manager-level users to login via this API call. Instead, only Manager-level and above users can make the PIN validation API call. This is a subtle but important change as it allows users to be able to login to front-end apps without knowing their API keys, but allows only Manager-level and above users to retrieve other users' API keys.

2011.03.02

• New API call: Customer - Find.

2011.02.24

• Upon request, the API call: Account - Info is no longer restricted to Admin-level only users.

2011.02.21

• Added a new result parameter <registered> to the API call: Customer Info.

2011.02.17

• Added a two new API calls specific to Terminals and frontend applications:
  • A way for a user to login without prior knowledge of their API key.
  • A way for a user to login using only their PIN (requires prior login by manager-level user).
• These two calls are not public. Please contact us for details and documentation.

2011.02.04

• Added a new API call: Client Account Info.

2011.01.31

• Added to the Customer - Balance & History call the equivalent cash balance if for that campaign the spend-to-reward ratio exists.

2011.01.30

• Modified the Customer - Search call to search matches of the parameter(s) given if those parameters are PARTIAL matches rather than FULL matches. For example, a search for a customer called "John" will now also match a record with "Johnny".
• Added the ability in the Customer - Search call to search by <card_number>. With the modification above, you can now search for partial matches in the card_number field.
• Fixed a bug in the Customer Balance & History call where the cumulative balance on Buy X Get 1 Free campaign was omitted if the balance for that item was zero due to no transactions.

2011.01.27

• Added some more case-specific details to the Customer - New/Update API call notes.

2011.01.18

• Added Coalition and Two-Tier functionality to the application that is reflected on the API results. Transactions, individual and in batch, properly record to the apropriate campaigns, and balances and transaction details properly return coalition and two-tier data. Note: Coalition and Two-Tier account functionality can only be accessed with an Activation Code provided at an additional fee.

2011.01.04

• Added an additional field (send_no_email) to the Customer - New/Update API call:

2010.09.30

• Added some additional details to:
  • Customer - Balance & History: <agency> section
  • Transactions - Redeem: <campaign_type> element

2010.09.15

• Added some of the new API-only customer fields to the Card Replace API call.

2010.08.20

• New call: Customer - Batch
• Added receipt information to the Transaction - Record and Transaction - Redeem API calls

2010.08.15

• Restored the mysteriously vanished "auto_add" functionality to the Customer - New/Edit call.

2010.08.14

• Added available rewards to the Customer - Information API call for points, events, and buyX type of campaigns.

2010.08.13

• Added three customer fields for API purposes: customer_username, customer_password, and customer_PIN, which are additional parameters to the following calls: Customer - New/Update, Customer - Information, Customer - Search, and Customer - Validate API calls.
• Upgraded the Customer Validate call to validate customer_password and/or customer_PIN based on code, card_number, and/or customer_username.
• Added a user_PIN parameter to the User - New/Update API call.
• Added monetary_balance to point campaigns results for Customer - Info calls (If they have the Spend-to-Reward Ratio set in their points campaign preferences.)
• Added user_PIN to the results of a User - List call.

2010.08.08

• Added a customer_action ("new" or "edit") parameter to the New/Update Customer call in order to separate intentional updates to a customer's information from new customers with matching card numbers overwriting exiting customers. Not specifying this parameter defaults to "new". Please change any existing "update customer info" code to include this new parameter. No need to change existing "new customer" API calls.

2010.07.27

• Added a type_restrict parameter to the Campaigns List call in order to restrict the list of campaigns to the type(s) wanted.

2010.07.20

• Added a Users List call, which lists all authorized users of the account, their information, role level, and allowed campaigns.
• Added program ratios to the output of the Campaigns List call.

2010.07.07

• The Activate Account call now allows activation of trial accounts for those agencies that do not allow clients to automatically pass the 10-customer trial status.

2010.06.17

• The Customer Search call now allows no field to be passed, resulting in a list of all customers.
• The Customer Search call also now allows the customer balances to be returned with the customer info.
• Both Customer Search and Customer Info now return a cumulative balance for each campaign.

2010.06.10

• Clarification on the Overview page of the location of the API and the URL used to access it and some minor updates to the PHP cURL example on the page, making it a function that returns an XML object.

2010.06.09

• Correction: BuyX balance XML outputs corrected - tags with item names have been replaced with the properly parsed type tag pairs in Customer Information and Balance & History calls.

2010.06.01

• New call: Customer Search

2010.05.24

• Correction: Balance & History call XML output corrected - the <1></1> <2></2> ... transactions tags have been replace with the properly parsed <transaction></transaction> tag pair.

2010.05.21

• New call: Customer Information

2010.05.19

• New call: Card Replace
• "card_number_generate" field added to the API input for New/Update Customer call.

2010.05.17

New calls:

• Campaigns List
• Campaign Rewards
• Campaign Promotions
• BuyX Campaign Items List