Document control

DateActiveServer VersionDocumentation VersionChange Details
21/09/212.0.52.0.5:1• Updated the View Transactions guide with the Device Channel, Message Version and 3DS Requestor Trans ID filters
• Updated the Dashboard guide with the UTC toggle function
• Updated the Manage merchant guide with new merchant tab structure
• Updated the DB2 Quickstart guide with a note on recommended transaction log sizes
• Updated the Auth API docs with the following changes:
     • Added the priorAuthenticationInfo field and removed the priorTransID field from the Auth API requests
     • Added further descriptions to the merchantId, provisionAttemptsDay, txnActivityDay, txnActivityYear, purchaseInstalData and giftCardCount fields for Auth API requests
02/07/212.0.42.0.4:1• Updated the Auth API docs with the following changes:
     • Added the 3DSMethodHasError event information to the eventCallbackUrl field to /brw/init
     • Added the forceMessageVersion field to /auth/brw
     • Added the amexDsTransID field to /brw and /brw/result
     • Updated the authenticationType field with value 92 for /brw and /brw/result
• Added the 3DS1 integration guide to assist SaaS users with 3DS1 integration
• Updated the Authentication Sequence with details for the 3DSMethodHasError event
• Updated the Error codes guide with Error Code 1000
11/05/212.0.32.0.3:1• Updated the ActiveMerchant migration guide to include steps for ActiveServer SaaS merchant migration
• Updated the system security settings with the new API security features, "Allow merchant override" and "Skip Enrol API merchant validation"
• Updated the 3DS Requestor v2.2.0 upgrade guide with a note regarding the changed message version downgrade logic
• Updated the View Transactions guide with 3DS 2.2.0 values for Transaction Status, Transaction Status Reason, Authentication Type and 3DS Requestor Challenge Indicator
• Updated the Auth API docs with the following changes:
     • Added the merchantOverride field to the /auth/brw API
     • Added note regarding "Skip merchant validation" to the /auth/enrol API
     • Removed the threeDSRequestorTransID field from the /auth/brw API
01/04/212.0.22.0.2:1• Updated the Error codes guide with additional User Error Codes
• Updated the FAQ with a note on the InitAuthTimedOut event
01/03/212.0.12.0.1:2• Updated code sample in the Frontend v2 guide for the challenge page time out scenario
01/02/212.0.12.0.1:1• Added the APIV2 migration guide to the system settings page
• Added a note to the Quickstart guide regarding MSSQL default server collation
25/11/202.0.02.0.0:1• Added the EMV v2.2.0 migration guide, detailing the features added in EMV 2.2.0 as well as how to upgrade the 3DS Requestor to send EMV 2.2.0 messages
• Added the 3DS Server Reference number override, PReq message version number override and JVM memory override sections to the Quickstart guide
• Added warnings to the Merchant certificate and User certificate sections regarding the 2 year expiry of client certificates
• Updated the Auth API docs with the following changes:
     • Added all new EMV v2.2.0 fields to API requests and responses, which are marked with a [From V2.2.0] note
     • Updated the Enrol API with newly added supportedMessageVersions and acsInfoInd fields
     • Updated the authenticationType,acsInfoInd, transType fields to list card scheme specific values
     • Added the messageExtension and challengeWindowSize fields for Auth APIs
• Updated the Frontend v2 guide including 3DS method timeout using _onInitAuthTimedOut, updated sample requestor code for decoupled authentication and additional information on API options including challengeWindowSize
• Updated the Backend v2 guide with updated sample requestor code for decoupled authentication
• Updated the Sample code features including how to set the EMV message version, adding support for disabled javascript environments and additional information on API options including challengeWindowSize
10/09/201.4.01.4.0:1• Updated the Integration guides with the new features for v1.5 of the sample 3DS Requestor code, including selecting the DS profile to test with and mock app channel testing
• Added the new Health check API documentation
• Updated the Manage Merchants and User profile guides with details on the new client certificate download functionality
• Updated Compatible database versions for Amazon Aurora PostgreSQL (add 2.3 and later)
• Updated the Database settings of the Quickstart guide with the optional as.db.pool-size= setting
• Updated the Prerequisite system requirements to more clearly delineate between server and database recommendations
• Updated the Error codes guide with UnionPay specific codes
• Updated the Manage DS settings guide with new 3DS Server URL functionality
• Added a note regarding max_packet_size for MySQL databases
• Updated the Auth API docs with the following changes:
     • Added newly supported DS reserved values for 3DS requests and responses
• Updated the Admin API with the following changes:
     • UnionPay added to provider fields
     • Trans API was changed to POST
     • Merchant certificate export API changed to .zip response
     • Error responses were added
13/07/201.3.51.3.5:2• Removed the "Card not enrolled" scenario from the TestLabs guide as it has been deprecated
26/06/201.3.51.3.5:1• Added a View DS card ranges guide outlining the new card range cache viewing feature
• Updated the Manage DS settings guide with details on the new sub menus for DS profiles and the new Cache update toggling feature
• Added a DS Profiles guide for setup and configuration of DS Profiles
• Added Trans-type override setting section detailing how to override DS Profiles if required
26/05/201.3.41.3.4:1• Updated the Using the dashboard and View transactions guides with information on using the Transaction Type filters for Production and TestLabs DS profiles
• Updated the TestLabs guide with additional Discover test cards using the 36 prefix
• Updated the Quickstart guide AWS Secret Manager access permissions section
14/05/201.3.31.3.3:1• Updated the Upgrade guide with important information relating to upgrading ActiveServer to v1.3.3
• Updated the Quickstart guide with the new TestLabs Directory Server port settings
• Updated the Configure system settings guide with the new Master encryption key information
• Updated the Quickstart guide with the new Amazon Secrets Manager functionality
• Added a FAQ section with details on how to enable ActiveServer to use a read only file system
• Updated the v1 and v2 back-end integration guides with usage of the trans-type parameter to use TestLabs or Production DS profiles
• Updated the Manage DS settings guide with a note on disabling card scheme messaging
• Updated Quickstart guide email server settings with the as.mail.from functionality
• Updated the Auth API docs with the following changes:
     • Added the trans-type parameter query to APIs which require this value to determine if the API request should go to TestLabs or production DS
     • Added additional information about the eventCallbackUrl to API v1 and API v2 init API calls
     • Added additional information to the all the Auth API descriptions
30/03/201.3.21.3.2:1• Updated Release notes for ActiveServer v1.3.2 changes
18/03/201.3.11.3.1:1• Updated the Quickstart guide with instructions for Disabling local file output logging
• Updated the Configure system settings guide and Manage DS settings guides with important information regarding URL validation added in v1.3.1
02/03/201.3.01.3.0:2• Added more descriptions and common solutions for each error codes for the Auth API
• Updated Auth API document to add more descriptions for the errors
07/02/201.3.01.3.0:1• Added the API migration from v1 to v2 guide detailing the changes and migration path from Auth API v1 to v2
• Updated the Integration overviews and Integration guides, including making separate documents for v2 and v1 integrations and updating the Sample code features and Directory tree guides
• Updated the Auth API reference document with the new Auth API v2 endpoints and updated the API document overview with an Auth API reference table for an overview of API version endpoints
• Added information to the View transactions guide regarding changes to PAN masking and PAN search functionality
• Added the Log settings and KMS sections to the Quickstart guide
• Added application error code mapping to the HTTP status code in the error codes
22/11/191.2.21.2.2:1• Updated Quickstart guide with warnings about the use of HTTP for server and admin ports
15/11/191.2.11.2.1:1• Updated Release notes for ActiveServer v1.2.1 changes
01/11/191.2.01.2.0:1• Added the ActiveMerchant migration guide for importing merchants and acquirers from ActiveMerchant
• Updated the Configure system settings guide to add the Admin URL description
• Updated the Configure system settings and Manage DS settings guides to reflect the removal of global timeout settings and re-arrangement of settings tabs
• Updated the Quickstart HSM section with a note regarding HSM Token Login
• Added note in the Merchant Merchants guide regarding requirements for Merchant name and Merchant ID to be unique
• Added note in the Quickstart guide regarding escape characters for Windows local keystore paths
27/09/191.1.41.1.4:1• Updated the External URL notes section for the new 3DS Server URL update feature
20/09/191.1.31.1.3:1• Updated Release notes for ActiveServer V1.1.3 changes
19/09/191.1.21.1.2:1• Updated the Manage Merchants and User profile guides with details on the new Master Auth API client certificate functionality. A description of the implementation can be found in the Auth API Authentication and Demo 3DS Requestor Configuration guides
• Updated the Auth API with the new challenge status endpoint. A description of the implementation can be found in the front-end, back-end and demo requestor features pages
• Updated Manage Merchants guide for new BIN assignment functionality
• Updated the Auth API with the following changes:
     • Added dsTransID and messageVersion to API responses for BRW, APP and 3RI channels
• Updated the Admin API with the following changes:
     • Managing Acquirer BINs via the Admin API now uses string values rather than UUID's of Acquirers in the system. As such, the Acquirer Admin API endpoints have been removed
     • Changed the Admin API endpoints for Merchants (certificate export/revoke and key rotate) and removed unused parameters from request and responses
     • Removed the Admin API endpoints for settings
• Updated View ActiveServer Information for new View EULA button
• Removed the CRes and ACS method timeout settings
30/08/191.1.11.1.1:1• The Guides > Integration section has been rewritten to match the v1.1 release of the GPayments 3DS Requestor sample code available on GitHub. Now supports code examples for multiple backend languages (Java, C#, PHP and Go) as well test pages for Browser, 3RI and Enrol endpoints
• Added a TestLabs guide detailing TestLabs usage and available test scenarios
• Added a optional merchantName field to the authentication APIs to allow the merchant name in a merchant profile to be overridden for AReqs
• Added DB2 and PostgreSQL connector examples to the Quickstart guide and added alternative JDBC url example to MSSQL
• Added a section to the API document overview, Converting P12 to PEM using OpenSSL
16/08/191.1.01.1.0:1• Added supported web browsers to the Quickstart guide
• Updated the Manage DS Certificates guide with information on how certificates are used in ActiveServer as well as newly introduced CSR management features
• Updated Quickstart guide with details on setting TLS version
• Updated compatible database versions for PostgreSQL (add 8.4 and later) and DB2 (add 11.1 and later)
• Added instructions to change session timeout setting
• Updated the /api/v1/auth/app/{messageCategory} API example to reflect the sdkEphemPubKey attribute being an object and updated the sample JSON
• Updated Manage DS Settings guide to reflect new optional PReq URL endpoint being added
16/07/191.0.51.0.5:2• Added functionality to choose documentation version and language, as well as downloading the documentation as PDF
04/07/191.0.51.0.5:1• Updated the Manage merchants guide with details of CA certificate download
• Updated purchaseCurrency and purchaseAmount descriptions on /api/v1/auth/brw/init/ API request
• Updated /api/v1/auth/3ri API request to require a {messageCategory}
• Updated system labels for Directory Server > Settings > 3DS Server URL (previously External URL), Directory Server > Settings > HTTP listening port (previously HTTPS callback port), Settings > 3DS2 > API URL (previously Auth API URL)
• Updated the test card number used for challenge authentications
07/06/191.0.41.0.4:2• Updated the API document overview to include field condition definitions and updated the Front-end implementation and Step-by-step guides to reflect latest changes to 3DS Requestor demo code on GitHub
• Updated BaseMerchantProvider object used in /api/v1/admin/merchants to use acqBinId only
31/05/191.0.41.0.4:1• Added a new Settings > HSM section, explaining how to use the HSM PIN change functionality
• Updated Quickstart document with additional information for using Amazon S3 Keystore as the system keystore, including using IAM roles
30/05/191.0.31.0.3:2• Updated Quickstart document with MS SQL sample properties
• Updated compatible database versions for MySQL (add Amazon Aurora), Oracle (add 12c) and MS SQL (add 2008 R2, 2012, 2014, 2016)
27/05/191.0.31.0.3:1• Updated the API document overview with details on how to download CA certificate chains and access Administration APIs using .X509 authentication
• Updated the User profile guide with details of certificate download and revoke
• Updated the Enrol API result description with details of the enrolmentStatus
24/05/191.0.21.0.2:1• Added support for MSSQL 2017
• Updated Quickstart document with new default DS port numbers and updated supported Oracle DB version to 11g
• Updated Logging section to reflect new log file format (as.yyyy-mm-dd.log)
• Added the Upgrade instance guide
• Updated the Activate instance document, as MyAccount no longer requires the External URL during server registration
08/05/191.0.01.0.0:4• Added data elements overview to the Activate instance guide
03/05/191.0.01.0.0:3• Restructured the old Authentication Integration section into multiple pages along with adding more information to assist in explaining the integration process. There is now a high level overview set of documents, along with the step-by-step integration guides under the Guides > Integration heading
30/04/191.0.01.0.0:2• Minor updates to fix broken links
18/04/191.0.01.0.0:1• Initial release