Changelog - Updated: 2/7/2023

  1. Deprecated Functionality
  2. Version 9.1.3 Maintenance Release - Sandbox: 2/7/2023, Production: 3/14/2023
  3. Version 9.1.2 Maintenance Release - Sandbox: 11/15/2022, Production: 1/17/2023
  4. Version 8.2.10 Maintenance Release - Sandbox: 9/27/2022, Production: 10/11/2022
  5. Version 8.2.9 Maintenance Release - Sandbox: 8/23/2022, Production: 9/13/2022
  6. Version 8.2.8 Maintenance Release - Sandbox: 7/12/2022, Production: 7/26/2022
  7. Version 8.2.7 Maintenance Release - Sandbox: 6/21/2022, Production: 7/05/2022
  8. Version 8.2.6 Maintenance Release - Sandbox: 5/17/2022, Production: 6/07/2022
  9. Version 8.2.5 Rolled Into 8.2.6
  10. Version 8.2.4 Maintenance Release - Sandbox: 1/25/2022, Production: 2/24/2022
  11. Version 8.2.3 Maintenance Release - Sandbox: 11/16/2021, Production: 12/06/2021
  12. Version 8.2.2 Rolled Into 8.2.3
  13. Version 8.2.1 Maintenance Release - Sandbox: 10/28/2021, Production: 11/11/2021
  14. Version 8.2 Release - Sandbox: 8/31/2021, Production: 9/16/2021
  15. Version 8.1 Release - Sandbox: 7/16/2020, Production: 8/11/2020
  16. Version 7.2 April Maintenance Release - Sandbox: 4/7/2020, Production: 4/28/2020
  17. Version 7.2 Release - Sandbox: 1/28/2020, Production: 3/17/2020
  18. Version 7.1 December Maintenance Release - Sandbox: 11/26/2019, Production: 12/17/2019
  19. Version 7.1 September Maintenance Release - Sandbox: 9/10/2019, Production: 9/17/2019
  20. Version 7.1 July Maintenance Release - Sandbox: 7/9/2019, Production: 7/16/2019
  21. Version 7.1 June Maintenance Release - Sandbox: 6/11/2019, Production: 6/25/2019
  22. Version 7.1
  23. Version 6.3
  24. Version 5.3
  25. Version 5.2
  26. Version 5.1

Deprecated Functionality

Feature Description Action Announced
Onboarding Response Codes Have Changed In an effort to standardize API response codes across all API endpoints and to abstract onboarding API users from the idiosyncrasies of various bank networks the following response codes have changed:

Old Response Code New Response Code
A A01 (Approved)
W A02 (Approved with warnings)
P A11 (Pending)
R A12 (In Review)
J X01 (Rejected)
D D01 (Declined)
C D02 (Needs Correction)
F D03 (Failed)
E D04 (Processor Error)
X D19 (Unmapped Decline)
This change is not backwards compatible. It is recommended that integrators support both response codes formats and have their systems ready for this cut-over on June 30th 2021. Changes will be made available in Sandbox on 3/23/2021 for test. Independent Change
Names of the returns files are changed To improve the consistency of naming conventions several files used in the batch specification underwent renaming. Starting with the 7.1 release, the name of a file which designates its category is placed before an extension of the file. For example returns.20170919.2000.zip will be renamed to 20170919.2000.returns.zip by July 1st 2018 make sure that you have made necessary changes in the code to use new names of the returns files instead of the old ones. 7.1 release
Get Parameters operation is deprecated Traditionally terminal parameters could be received via both get-parameters and get-configuration API operations. Starting with 6.3 release the get-parameters API call will deprecated and will no longer be supported. Terminal parameters can now be received via the get-configuration API call only. by July 1st 2018 make sure that you make the necessary changes in your code to retrieve terminal parameters via the get-configuration operation. 7.1 release
Get Parameters operation is deprecated Traditionally terminal parameters could be received via both get-parameters and get-configuration API operations. Starting with 6.3 release the get-parameters API call will deprecated and will no longer be supported. Terminal parameters can now be received via the get-configuration API call only. by July 1st 2018 make sure that you make the necessary changes in your code to retrieve terminal parameters via the get-configuration operation. 7.1 release
File Status and File Download operations are deprecated Previously, files could be downloaded and their statuses could be retrieved via both API and the user interface. Starting with the 7.1 release the file-status and file-download operations will be deprecated and are no longer supported. Files can now be accessed via the user interface or database only. : by October 1st 2018 make sure that you make necessary changes in the code to disallow usage of the file-status and file-download operations. 7.1 release
Response codes size is extended from 3 to 5 characters Traditionally the responseCode field consisted of 3 characters. As part of the response codes reorganization, starting with the 6.2 release the size of the responseCode field was extended from 3 to 5 characters where the fourth character is going to include a suffix indicating the source of an error and the fifth is reserved for future use. by April 1st 2018, make sure you have extended the size of the responseCode field to 5 characters to be able to accept new format of the response codes introduced in 6.2. 6.2 release
Legacy field names are deprecated For consistency with the user interface some of the API field names - such as referenceNumber, merchantAccountCode, terminalCode, etc - have been renamed. Old field names have been deprecated and will only be supported through 2018. Click here for a list of the deprecated fields and their new names. By the end of 2018 make sure you have adopted the new naming conventions. 6.2 release
Support for GET request in UniCharge API is deprecated Traditionally, all processing API requests in the production environment could be submitted via GET and POST requests. However, the ability to submit GET requests was still supported as it could be used in the test environment. Starting with the 7.1 UniPay release, GET request is deprecated and is no longer supported. By April 1st 2018 all requests of the processing API regardless of the environment are required to be submitted via method POST request. 6.3 release
Distributions logic is replaced with split payments Previously, if there was a need to distribute merchant funds between several recipients, the funds distribution mechanism was used. It allowed a user to set a certain distribution schema that is used for automatic allocation of funds between merchant/reseller/vendor/holding accounts that took part in transaction processing. However, this mechanism did not allow to specify the distribution amount at transaction level.
In the 6.2 UniPay release, split payments mechanism, which allows to configure funds distribution schema for an individual transaction, was introduced. Starting with the 6.3 UniPay release, distributions logic is deprecated and no longer supported.
by April 1st 2018 make sure that you make necessary changes in your code to use the split payments mechanism instead of the distributions logic. 6.3 release
transactionCode in capture and originalTransactionCode in void requests are deprecated Traditionally reference to a transaction that was going to be voided or captured had to be submitted when executing void and capture operations. For cases when an internal gateway-generated identifier was used and submitted via the referenceNumber field (now called transactionId). For cases when an external submitter-generated identifier was used and submitted via the originalTransactionCode field for void operation and via the transactionCode field for capture operation. For field usage unification, starting with the 6.3 release, both internal and external transaction identifiers are submitted via the transactionId field (formerly called referenceNumber) for both void and capture operations. An internal identifier is submitted as it is, while an external identifier should be preceded by an asterisk (*). Starting with 7.1 release, the originalTransactionId field is deprecated and is no longer supported. by April 1st 2018 make sure that you made necessary changes in the code to use the transactionId field in void and capture operations instead of the originalTransactionCode and transactionCode fields respectively. Be advised that in future releases transactionCode field in capture operation will be repurposed. 6.3 - 7.1 release
Export operation is deprecated Previously transactions could be exported via both export API call and the user interface. Starting with 6.3 this operation will be replaced by the new reporting API where the Transaction Export report is available. Additionally, transaction information can be exported via the Transaction Export report on the user interface. by July 1st 2018 make sure that you make necessary changes in the code to disallow usage of the export operation. 6.2 release

Version 9.1.3: (Sandbox: 2/7/2022, Production: 3/14/2023)

Billing API

  • Voiding transactions(403776)
    There was an issue causing transactions run via the billing API to not void properly. This has been fixed.
  • Invalid JSON response format(710808)
    When an unrecognized field was submitted to the billing API, the response JSON would be in an invalid format. The responses have been fixed to have a proper JSON format.

Transaction API

  • Duplicate Convenience Fees(853192)
    There was an issue calculating the convenience fees when running a sale-auth request followed by a capture request. This has been fixed to no longer duplicate the fee.

Statements

  • Merchant Statement and Deposit List(860890)
    The merchant-statement-list and the deposit-list calls now work with either the account ID (EX: 4550001) or the merchant ID (EX: 4550000).
  • Decline/Return Details(495024)
    Merchant statements will now contain details about returns, declines, chargebacks and reversals.

Version 9.1.2: (Sandbox: 11/15/2022, Production: 1/17/2023)

Merchant Console

  • Copy/Paste Issues(571356)
    When pasting values from your clipboard, the value no longer duplicates.
  • Downloading Statements(357441)
    When statements are being downloaded from the console, a pop-up will display indicating that the system is loading the statement.

Billing API

  • paymentOption~modify(582050)
    The ~modify was occasionally receiving an error when attempting to set a payment option to active status. This has been fixed.
  • Unique Payment Option(136910)
    Payment Methods have been adjusted to allow creation of an additional payment method with the same card number if the original payment method is set to inactive status.
  • Payment Options - Routing Number(975756)
    The routing number is now modifiable on payment options.
  • Payment Options - Token Creation(375537)
    Existing Tokens can now be used in the creation of a new payment option.
  • Next Billing Date(941151/289777)
    The nextBillingDate parameter has been adjusted to allow any date in the future of the subscription as the nextBillingDate.
  • Billing Cycle - Bi-Weekly(536060)
    The billingCycleType parameter has been adjusted to allow Bi-Weekly cycle types. This is indicated by setting billingCycleType to B, and means that the subscription will be charged every two weeks.
  • Cancelling Subscriptions - Effective Date(431004)
    The effectiveDate parameter has been adjusted to allow up to one year in advance for all cycles except annual, and two years in advance for annual cycles.
  • Transaction~process(572304)
    The ~process call has been adjusted to require unique values in the code parameter in order to process transactions.
  • Invoicing Description(--)
    The description given to a claim was incorrect if there was two invoices that were being billed at the same time. This has been corrected and now will show "Multiple Dues" if this is the case.

Statements

  • Transaction List(714910)
    The transaction~list call has been adjusted to include the transaction.references.userCode and transaction.references.voidUserCode fields.
  • Statement Period(161159)
    The statement period location has been moved to the statement page footer.
  • Transaction Summary by Day(--)
    A new API request for a transaction summary by day to the API list. Refer to Transaction Summary by Day.

Charges

  • Effective Date(679185)
    The effectiveDate parameter is now being prioritized correctly, and will deposit to charges with the earliest effectiveDate first.

Hosted Payment Pages

  • postNotifyURL(--)
    Hosted Payment Pages now properly send responses to the postNotifyURL parameter.

Version 8.2.10: (Sandbox: 9/27/2022, Production: 10/11/2022)

Merchant Console

  • Search - Cancel Button(988807)
    When attempting to search on the admin console, clicking 'Cancel' had the same effect as clicking 'OK', therefore executing the search. This condition has been fixed.
  • Processing Refunds Error Message(545359)
    The error message shown when attempting to process a refund with an incorrect settlement type now correctly displays the cause of the error.
  • Processing Partial Refunds(613309)
    Partial refunds were not able to be issued multiple times on the merchant console, but were able to be issued multiple times on the admin console. This behavior has been changed to allow multiple partial refunds on the merchant console.
  • Downloading Receipts(354150)
    Receipt PDFs have been update for better clarity.

Billing API

  • S20 error - Create and Modify(--)
    The ~create and ~modify functions were occasionally receiving an S20 error message. This has been fixed.

Statements

  • Deposit Statement Emails(604048)
    The body of deposit statement emails has been adjusted for clarity.
  • Monthly Statements(650624)
    Fixed monthly statements to include records based on deposit date instead of transaction date.

Version 8.2.9: (Sandbox: 8/23/2022, Production: 9/13/2022)

Merchant Console

  • Multiple Merchant Access(582048)
    Merchant level portal user can now be associated with multiple merchant accounts.
  • Creating Payment Plans Error(896887)
    When creating subscriptions users would sometimes encounter the error "System error. Contact support.". This error condition has been fixed.
  • Receipt Downloads(409407)
    Unifying receipt PDF formats to match transactions.

Onboarding API

  • Apostrophe - Business Description(869691)
    The Onboarding API will now allow apostrophes to be used in the business description field.
  • Driver's License Field Deprecated(--)
    Driver's Licenses are no longer required for compliance purposes, therefore we are deprecating the use of them going forward in the Onboarding process.

Payment Pages

  • Hosted Payment Page Error(631304)
    Customers of integrators that utilize Hosted Payment Pages would sometimes be stuck in a loop with the error "invalid account number". This error condition has been fixed.

Version 8.2.8: (Sandbox: 7/12/2022, Production: 7/26/2022)

Merchant Console

  • Receipt Downloads(509686)
    This feature will allow you to download receipts from the merchant console for a transaction at any time.

Recurring Billing API

  • Billing Notes(200109)
    Billing Notes on Annual Subscriptions will now properly reflect as annual in the Billing Notes section.
  • Charges Effective Date(679185)
    Charges applied to an account will now properly take precedence by way of the effectiveDate parameter, not the upload order.

Reporting API

  • Deposit List(442950)
    The deposit-list call in the Reporting API will properly reflect the exact dates shown.

Statements

  • Statement Download Error(223839)
    Fixed an error encountered when downloading statements on an account that changed their pricing cycle in the same month as the statement being downloaded. Now you can download the statements without any issues.
  • Statement Amounts(866129)
    Fixed an issue where some statements were not reflecting the correct amount when downloaded from the merchant console. Amounts have been fixed to properly reflect the correct amounts.

Version 8.2.7: (Sandbox: 6/21/2022, Production: 7/05/2022)

Merchant Console

  • Auth Limit Response Code(284033)
    A new response code has been added to specify when an account's authorization limit has been reached. This code is D50 and states 'Authorization limit is reached for the day' which is a soft decline type.

Onboarding API

  • Character Support – Ampersand(114888)
    The ampersand & character is now supported by the business.businessName in the onboarding API.

Statements

  • Fees Void Description(966615)
    Statements have a fixed description for feeds in the voids section. It will state 'Card Brand (Realtime voids)' instead of '(Realtime Sale)'.

Version 8.2.6: (Sandbox: 5/17/2022, Production: 6/07/2022)

Batch Transactions

  • Batch close without batch ID(167884)
    In some instances, the system would attempt to close batches that have not been assigned a batch ID. The system has been corrected to only close batches that have been assigned a batch ID.

Billing API

  • Invalid error when modifying nextBillingDate(236486)
    Some users would receive an invalid error (System Error. Contact Support) when attempting to modify the nextBillingDate on a subscription. The system now returns the correct error under the correct circumstances.
  • Invalid nextInvoicingDate Calculation(931687/999138)
    Under specific circumstances the value of the nextInvoicingDate would be calculated incorrectly. The system now returns the correct nextInvoicingDate.
  • Billing failure for deferred subscriptions(378930)
    In some instances, deferred subscriptions (frozen/paused) would fail to bill at the end of the deferment. The system now processes the queued deferment event correctly.

Merchant Console

  • Unable to set user permissions(817916/754550)
    Administrators on merchant accounts were unable to change the rights level for other users associated with the merchant. Administrators can now set any user to any of the available rights levels in the merchant console.
  • Unable to leave swipe mode in VT(505486)
    When using the virtual terminal users could not exit the swipe mode when using the VT in conjunction with a reader. Swipe mode can now be exited before or after user input.

Onboarding API

  • Character Support – Apostrophe(114888)
    The apostrophe character is now supported by the business.legalName and deposit.holderName parameters in the onboarding API.

Statements

  • Statement Transaction List (549200)
    Statements will now allow up to 200 transactions for display in the transaction section of the statement. For lists of transactions greater than 200 for a specific statement period a merchant can view the full transaction list in the merchant console.

Version 8.2.4: (Sandbox: 01/25/2022, Production: 2/24/2022)

Statements

  • Statement Attachments
    Under some circumstances statement emails would go out without the statement attachment.(659620)

Transaction API

  • Realtime Bank Account Verification
    Transaction API users can now validate bank account numbers prior to processing ACH transactions. See isVerificationEnabled parameter in the Charge (Sale) request for more details. (714458)
  • JSON Support for Tokenization
    The tokenization API call now support JSON format in request/response(152813)

Billing API

  • New Field: firstInvoicingDate
    new field has been added to the subscription object return that indicates the first time an invoice will be generated related to a customer’s subscription. This new field takes into account subscriptions that were frozen before the first billing for the given subscription.(342200)
  • Card Not Unique Error
    Some users of the Billing API would occasionally receive an error indicating the provided credit card data was not unique within the customer scope when the card was in fact unique.(358696)

Onboarding API

  • Additional Character Support
    Onboarding API and related onboarding forms now support the following additional characters. business.businessName (apostrophe) deposit.holderName (ampersand, comma)(114888)

Merchant Console

  • New User Link Expiration
    New user confirmation link timeout is now a separate setting. Links will also now automatically regenerate. (289061)
  • View Subscription Error
    Some users were experiencing issues when attempting to view subscriptions in the context of a customer. Users would receive an S20 UI error.(995715)
  • Deposit Data Duplication
    In some instances the deposit data screen would duplicate table rows.(857423)
  • Password Reset Error
    Some users experience a ‘value is missing’ error when resetting a user’s password in the Merchant UI.(336350)

Administration Portal

  • Approve Multiple Batch Files
    The administration UI now gives the user the ability to approve multiple batch files at the same time.(798063)
  • View Batch Details Error
    Some users were experiencing issues when attempting to view batch details in the administration UI. Users would receive an S20 UI error.(798063)

Version 8.2.3: (Sandbox: 11/16/2021, Production: 12/06/2021)

Onboarding API

  • Merchant Application Parking
    Merchant Applications (onboarding) can now be sent to Zift and held for later underwriting.(881679)

Tokenization

  • Tokenization JSON request/response
    The tokenization request now supports JSON formatting in the request and response.(152813)

Billing

  • Future Invoice Allocations
    Future invoices that are reversed will no longer affec the customer's balance or create allocation records.(970705)
  • Modify Expired paymentOptions
    PaymentOptions with an expired credit card can now be edited.(786424)
  • Failed Invoice Creation
    Fixed automated billing issues that resulted in a failure to generate invoices under specific conditions. (298988)

Transaction

  • Cost Plus Calculations
    Fixed issues related to cost plus calculations.(313780)
  • Processor Response Code Mapping
    Processor response codes EA, EB, EC are now mapped to D05.(586841)

Version 8.2.1: (Sandbox: 10/28/2021, Production: 11/11/2021)

Onboarding API

  • Proxy Onboarding
    Proxy is now supported for Onboarding API calls.(881679)
  • business.ownershipStructureType Validation
    business structure SP will only allow officer.(701537)
  • business.registrationCountryCode Validation
    business.registrationCountryCode is requried if values for business.registrationState and business.registrationYear are presented to the onboarding API.(778206)
  • Ownership Total Validation
    100% ownership allocation validation has been removed.(701537)

Transaction

  • Manually Enterrerd Returns
    Under some circumstances manually entered returns or chargeback did not show up in the merchant's transaction list.(866055)

Merchant Console

  • Password Reset on Next Login
    0Forced password reset on next login is now supported in the new merchant portal.(912524)
  • Transaction: Refund
    Ability to refund transactions from batch uploads has been returned to the merchant portal UI.(516428)
  • Adding paymentOptions (general)
    Under specific circumstances users could not add payment options to customers in the merchant portal UI.(397901)
  • Adding paymentOptions (exp date)
    In some cases the merchant portal would not accept specific expiration date sequences.(205795)

Version 8.2: (Sandbox: 8/31/2021, Production: 9/16/2021)

Onboarding API

  • Manual Onboarding
    Using a specified onboarding profile ID you can now stub a merchant application for manual onboarding review.
  • Phone Field Validation
    Fixed phone number validation on the UI to allow from 10 digits up to 15 digits.
  • Response Codes
    Response codes for the onboarding API endpoint have been updated to provides consistency amongst all Zift API endpoints. See Deprecated Functionality for details.
  • Owner/Officer Fields Validation
    When onboarding a Sole Proprietorship the owner.1 fields are no longer required if the owner information is passed in the officer fields.

Processing

  • Test Ranges
    Addressed issues with test ranges and related API responses in the sandbox area. Test ranges do not apply to production
  • Partial Void
    Addressed errors related to partial void of unsettled transactions.

Billing API

  • Allocation~find
    You can now search the billing API (allocation~find) to find associated allocation records related to a specified invoice.
  • Billing API response code/messages
    Descriptions for the following response codes (V21, V22, F21, F22, V32, V35, L01, S29) have been moved from failureCode/failureMessage to responseCode/responseMessage. As if 8.2m failureCode/failureMessage are deprecated and will be removed 1 year after the 8.2 platform release (approximately 9/1/2022).
  • customer~create - Customer Phone Required
    Customer phone number is now required when creating a new customer. Previously this information was optional.

Customers

  • Multiple Merchant Account Association
    Customers can now have a one-to-many relationship to multiple merchant accounts.

Reports and Statements

  • 1099 Data Reporting
    New 1099 built in report that shows information for credit/debit transactions
  • Dispute Visibility
    Disputes are now displayed in a separate row in the Returns/Chargebacks Summary section of the chargeback report.
  • True Deposit Date
    Where possible deposit date has been adjusted to reflect feedback from the banking network. Otherwise the deposit date will continue to be calculated based on the statement cycle.

Reporting API

  • Transaction List
    Added a new parameter, "reportBasis," in the "transaction-list" Reporting API request. This parameter allows specifying the date range of which the data will be selected - Settlement Date or Authorization Date.
  • Transaction List
    Parameter "transaction.references.originCode" added to "transaction-list" response.
  • Transaction List
    The data separator in the 'type' parameter for the transaction-list API request has been changed from comma (,) to the pipe (|). Note: There is no deprecation or grace period for this change.

Administrative Portal

  • Response Transaction Date
    Previously the transaction date for chargeback, return, reversal, decline, notice, reject transactions used the original transaction as the response transaction date. Response transactions like chargeback, return, reversal, decline, notice, reject transactions will now display the date the transaction is received by the Zift system.
  • Iconography Update
    Updated various icon in the administrative and merchant portal UI
  • Related Transaction (ACH)
    Administration UI now allows you to search for related ACH transactions

Merchant Console

  • Customer Billing Information
    Billing information on a customer record is now optional. Previously this information was required.
  • Customer Phone Required
    Customer phone number is now required when creating a new customer. Previously this information was optional.
  • Fee Calculation
    Addressed invalid fee calculations in the merchant console UI.
  • Transaction Export
    Addressed issue with terminal related transaction on the transaction export in the merchant portal.
  • Removed Address Requirement
    Address requirements for running payments in the merchant portal has been removed.
  • Postal/Zift Code Display
    Addressed display issues in the merchant portal related to postal/Zip Codes.
  • Transaction Export Filter
    Addressed issues with the transaction export filter.
  • Transaction Export Record Limit
    Address issue with truncation of export results when saving results to a file.
  • PaymentOption Creation
    Addressed intermittent errors that manifested when saving payment options.

Terminals

  • Sunmi Terminal Receipts
    Addressed intermittent receipt printing on supported Sunmi Terminals

Version 8.1 August Release (Sandbox: 7/16/2020, Production: 8/11/2020)


  • Onboarding - ApplicationCode Field
    Enhanced the Onboarding Wizard UI form by adding an "application code" field as an alternative ID of the application used for editing the information. Additionally, an option to search for an application by its "code" was added to the Application Search form. Previously, the "application code" parameter was submitted through API with no possibility to choose it on the user interface.
  • Onboarding - Default Value: desposit.accountType
    Set "deposit.accountType=C" as default in the onboarding API create request. Please refer to the Supported Operation section of the Onboarding API specification for more details.
  • Onboarding - Onboarding Agreements
    Enhanced the Agreement form by making it read-only for cases when the agreement was approved by a merchant and is marked as used on the user interface.
  • Onboarding - Hosted Pages URL
    Enhanced the Onboarding section of the Branding Profile UI form by adding a possibility to specify a separate URL for the onboarding pages. The indicated URL will be populated on browser line when opening the onboarding pages.
  • Processing API - Enhanced API Validation
    Depending on your processing configuration authorizations can be extended up to 30 days.
  • Processing API - Enhanced Find Operation
    Added new parameters "batchId" and "settlementDate" in Find Response Processing API to get more settlement information of a transaction processed.
  • Processing - Extended Authorization Period
    Depending on your processing configuration authorizations can be extended up to 30 days.
  • Processing - New Response Code
    Added a new response code "229 - Illegal Transaction" for the cards-batch integration. The new code maps to the " D01 - Denied by customer's bank" response code.
  • Processing - HPP Adobe DTM Analytics Support
    Added support for Adobe Dynamic Tag Management tool allowing for working with marketing tags. Now, the HPP logic is able to make the content of the "name.js" file embedded if the html file includes "" tags. The file will be placed in the merchant local folder on the server, or under the default merchant.
  • Processing - HPP CORS Header Support
    Added support of the CORS Access-Control-Allow-Origin header for processing through hosted payment pages.
  • Reporting API - Transaction List
    The original transaction ID and Code are now returning as required fields for refund transactions in transaction list reporting API.
  • Terminals - Sunmi Terminal Support
    Implemented a new logic allowing a user to work with a new type of terminals based on OS Android - Sunmi. The terminal models support the standalone mode and the managed mode, provided that the POS client is installed directly on the terminal.
  • Terminals - Terminal Audit
    Enhanced the Audit perspective by adding an option to search for changes associated with terminals and terminal parameters.
  • Terminals - Terminal Cloud CAD Processing Support
    Added support of the CAD currency in realtime and batch processing profiles used for Cloud integration.
  • Terminals - USB Card Readers
    Added support for converting the track data retrieved from the USB card readers from the hexadecimal format into ASCII format.
  • API Localization
    Added the ability to internalize response messages in realtime responses. A new optional field "languageCode" was added in all processing API realtime requests to specify a language in which API response message will be returned.
  • Portal UI - User Session Expiration
    Enhanced the logic by adding an option to extend the session for a human user through the pop-up window on the client console.
  • Portal UI - Chargebacks and Reversals
    Enhanced the Transaction List form by adding new actions for chargeback and reversal transaction types.
  • Portal UI - Password Reset Message
    Adjusted the password recovery logic by adding a generic error message when a user enters a valid or invalid username.
  • Onboarding - Routing Number Exception
    Fixed an issue with a validation error returning when an invalid routing number was submitted in the onboarding API.
  • Billing API - Date Format
    Unified date format for management API and billing API responses to be "yyyy-MM-dd HH:mm:ss" in XURL, XML, JSON formats.
  • Billing API - Customer Code Validation
    Added validation for a "Code" value for cases when a new customer is created via billing API. Now, when creating a new customer with the Code value already existing in the system, a response code V35 with a message "Identifier of the referenced [ReferenceName] is not unique" is returned.
  • Terminal API - Holder Name Formatting
    Fixed an issue with a validation error returning when an "&" symbol was transmitted within the "holderName" field in the terminal API.
  • Terminal Management Service - Terminal Deactivation
    Implemented a new logic for terminal units to become automatically inactive when the associated Merchant Account is deactivated.

Version 7.2 (Sandbox: 12/28/2020, Production: 3/17/2020)


  • General (UI) - Terminal Migration
    Implemented the logic of terminal migration from one merchant account to another merchant account.
  • General (UI) - Bulk Terminal Parameters Modification
    Extended the filtering mechanism allowing users to modify terminal parameters in bulk.
  • General (UI) - Customer Documents Download
    Added ability to download documents associated with a customer.
  • General (UI) - Country and State Address Fields
    Enhanced country and state address representation on the user interface.
  • General (UI) - Date Format
    Unified the date format on all UI forms.
  • General (UI) - Merchant List Enhancements
    Enhanced the UI Merchant List form by adding filtration on active and inactive merchants and their type (merchant versus affiliate).
  • General (UI) - Customer Activation
    The customer activation option is now available for customers previously deactivated on the user interface.
  • General (UI) - Provider Response Message for Chargeback Transactions
    Added ability to retrieve provider response message for returns/chargeback transactions via a separate field.
  • Hosted Payment Pages - Connectivity URL within HPP Files
    Changed the connectivity URL from gates/httpform to gates/xurl within HTML files associated with hosted payment pages.
  • New Merchant Console - New Billing API
    When the new Client Console is used for processing transactions and working with customers, you can now perform the same tasks using the new billing API. It allows a merchant to create and manage pricing plans, customers, their subscriptions, payment options and transactions via both Console and API.
  • New Merchant Console - Fees Sections on Deposit Details
    The user interface of the new New Client Console has been expanded with new sections associated with fee processing.
  • New Merchant Console - Billing Activity Summary Form
    For the new Client Console, implemented a set of forms associated with billing. The new forms are Add Payment, Add Credit, Add Invoice and Billing Activity Details.
  • New Merchant Console - Splits Detail Form
    For the new Client Console, implemented the new Splits Details form that allows users to view merchant's splits breakdown within an affiliate.
  • Onboarding - Onboarding Phases
    Implemented a new mechanism allowing additional phase tracking within an onboarding application. Not available to all integrators.
  • Onboarding - Update Request in Onboarding API
    Added ability to update an onboarding application via API for the Vantiv Lowell integration. Not available to all integrators.
  • Onboarding - Expiring Password in Onboarding Application
    Added ability to monitor how much time remains before the onboarding application expires.
  • Onboarding - Merchant Verification Refactoring
    Refactored the merchant verification logic to comply with the onboarding refactoring across the gateway.
  • Reporting (UI) - Terminal Order Detail Report
    Implemented report to retrieve extended information about terminal orders.
  • Reporting (UI) - Data Export from the User Interface
    Implemented a new mechanism allowing a user to export data from Transaction Summary and Deposit Summary forms on the new client console. The export is accessible through the Export button that calls the merchant-statement-list Reporting API with all parameters selected on the form, and with the possibility to download search results.
  • Reporting (UI) - Customer Account Balance Aging Report
    Enhanced the Customer Account Balance Aging report by adding an "Organization" customer type to the "Account Name" column. Previously, the only customer type present in the column was "Person."
  • Reporting (API) - Split Transactions Report
    Added ability to download all transactions associated with a particular split transaction via API.
  • Reporting (API) - Request and Client Hosts in Transaction List
    Added ability to retrieve request host and client host via the Transaction List report.
  • Reporting (API) - Merchant Statement Export Report
    Extended merchant statement export report with new columns.
  • Response Codes - Error Codes
    Edited notifications for L04, L05 and L06 error codes associated with user's permissions and privileges.
  • Remittance - Associated Fees Forms
    Implemented new form - Associated Fees - for the fees charged by a brand to be registered on the user interface.
  • Transaction (API) - Merchant Time Zone
    Added ability to receive time zone information via the real time transaction API.
  • Transaction (API) - Routing Number Validation
    Added general validation rules for US routing numbers.
  • Terminal - Hexadecimal to ASCII Conversion
    Card swipe device outputs in Hexadecimal format are now supported. Hexadecimal formats will automatically be converted to the supported ASCII format.
  • Terminal - Battery Charge Indicator
    Added ability to view battery life and Wi-Fi connectivity displayed on a terminal screen.
  • Terminal Management System - Active Terminal Update Profiles
    Added ability to sort out active terminal update profiles.
  • Terminal Management System - Terminal Update Profile Fields Validation
    Added limitation for the number of characters allowed for terminal update profile identification fields.
  • Terminal Management System - Terminal Last Activity Info
    Added ability to see when and how a terminal was used last time on the user interface.
  • Onboarding - Routing Number Exception
    Fixed an issue with a validation error returning when an invalid routing number was submitted in the onboarding API.
  • Onboarding - Email Address Validation
    Fixed an issue with the maximum number of characters for an email submitted via the onboarding API.
  • Onboarding - Application Code Field Length
    Fixed an issue with the number of characters for the applicationCode field submitted via the onboarding API.
  • Onboarding - Validation for Ownership Structure Type
    Fixed an issue with a validation error returning when an unsupported ownership structure type value was submitted by a processor via the onboarding API.

Version 7.1 December Maintenance Release (Sandbox: 11/26/2019, Production: 12/17/2019)


  • Void on Partial Capture
    UI/API/Logic: Fixed issues regarding void operations related to partial capture transactions.

Version 7.1 September Maintenance Release (Sandbox: 9/10/2019, Production: 9/17/2019)


  • Real-time Transactions
    UI/API/Logic: Invalid values in reatail_transaction_cycle.
  • Batch Processing
    Response file download state issue.
  • Batch Processing (emulator)
    NPE in task generation

Version 7.1 July Maintenance Release (Sandbox: 7/9/2019, Production: 7/16/2019)


  • Proxynization
    UI/API/Logic: Management portal virtual terminal proxynization updates.

Version 7.1 June Maintenance Release (Sandbox: 6/11/2019, Production: 6/25/2019)


  • Proxynization
    UI/API/Logic: Method POST issues related to Sale via the UI forms on current merchant console.
  • Proxynization
    UI/API/Logic: Method POST issues related to Sale via the UI forms on new merchant console.
  • Merchant Profile
    UI/API/Logic: Merchant profile configuration issue.
  • Onboarding
    UI/API/Logic: Issue with multiple AEX scorecards for one application.

Version 7.1 (Production: 3/12/2019)


  • Host Emulator
    Added ability to emulate the timeout scenario of the system when a response from real-time processors or the host emulator is delayed. When testing an integration with the host emulator, you can now specify a delay period within the memo field included in the transaction API request.
  • Time Offset in Host Emulator
    Added ability to emulate time offset via the host emulator. You can now change current server time while testing your integration with the host emulator. To have time offset tested, a number of hours that are going to be added or subtracted from the current server time can be set on the Settings form on the System perspective.
  • Visa Subscription Emulation
    Added ability to emulate receiving of the networkTransactionId field value via the host emulator. When testing an integration with the host emulator, you can now verify a correct implementation of the stored credentials logic via receiving the networkTransactionId field value and subsequently submitting it via the originalNetworkTransactionId field.
  • Card Number Proxynization
    Enhanced the validation mechanism for card numbers when proxynization is used
  • Masked Account Number in Tokenization Response
    Added ability to receive a masked account number within the tokenization API response. Masked account number can now be retrieved within the accountNumberMasked field within the tokenization API response.
  • Related Transactions
    Added ability to download all transactions associated with the specific one via API.
  • Partial Capture Transactions
    You can now make either full or partial capture on the transactions executed through the processors that support single partial capture. Previously, only processors that support multiple partial capture could process transactions with partial capture.
  • Onboarding - Time Zone on Onboarding Wizard Form
    When setting the time zone for a merchant via the Onboarding Wizard form on the Merchant perspective, you can now select a country code followed by the country flag. Previously, a time zone could be set as a country name without any visual representation of any kind.
  • HPP Configuration Error Response Code
    Added a new response code and message for cases when there is an issue with payment page configuration. new response code is now returned by the system when an HPP is configured incorrectly. When this error occurs, please contact support.
  • Onboarding - Multiple Business Owners
    Added ability to register multiple business owners during merchant's onboarding. To comply with new federal regulations, you can now register all business owners with a business stake of 25% or above (for high risk businesses - 10% or above) during the onboarding process via either API or the user interface.
  • Onboarding - Expiring Session in Onboarding Application
    Added ability to monitor how much time remains before the onboarding session expires.
  • TMS - Terminal Diagnostics
    Implemented mechanism that allows to access a result of the terminal diagnostics on the user interface. You can now check the state of the terminal and diagnose possible issues with the terminal via the Diagnostics form available under the Details button on the Terminal perspective. Additionally, if the information on the user interface is outdated, you can now run diagnostics via the Terminal Message form on the Portfolio perspective or via API.
  • New Merchant Console
    The Console perspective is now available through the designated logon form, which has a standard access functionality complemented with a specific component used for hiding/revealing of an entered password. This component is applied to all forms based on the new ZK version.
  • New Transaction-List Function
    You must now use the transaction-list function instead of export.
  • Split Payments
    Extended a range of transaction types for which pull-ins/pull-outs are generated. For cases when a previously split credit/refund transaction is made, the system now generates pull-in/pull-out transactions for the amounts that are supposed to be withheld from several participants. Previously, pull-in/pull-out transactions were generated for chargebacks/reversals only.
  • Batch Split Payments
    For cases when it is required to split a transaction included in a batch between two or more affiliates, you can now submit the identifier of a previously created split schema for the transaction. Previously, only real-time transactions could be split.

Version 6.3 (Production: 5/31/2018)


  • Legacy Names in API Responses
    Fixed an issue with legacy field names being returned in the bank-data API response instead of the new ones. Due to a bug, when the accountId field was sent in the bank-data request, the legacy name, such as merchantAccountCode, was returned in the response. The issue is fixed now, and the new convention of the API field names is used all across the API.
  • Temporary Password for Onboarding Application
    Fixed an issue with a permanent password being present in the onboarding API response when a session password was used. Due to a bug, a user could see both a permanent service user password and the generated session password while using the onboarding application. The issue is fixed now, and only a generated session password is present in the onboarding API response.
  • Zeros in Onboarding Application Issue
    Fixed an issue with business details tab being shown incorrectly on the onboarding application for affiliates. Due to a bug, extra zeros were displayed within the business details tab. The issue is fixed now, and tabs of the onboarding application are shown as expected.
  • Onboarding Application Issue
    Fixed an issue with a merchant being successfully onboarded with errors within the gateway. Due to a bug, when a comma was submitted within the deposit.holderName API field, the onboarding application was processed by a processor but could be either created with an empty field value or duplicated within the gateway. The issue is fixed now, and onboarding applications are created as expected.
  • Onboarding Validation Issue
    Fixed an issue with the validation mechanism in the onboarding API. Due to a bug, a generic system error was returned in an onboarding response instead of a corresponding validation error. The issue is fixed now, and all errors are returned as expected.
  • Onboarding Fields Validation
    Fixed an issue with several onboarding API fields not being validated correctly. Due to a bug, multiple API fields were not validated when create API request was being submitted. The issue is fixed now, and the onboarding application validation mechanism works as expected.
  • Password Expiration Notifications Issue
    Fixed an issue with password expiration notifications not being branded according to the settings of the branding profile. Due to a bug, the password expiration notification was received without branded data, such as portal name or URL. The issue is fixed now, and all notifications are generated correctly.
  • Monthly Processing Statement Report
    Fixed an issue with Monthly Processing Statement Report not including required columns. Due to a bug, deposit activity total amount values were not shown in the report. The issue is fixed now, and amount can be reviewed in Deposit Activity Total field. Additionally, visual representation of the Monthly Processing Statement report is corrected for PDF format. The issue is fixed now, and all required columns can be reviewed via the report.
  • Sandbox Server Ciphers
    Disabled weak ciphers for transaction processing through sandbox to fully comply with PCI requirements.
  • Cloud Pingdom Check
    You can now verify availability of the terminal cloud using the Pingdom monitoring service.
  • Support for HPP in iframes is discontinued
    Discontinued support for embedding of the hosted payment pages in the application via a frame/iframe. To correspond to the PCI security requirements, a designated filter is now added to disable the usage of hosted payment pages opening via frame/iframe. Required action: by September 1st 2018, embedding of HPP is going to be forbidden. Make sure that you do not use frame/iframe and open hosted payment pages in new tabs.
  • Required Name for New Reports
    Adjusted validation of the report name during the administrative report creation procedure. It is now required to indicate the name of a newly-added report via the Reporting form on the System perspective. Previously, a new report could be created with a blank name.
  • Chargebacks/Returns Notification Adjustment
    Adjusted notifications for chargeback cases and chargeback/returns files. Text of the notification associated with chargeback cases/chargebacks/returns was adjusted to correspond the generic template of the gateway notifications. Client-associated fields, such as company name, can now be taken either from a branding profile or an associated portfolio. Additionally, added important information for direct debit returns has been added to the notification.
  • Transaction Category Type
    Category field within the gateway to correspond to the naming convention within the system.
  • External Identifier in Void Operation
    Changed the mechanism allowing to submit an external system identifier in the void API call. You can now use the transactionId API field within the void operation for submitting both a gateway-generated identifier of the transaction (transactionId) and an identifier of a transaction within a submitter's system (transactionCode). If an external identifier is submitted, it is required to be preceded with an asterisk (*). Previously, an external identifier was submitted via originalTransactionCode field, that is now deprecated. Required action: by July 1st 2018, make sure that you made necessary changes in the code to use the transactionId field in void API operation instead of the originalTransactionCode field. Please refer to Supported Operations and Change History under Real-Time API specification for more details.
  • Transaction Receipt Enhancement
    Adjusted the template of gateway-generated receipt to correspond to the one generated by a terminal. To correspond to the terminal-generated receipt template, the following changes have been made to the gateway receipt: name of the "Net (USD)" field was changed to "Total (USD)". In EMV Data section, "PNN" and "APP" tags were added. In "Adjustments/Surcharges" section, "Subtotal" column containing total amount without additional payments (cashback, tip, fee, tax) was added, and "Transaction Total" field value was changed to the amount with all additional payments included. Previously, the fields in gateway and terminal receipts could differ which led to the discrepancies in the information provided within them.
  • Split Payments - Pull-In/Pull-Out Issue in PDF Formatted Statements
    Enhanced the view of pull-in and pull-out transactions in the merchant statement. You can now retrieve the information about pull-in and pull-out transactions in the merchant statements exported in PDF format. Previously, the pull-in and pull-out transactions could be shown incorrectly.
  • Merchant Logo
    Added ability to retrieve the logo associated with a merchant via API. You can now download a merchants logo, which was previously added to the merchants branding profile, via API. Previously, a merchants logo could be retrieved only via the Branding form.
  • Terminal Fields in Find API Response
    Added ability to retrieve terminal information about processed transactions. You can now retrieve terminal data associated with a transaction via API. Previously, terminal fields could be reviewed only in the response of the original transaction. The terminalId, cardApplicationName, receiptTagData, cycleCode, accountData, currencyCode and fallbackReasonCode fields can be retrieved via the find API call.
  • Approval Code in Find API Response
    Added ability to retrieve approval code of processed sale and sale-auth transactions. You can now retrieve the approval code associated with a transaction via API. Previously, approvalCode could be reviewed only in the response of the original transaction. he approvalCode field value can be retrieved via the find API call.
  • Entry Mode on Gateway Receipts
    Enhanced gateway receipts with entry mode information. You can now retrieve the entry mode associated with a transaction via a gateway-generated receipt. Previously, this information was available only at the user interface and on terminal receipts.
  • Transaction Search by Token
    Added ability to locate transactions by a token value generated by a processor's system. You can now search for transactions associated with processor-generated token value via the Transactions form on the Console, Merchant and Monitoring perspectives. Previously, transactions could be located using only gateway-generated tokens.
  • Search Results Limitation
    Added ability to limit a number of search results on the user interface. You can now limit the number of search results for files (via the Files form on the Merchant perspective), orders (via the Terminal Orders List form on the Console, Merchant and Reseller perspectives), errors (via the Errors form on the Audit perspective) and statements (via the Merchant Statements form on the Monitoring perspective and Statements form on the Merchant perspective). Previously, all available search results that met the search criteria were shown in the list of results which could lead to the system overload in case of a big number of records available.
  • Aggregated Files Display
    Added ability to review aggregated files on the user interface. If file aggregation is enabled for a merchant, you can now search and review the files that have been aggregated. For this purpose, the merchant with the ID 1000 is used on the File Store form on the Monitoring and System perspectives. Previously, such files could be reviewed in the database only.
  • Aggregated Files Display
    Added ability to review aggregated files on the user interface. If file aggregation is enabled for a merchant, you can now search and review the files that have been aggregated. For this purpose, the merchant with the ID 1000 is used on the File Store form on the Monitoring and System perspectives. Previously, such files could be reviewed in the database only.
  • Payment Plan Status on UI
    Added ability to review an upcoming status of a payment plan on the user interface. You can now see what status a specific customer's payment plan is going to obtain within the Payment Plans section via the View Customer form on the Console perspective. Additionally, ability to freeze fixed payment plans via the Freeze button is added on the View Payment Plan form on the Console perspective. Previously, the upcoming status of the payment plan was not shown in general customer's settings.
  • Reporting API
    Implemented new API allowing for retrieval of specified reports. You can now generate reports via the designated reporting API. Among the reports that can now be obtained via this API are the following: Merchant Statement, Merchant Statement List, Reseller Statement, Reseller Statement List, Reseller Statement Breakdown, Deposit List, Transaction Receipt, Transaction List and Terminal List reports.
  • Balances Form for Split Payments
    Implemented a new form - Balances, which allows to review how much money should be collected by and deposited to merchants/affiliates that took part in split transactions. You can now see the balance of a merchant or an affiliate showing the amounts of debts between them as a result of split payments via the Balances form under the Remittance button on the Console and Merchant perspectives.

Version 5.3 (Production: 11/19/2016)


  • Provisioning Callback Response
    Fixed the issue with no data sent to the URL associated with callback. Due to a bug, a user could not see provisioning response when being redirected to the one of the callback URLs (notifyURL, returnURL, cancelURL). The issue is fixed now, and when a callback is used, the respective data is shown.
  • Terms and Conditions Issue
    Fixed issue with misspelling of the user agreement checkbox title in the onboarding application. Due to a bug, there was a spelling mistake in Terms and Conditions agreement checkbox. Title of the checkbox has been changed to “I agree to the Terms and Conditions”.
  • Redirecting Issue for Onboarding Application
    Fixed the issue with incorrect redirection for onboarding application. Due to a bug, users got redirected to the incorrect onboarding application form after submitting a respective API request. The issue is fixed now, and an onboarding application works as expected when using provisioning API.
  • Onboarding Application
    Implemented an onboarding application that allows for the supply of information from a merchant to the provisioning company directly. You can now provide an external software company that needs to board merchants with a brandable onboarding application that is aimed at collecting information from a merchant. The application collects all necessary information that will be further submitted to the processor that performs provisioning. Provisioning response can be delivered in real-time or via callback, which is subject to a specific processor. Please refer to Provisioning API specification for more details.
  • Default Settings
    Added mechanism allowing for the assignment of priority to default settings of different system levels. You can now control what level – system, portfolio, reseller – is prioritized for defaults. Defaults assigned by a higher level can be overridden by a lower level. For example, if a portfolio has batch review enabled, a reseller can disable this setting for newly created associated merchants by configuring a setting on the Defaults form. If no defaults on a level lower than system is enabled, system settings set as defaults are applicable. To override a setting, configure it as needed and then click the enable button via the Defaults form on the Reseller and Portfolio perspectives.
  • Provisioning Validation
    Added extended validation mechanism to the provisioning API, the user interface and information obtained from a processor. The validation mechanism for onboarding application works similiar to the same mechanism within the gateway. Validation works both for visible and hidden fields and pages now.
  • Support System
    Moved support system settings from System to Portfolio perspective. You can now set up support system credentials for a particular portfolio using the Details form on the Portfolio perspective. Previously, the ability to control support system settings was available for the entire system only.
  • Processor Type Field
    Added ability to control whether transaction search by a processor is available within the system. You can now hide the Processor Type field for Portfolio1 and Portfolio2 security levels. For users that are lower than portfolio this field is now always unavailable. Previously, search by processor code was available for all security levels, so merchants could see the information about all processors within the system. Please refer to Security Management Guide under Self-study section for additional information about security levels.
  • IDs in Provisioning API
    Renamed code related fields in Provisioning API. resellerCode, merchantCode, merchantAccountCode and portfolioCode fields were renamed to resellerId, merchantId, accountId and portfolioId respectively. Previously, fields with code in the name could cause confusion because of their respective names on the user interface. If reseller reference code is submitted within resellerId field, the value must be preceded by an asterisk (i.e. resellerId=*00001).
  • Driver License Country Code
    Added driver licence country code to the business information about merchant. You can now provide information about a merchant’s driver license country on the Business Owner form on the Merchant perspective. Previously, only driver license state information could be added.
  • Gift Card Management
    Added ability to control whether API operations with gift cards are available for a particular processor or not. You can now manage whether gift cards operations are available while processing with particular providers. By default, Heartland, STS, FD Rapid Connect and Vantiv processors can accept API calls associated with gift cards. Previously, there was no ability to switch off gift card processing within the system. Gift card processing with a particular provider can be controlled via isCardManagementSupported field within a respective processor profile.
  • Real-time and Batch Fees
    Added separation of fees charged to chargebacks, reversals and returns for real-time and batch transactions. You can now define whether chargebacks, reversals and returns are associated with real-time transactions or batch files. Previously there was no ability to separate real-time and batch transactions on merchant statements.
  • Page Management in Provisioning API
    Adjusted page management mechanism in provisioning API. You can now submit one or more values without dashes and in random order within pageFormat field. Additionally, you can now submit H letter for cases when a sub-header is required to be present on the pages within the onboarding application. Previously, all values were required to be submitted in a certain order, and if one or more values should not be passed, they had to be replaced with a dash sign. Please refer to Page Management integration note under Provisioning API specification for more details.
  • Date of Birth Validation
    Enhanced validation mechanism on the user interface of onboarding application. Only 18 years old business owners can apply for merchant accounts now. A respective validation mechanism was added to Date of Birth field. Additionally, added ability to receive information about field format being incorrect right after entering an incorrect value. Previously, an incorrect birthdate could be submitted and validation worked only after the entire form was submitted, so it could lead to cases when a user was supposed to enter all information once again.
  • Estimates Validation
    Enhanced validation for estimates related fields within the onboarding application. You can now submit only digits within estimates fields. If no values should be submitted, these fields can be left empty. Previously, when no values should be submitted, the system still required them to be submitted.
  • Tax ID and SSN
    Added ability to enter SSN value instead of tax ID for sole proprietorship. Tax ID label is now changed automatically to SSN if sole proprietorship is chosen as a business type when doing provisioning via the onboarding application. previously, there was no separation according to a business type.
  • Onbording Confirmation Message
    Added procedure confirmation message to the Onbording application form. For cases when an onbording form is completed by a merchant, an acceptance message is displayed on the gateway to confirm the completion of the procedure, both successful and failed. Integrators will handle customization of final page with redirects if needed.

Version 5.2 (Production: 6/23/2016)


  • Terminals Creation without Order
    Implemented mechanism to allow for adding new terminals without previously created orders. You can now add new terminals to merchants with no previously submitted order using the Terminals form on the Merchant perspective. Additionally, the New Fulfillment Center form was enhanced with a Terminal Ordering Required checkbox that controls whether an order can be created or not.
  • BIN Data and Bank Data
    Implemented mechanism that allows receiving of bank identification number or bank data associated with a submitted transaction. You can now submit a respective API request to retrieve credit card BIN data or account number bank data for transactions associated with a particular merchant. Additionally, this information is shown on View Transaction form on the user interface. Previously, there was no ability to get this information for transaction made within the gateway.
    BIN data can be retrieved with bin-data API request and bank data can be retrieved with bank-data API request. Please refer to Supported Operations under Real-Time API specification for more details.
  • MAC and PIN Keys
    Implemented mechanism allowing the receiving of MAC/PIN keys values. You can now submit a respective API request to receive the value of MAC key for Canadian EMV transactions and the value of PIN key for both US and Canadian EMV transactions. The information can be retrieved with a separate API request or as a part of sale, credit, account verification or balance inquiry responses. Previously, there was no ability to retrieve the information about the keys available within the system. Additionally, API pinCode and dukpt fields were renamed to pinValue and ksnValue respectively.
    MAC/PIN keys information can be retrieved with get-keys, sale, sale-auth, credit, credit-auth, account-verification, balance-inquiry API requests or via terminalMessage field as a part of API response. Please refer to Supported Operations and Integration Notes under Real-Time API specification for more details.
  • Download Resource via API
    Implemented mechanism allowing to download resources associated with a particular transaction. You can now submit a respective API call to download resources, for example signature image submitted with the transaction. Previously, there was no ability to retrieve information that was uploaded via API. Resources can be retrieved with download-resource API request. Please refer to Supported Operations under Real-Time API specification for more details.
  • Subscription Returns Files
    Added ability to obtain subscription returns files. You can now receive returns subscription files with a list of subscriptions that had been initially approved, but were declined by a processor after some period of time. Please refer to Supported Operations under Batch API for more details.
  • PGP Encrypted Response Files
    Added ability to receive PGP encrypted response files from the server. You can now receive PGP encrypted responses containing sensitive data for both processing and account update. Please refer to the Supported File Formats and Integration Notes under Batch API for more details.
  • EMV Data Encryption
    Added support for P2PE encryption of real-time EMV transactions. You can now submit P2PE-encrypted EMV data within a respective API call. Additionally, the logic was changed to avoid indicating an identifier of an associated decryption key. Previously, only encryption of track data was supported within the system. EMV data is submitted within accountData field. Please refer to Supported Operations and Integration Notes under Real-Time API for more details.
  • CA Keys Import Logic
    Implemented mechanism allowing to import CA keys. It is now possible to automatically import certificate authority keys necessary for EMV processing.
  • Users List Form on Audit Perspective
    Implemented new form called Users List that allows retrieving all information of any user available within the system. You can now get a list of all users within the system as well as review their details using Audit perspective.
  • Callbacks in Host Emulator
    Added ability to emulate callbacks within host emulator. You can now test callback mechanism while testing your integration with host emulator. To have callback tested, notifyURL parameter has to be submitted within sale, sale-auth, credit, credit-auth API requests.
  • Terminal Order Report
    Implemented Terminal Order report. The purpose of this report is to export terminal orders associated with a particular reseller. Search can be performed by a reseller, terminal order status or within a certain date range. The report is available under Analysis section in reports.
  • Reports Related to the Form 1099-K
    Implemented Data Export 1099 and Data Export 1099 (by processing date) reports. The purpose of these reports is to show total income of all settled transactions for a particular year. This information can be used in the Form 1099-K. Reports are available under the Data Export section and can be generated in CSV format.
  • User Master Report
    Implemented User Master report. The purpose of this report is to retrieve detailed information about a user including general and contact information, as well as portfolios, resellers and merchants available to a user. The report is available in PDF format under Users List form on Audit perspective.
  • Implemented User Audit report
    The purpose of this report is to provide information about failed login attempts of users as well as expiration dates of their user accounts. The report is available in HTML, CSV and PDF formats under Analysis section in reports. Terminal Management System.
  • Update Search Form on Portfolio Perspective
    Implemented new form called Update Search that allows seeing which terminals have been updated to a particular update version. You can now locate terminals using Update Search form and review their update history and terminal logs.
  • View Receipt Info Form
    Implemented new form called View Receipt Info allowing for retrieval of detailed information about terminal order receipts. Added View Receipt Info button and respective form with detailed receipt information to the terminal order related forms on Fulfillment and Merchant perspectives.
  • Terminal Provisioning
    Enhanced permission-based security mechanism allowing to control what owner is associated with a particular user. You can now select a particular owner for both newly created and existing users all over the system. This option is available for human and service users. Previously, there was no ability to modify an owner for a particular user.
  • Assign User to Owner
    Implemented mechanism allowing to provision a terminal. You can now lock a terminal key associated with a particular terminal by submitting a respective value in log-state API request.
  • System Audit Notifications
    Enhanced notification mechanism allowing to notify about a node in cluster environment where an error occurred. From system audit notifications, you can now obtain informationabout the exact node where errors occurred. Previously, there was no such detailed information for cluster environment.
  • Export and Find API Calls
    Added ability to review additional information about transactions via export and find API calls. You can now retrieve customer account internal code and transaction internal code via export and find API calls for further reconcilliation with external systems, such as CRM. Previously, internal identifiers could not be retrieved.
  • Terminal Exchange or Return Mechanism
    Enhanced terminal ordering mechanism allowing to return and exchange terminals. You can now either return or exchange previously ordered terminal if needed. Previously, only purchasing option was available in the gateway.
  • Merchant Configuration Export
    Added ability to export merchant configuration. You can now export a list of merchants to check whether they are not set up or were updated with particular configurations. This can be done using Merchants form under Changes button on Audit perspective. Previously, this information was available only on the user interface.
  • DBA Name
    Optimized validation on the Provisioning form. DBA name field is now required to be submitted via Provisioning form on Merchant perspective. Previously, this field was optional.
  • Fulfillment Order Number
    Added ability to review a fulfillment order number on the user interface and within a Terminal Order report. You can now retrieve a number of a fulfillment order associated with a particular terminal using Orders form on Fulfillment and Merchant perspectives or Terminal Order report. Previously, this information was available only at the database level.
  • Token Removal
    Fixed the issue with a token associated with a particular bank account not getting deleted along with merchant’s deposit information. Due to a bug, a token could not be removed from Deposit form on Merchant perspective when associated bank information was deleted manually. The issue is fixed now, and the system now automatically clears up token values associated with bank accounts for cases when all bank information used for funding is removed.
  • Aggregated Validation Files
    Added ability to generate validation files for aggregated merchants. Validation files can now be generated for submitted files that are aggregated under associated merchants. Previously, validation files could be received only for files that have not been aggregated.
  • Terminal Credentials
    Added reporting on serial number, activation code and shipping date of a terminal. You can now get information about a serial number, activation code and shipping date of a particular terminal using Terminal report and Terminals form on Portfolio perspective. Also you can now locate terminals by a particular serial number using the same form. Additionally, Terminals form was added to Reseller perspective. Previously, there was no ability to retrieve serial number, activation code and shipping date of a terminal at one place.
  • HPP Support
    Added ability to perform sale and credit API operations with convenience fee included via hosted payment page. You can now make sale-auth, credit-auth and credit operations with convenience fees when the hosted payment page is used. Previously, sales with convenience fees were only supported for hosted payment pages.
  • Reseller Attachment
    Adjusted merchant validation mechanism by limiting the ability to attach resellers to merchant accounts. You can now assign a reseller to a merchant only. If there is an attempt to attach a particular reseller to a merchant account, the following validation message will be received: “Operation is not supported for accounts”. Previously, resellers could be assigned to both merchants and merchant accounts, which could sometimes lead to different resellers being assigned to a merchant and its associated account.
  • States and Time Zones
    Extended the list of time zones and states available within the system. You can now select any available time zone according to the desired location. Additionally, states for Russia, Egypt, Saudi Arabia and the UAE were added. Previously, only US, UK, Australia and Spain states and an incomplete list of time zones were available within the system.
  • Terminal Order List Form
    Added Terminal Order List form to Reseller perspective. You can now access the Terminal Order List form and Terminal Order report using the Reseller perspective. Previously, this form and report were available only on the Merchant and Fulfillment perspectives.
  • Attach Reseller to Portfolio
    Added ability to assign a reseller to a particular portfolio. You can now attach a reseller to a portfolio while creating a new reseller or modifying an existing one. Previously, only merchants could be associated with a portfolio.
  • Terminal Provisioning
    Implemented mechanism allowing to provision a terminal. You can now lock a terminal key associated with a particular terminal by submitting a respective value in log-state API request.
  • Terminal Provisioning
    Implemented mechanism allowing to provision a terminal. You can now lock a terminal key associated with a particular terminal by submitting a respective value in log-state API request.

Version 5.1 (Production: 5/23/2016)


  • Automatic Statement Reconciliation Mechanism
    Added mechanism for automatic reconciliation of merchant statements based on Transaction Detail report available with the processor.
  • Convenience Fees Form
    Implemented new form – Convenience Fees, which allows to manage the rules for convenience fee calculation.
  • >API Convenience Fee Request
    Added ability to calculate a convenience fee for a particular transaction via API.
  • New Format of MasterCard BINs
    Added support for newly-introduced BIN range for MasterCard. Starting with October 2016, MasterCard extends their BIN range with 2 series. The system now allows to process MasterCard credit cards starting with both 2 and 5 series. Previously, only 5 series MasterCard BINs processing was supported within the system.
  • EBT Cards Processing
    Added ability to emulate EBT card processing within Host Emulator. You can now test EBT cards while testing your integration with host emulator. To test EBT functionality, account type value should be properly indicated according to the gateway specification.
  • User Master Report
    Implemented User Master Report. The purpose of this report is to retrieve detailed information about a user including general and contact information, as well as portfolios, resellers and merchants available to a user. The report is available in PDF format under Users List form on Audit perspective.
  • Implemented User Audit report
    The purpose of this report is to provide information about failed login attempts of users as well as expiration dates of their user accounts. The report is available in HTML, CSV and PDF formats under Analysis section in reports.
  • Terminal Validation Error Notification
    Added mechanism which allows to send terminal validation error messages to merchant’s notify URL.
    Merchants can now receive notifications about terminal transactions with validation errors to the specified notify URLs. Previously, realtime validation errors could not be received when a hosted payment page is used.
  • Fulfillments Profile
    Implemented new merchant profile group – Fulfillments – which allows to configure a profile for merchant’s fulfillment center. You can now set up a fulfillment center for the processing of merchant terminal orders.
  • Deferred Tokenization
    Implemented mechanism which allows processing of deferred tokenization requests. For cases when a terminal is operated in attached mode, you can now submit a deferred tokenization request without raw card data and subsequently retrieve this request from the system in order to add the card number and complete tokenization operation. Previously, deferred tokenization was not supported within the system.
  • View Receipt Info Form
    Implemented new form called View Receipt Info allowing for retrieval of detailed information about terminal order receipts. Added View Receipt Info button and respective form with detailed receipt information to the terminal order related forms on Fulfillment and Merchant perspectives.
  • Terminal Order Sending Time Settings
    Changed delivery time settings for terminal orders to be submitted to TPG.All approved terminal orders can now be sent for further processing with TPG five time per day with 8 PM (server time) the latest. Previously, all orders were submitted at 9 PM and associated issues (if any) could be resolved only the next day.
  • Portfolio Role Access Parameters
    Enhanced permission mechanism to restrict users access to merchants under a different portfolio. Users with Portfolio 1 role now do not have access to the portfolios which they are not bound to. Previously, user could see all the portfolios.
  • Auto-completion On Payment Pages
    Optimized paypages data security mechanism. Word completion of sensitive data is not allowed now on hosted payment pages. All submitted data, such as credit card/bank account number, CSC, etc is not stored within the system. Previously, this information could be autocompleted by a customer who had made a transaction through a HPP before.
  • Terminal Logs on User Perspective
    Added ability to review terminal logs on User Perspective. You can now use UI to view and analyze terminal logs associated with a particular merchant. Previously, terminal logs were available for review only on database level.
  • Terminals Search Form
    Added ability to locate terminals available within the system. You can now easily search for any terminal available within the system. For this purpose a new form – Terminals Search – was added, which allows to locate a particular terminal by several search criteria, as well as change terminal parameters. Previously, terminal associated with a particular merchant could be found only by its terminal order number.
  • Transaction Capture
    Added ability to manually capture a transaction on the user interface. Additionally, all options related to the transaction processing flow were combined into one button – Actions. You can now manually initiate a capture for a particular unsettled transaction on the UI. The respective button, as well as all buttons associated with transaction processing and reprocessing, are now logically grouped together for easier access.
  • Convenience Fee Transaction in Original Sale
    Added ability to trace the Convenience fee transaction – Original transaction chain. You can now view the original sale for which a convenience fee transaction was created. Conversely, you can also view the convenience fee transaction for a given sale. Previously, there was no visibility as to the correlation between sales and their respective convenience fee transactions.
  • Retail Cycle Code in API
    Extended API response with additional field – cycleCode. You can now obtain a retail transaction cycle ID in an API transaction response. Perviously, the cycle which a transaction belonged to was not identifiable within the API. Specified field is returned in API responses for Sale, Sale-Auth, Sale-Info, Credit, Credit-Auth, Credit-Info, Void, Refund, Capture, Increment, Balance Inquiry, Account Verification, Transfer, Activate, Deactivate, Reactivate, Convenience Fee, Create Alias, Delete Alies operations. Please, review Suported Operations under realtime API specification for more details.
  • Account Update Processing
    Enhanced the logic of account update responses processing within the system. CAU response files are now processed within the system based on processor’s response codes, so that the records containing no updated information are ignored. Previously, fields containing no updated card data were automatically populated with original values.
  • Input source for Non-EMV Transactions
    Enhanced API mechanism for non-EMV transactions. You can now obtain entryMediumType and entryModeType values in API responses for all transactions including the non-EMV ones. Previously, this value could only be returned for EMV transactions.
  • Search of Merchants by Remitter
    Added ability to find merchants by a remitter as a search criteria. You can now locate merchants associated with a particular remitter on Modify Selection form. Previously, there was no ability to search merchants by remitter.
  • Tokens in Subscription Files
    Added ability to transmit tokens in subscription files. You can now submit subscription files without raw sensitive data included. Tokenized account numbers can be used instead. Previously, there was no ability to transmit subscriptions files with tokens.
  • Bank Holidays of 2016
    Extended gateway holiday list with bank holidays of 2016.Added Canadian and Australian bank holidays of 2016 to the gateway holiday list. Previously, only US bank holidays of 2016 were available within the system.
  • Proxynization Scripts Removal
    Added automatic removal mechanism for completed API proxynization scripts. Proxynization scripts containing sensitive data will now be automatically removed from a customer’s device once the API request is processed. Previously, scripts were removed only after the page was refreshed.
  • Batch Processing Policy Default Value
    Added ability to control merchant batch processing policy on both system and portfolio levels. You can now predefine the default value of batch processing policy either for all merchants within the system, or for merchants associated with a particular portfolio. Previously, batch processing policy could be set for every merchant separately.
  • Account Number Tokenization
    Enhanced tokenization mechanism. Added ability to tokenize account numbers for cases when masked value is provided in the tokenization batch file. Previously, system could not process files with masked account numbers being supplied.
  • Batch File Display Limit
    Expanded the limit of displayed batch submissions on Batch List form.You can now view up to 1000 batch files on the Batch List form. Previously, there was a limit of 200 batch files available for review.
  • Refund Period Limit
    Enhanced refund issuing mechanism in regards to the permission policy. You can now limit the time period of when a refund can be issued for a transaction. By default, all users are not pemitted to issue refunds in 90 days after the initial sale was made.
  • ZIP Code Format
    Added ability to use letters in ZIP code. You can now specify both digits and letters in ZIP Code value. Previously, ZIP code field could include digits only.
  • Remitter Merchant Searching
    Added ability to search for Remitter merchants on Merchant perspective. You can now easily locate Remitter merchants on Select Merchants form. Previously, there was no ability to defile such search criteria when modifying merchant selection.
  • View Transaction Form Enhancement
    Rearranged fields on View Transaction form and extended the form with additional transaction information. You can now view both void and fallback reasons, as well as the card entry information for a particular transaction on View Transaction form. Additionally, groupboxes and associated fields on this form were re-organized to better correspond their functionality.
  • Account Update Transactions Splitting
    Added mechanism which allows to automatically split Account Update batch files into sub-batches. You can now submit big CAU files for processing. All files containing more than 50k transactions will be split into sub-batches. This allows to process CAU files with processors that have transaction limits for submitted batch files. In addition, optimized token processing logic for Account Update. Previously, if a processor had a limit for submitted transactions, big CAU files could be rejected. Additionally, the mechanism of AU token validation was added.
  • Blacklisted Transaction Status
    Fixed the issue with blacklisted transactions displaying incorrect status. Due to a bug, incorrect statuses were assigned to some blacklisted transactions on the gateway. The issue is fixed now, and all blacklisted payments are displaying accurate information.
  • Recurring Billing Address
    Fixed the issue with incorrect customer address information in payment details. Due to a bug, an incorrect state value was selected when creating a new payment for recurring billing customer. The issue is fixed now, and address information contains accurate data.
  • Merchant Activity by Agent
    Fixed the issue with Merchant activity by Agent report containing irrelevant data. Due to a bug, Merchant activity by Agent report could not collect accurate data from the system. The issue is fixed now and the report generating mechanism works as expected.
  • Dynamic Descriptor Value
    Fixed the issue with dynamic descriptor value being incorrectly displayed. Due to a bug, particular transactions were submitted for processing with incorrect dynamic descriptor value. The issue is fixed now, and the correct value is used for all transactions.
  • Sales Analysis Report
    Fixed the issue with Sales Analysis report not getting generated. Due to a bug, Sales Analysis report displayed no data for selected parameters. The issue is fixed now, and reporting mechanism works as expected.
  • PIN Debit Transaction Error
    Fixed the issue with PIN Debit transactions returning an error while testing an integration. Due to a bug, PIN Debit transactions made within the host emulator failed. The issue is fixed now, and PIN Debit API requests are processed as expected.
  • API Requests for Service Users
    Fixed the issue with inability to run API transactions for service users. Due to a bug, newly created service users were not able to make API calls within the system. The issue is fixed now, and service users have full access to API.
  • Refund Decline
    Fixed the issue with refunds being declined within the system. Due to a bug, there was no ability to refund sale transactions. The issue is fixed now, and refund mechanism works as expected.
  • Deposit Analysis Report
    Fixed the issue with the Deposit Analysis report missing Visa and Master Card prepaid transactions. Due to a bug, Visa and Master Сard prepaid transactions were not included in the Deposit Analysis report. The issue is fixed now, and all types of transactions are included in the report.
  • Merchant Statement Recipient List
    Fixed the issue with inability to update merchant statement recipient list. Due to a bug, there was no ability to save changes to merchant statement recipient list. The issue is fixed now, and the list can be properly updated.
  • Final Responses for Transactions in Rebill
    Fixed the issue with transaction responses being incorrectly delivered to merchants. Due to a bug, declined transactions with enabled Rebill feature were returned to merchants as final responses. The issue is fixed now, and responses are delivered as expected.
  • Amex Transactions in Forward Status
    Fixed the issue with Amex transactions not getting processed within the host emulator. Due a bug, sub-batches with Amex transactions got stuck in Forward status and could not be processed while testing an integration with the host emulator. The issue is fixed now, and Amex transactions are processed as expected.
  • Batch Transactions Refunding
    Fixed the issue with inability to refund particular batch transactions. Due to a bug, there was no ability to issue refunds for batch transactions for cases when a batch cycle was manually closed. The issue is fixed now, and all batch transactions can be refunded.
  • Merchant Statement Export Mismatch
    Fixed the mismatch between Merchant Statement Export report and Merchant Statement Export All Available Merchants. Due to a bug, there were some discrepancies between two reports – Merchant Statement Export and Merchant Statement Export All Available Merchants. The issue is fixed now, and both reports include accurate data.
  • API for Deferred Transactions
    Fixed the issue with API requests for deferred terminal transactions not getting properly transmitted. Due to a bug, fields entryMediumType, entryModeType, entryPinModeType, terminalCapabilityMode could not be properly submitted in API requests for deferred transactions, when a terminal was operated in attached mode. The issue is fixed now, and the fields are correctly transmitted.
  • EMV Transaction Processing
    Fixed the issue with particular EMV transactions not getting properly submitted for processing. Due to a bug, some of EMV transactions were submitted for processing with credit card numbers instead of track data. The issue is fixed now, and all EMV transactions are performed as expected.
  • Issuing Credits on UI
    Fixed the issue with inability to issue credits for successful transactions on UI. Due to a bug, button used for issuing credits on user interface was not available for particular transactions. The issue is fixed now, and the button works as expected.
  • Statement Review
    Fixed the issue with merchant statements not getting automatically approved. Due to a bug, merchant statements had to be manually approved for all merchants including those having Statement Review feature disabled. The issue is fixed now, and statement review mechanism works as expected.