In-Person Payments

• For Early card capture scenario make the Authorization result and Status codes similar to the to Payment flow for SCA.

• Fixed issue with Early card capture request sent with 0 amount for SCA terminals.

• Fix an issue to reset the PSDK internal state machine after a connection recovery Failed.

• Return back “Perform Command” and “Reset” buttons to the Android TestHarness app.

• Added support for requesting PIN from terminal, as described in Nexo 3.1 spec for Nexo terminals.

• Added a new API requestUserInput2 to send/receive predefined content reference id and plain text content.

• Added an API to check if PSDK has a cardAcquistion reference.

• Added sdi-client version logging during initialization

• Providing a new more flexible API requestCardData2 that allows setting allowed payment brands for card acquisition

• Made change to not revert to the previous cached message reference (prior to last transaction) when an abort is sent to the terminal

• Fix an issue on VIM terminals which was causing login to fail after calling UseDevice(false).

• Added support for SaleAdmin event in the EventNotification.

• Implemented negotiating VHQDEVID parameter for SCI terminals through InitializeFromValues passing VHQ_DEVICE_ID_KEY config map key with appropriate value

• Enabled early card capture support for SCA terminals.

• Added support for presentCustomerContent2 API for SCA terminals.

• Increased app-specific data string limit to 512 bytes

• Written a Reference Application that utilizes the base PSDK SDI functionalities.

• A new api was added to iOS PaymentSdk to guide the user through the Bluetooth setup for communicating via bt-pan.

• Update to reject logout command from POS if a session is currently active.

• Updated PaymentInstrumentType to STORED_VALUE

• Serialize quantity as string for merchandise items. If the quantity has decimal part zero(e.g. 1.00), we will display it as integer.

• Included documentation for bluetooth device setup api functionality.

• Reverting the modifications to TransactionManagerState processing when connection is lost from release 3.49

• Added code to address PSDK internal state race condition in AwaitingTerminal state if PrintEvent and DeviceManagementEvent received consecutively.

• Updated PSDK to return status 0 (Success) and DECLINED Authorization Result for the MAX swipe exceeded error from SCA terminal

• Fixed the 10 missing bytes bug in the mux channel chunked message write

• Fixed a bug related to “static initialization order” of keys in PSDK initialization.

• Fix an issue to reset the PSDK internal state machine after a connection recovery Failed.

• Added support for requesting PIN from terminal, as described in Nexo 3.1 spec for Nexo terminals.

• Added an API to check if PSDK has a cardAcquistion reference.

• Added an API to provide Cashier name in payment object.

• Update one of the PSDK dependency library CryptoPP to 8.6.

• Updated documentation for Linked Refund and also added Robot test case for Linked refund.

• Added an API to obtain VAS data and VAS Full response for SCA terminals.

• Implemented negotiating VHQDEVICEID parameter for SCI terminals through InitializeFromValues passing VHQ_DEVICE_ID_KEY config map key with appropriate value

• Implemented to retrieve device version as per SCA specification. GET_VERSION is fired after terminal login is complete and processed asynchronously

• Added VF_ReprintReceipt1 capability for Nexo terminals.

• For FSA Transactions add an API Payment.getAmountDue() to get the amount due if combined FSA and Non-FSA amount transaction is being done.

• Removed the deprecated API presentReceipDeliveryOptions() as it has been deprecated more than an year ago and no longer supported.

• Clear saved card data upon session end

• Updated PaymentAppVersion return SCA version properly.

• Implementated by Device Discovery with mDNS and DNS-SD

• Added a provision for setting “EBT voucher num” for SCA.

• Added FSA support for both SCA and Nexo.

• Added an API to query if PIN is bypassed during payment transaction.

• Updated to parse ‘Tokinization’ in the capabilities returned by AGPA.

• Updated DeviceInformation().getVersion() to return the SCA version properly.

• Fixed using an erroneous predefined message text for unknown PredefinedContent ReferenceID

• Added unit test case to verify Order Number/ Invoice Number generation for every transaction.

• Added a new AuthorizationMethod - PIN_SIGNATURE to support both pin and signature for EMV transactions.

• For SCA updated a bug fix in the API ReportManager.queryTransactions() API to return the transactions when the date range is specified.

• Fixed a bug to return proper AuthResult For Void transactions for Nexo Void transactions when doing queryTransactions.

• Fixed an internal SCA bug to return the EBTType of FOOD_STAMP as per the SCA specification.

• Payment.IsDuplicate flag is updated properly when SCA detects a duplicate transaction locally.

• Updated the FAQ section of the PSDK documentation.

• Updated iOS Reference Apps to include Apple required descriptors and assets for distributing the app via TestFlight for beta testing.

• Added section on monetary precision to PSDK documentation.

• Added bug fix for checking nullptr in for nexo CardAcquisitionResponse.

• Java Reference app was added to the PSDK documentation. Also, the downloadable zipped Reference Apps were corrected to contain the proper Reference Apps.

• Implemented signatureOverride flag for slim hosts to be able to return whether the host response says the transaction is authorized with signature or not.

• Log SDI Client messages.

• Updated an internal SCA bug to Correct length of INVOICE in start session and payment operations.

• Added command for GRATUITY_ADJUSTMENT transaction for SCA terminals.

• Updated “STORE_VALUE” to “GIFT” in PSDK code for SCA Terminals.

• Added logging of COUNTER mismatch for SCA.

• Added an API to deactivate Gift cards.

• Fixed an internal SCA bug to correct the validated_id length for Lane numbers.

• Fix Internal windows scripts not to ignore recently deprecated APIs.

• Added a new content type for Reference Id and enabling it to be sent or rejected appropriately.

• Enabled MFi communication for SDI connectivity. Added support to validate MFi initialization parameters and fixed code to properly handle concurrency.

• Implemented pmr2-mux protocol over BT-SPP

• Updated the sci protocol driver to restart listening after the client has disconnected.

• Updated PSDK Documentation to include the Windows dependency on VS redistributable.

• Implemented PPP state machine which talks serially over muxed channel 4 (debug channel) and bridges TCP/IP communication between the terminal and a TCP/IP connection on the POS platform.

• Fixed the bug in PSDK with recurring payment for Nexo terminals.

• Fixed a bug in CardInformation.getTokens() API to return proper data on Nexo terminals

• Fixed an internal bug to support Keyed entry for gift cards unload action for SCA terminals.

• Implemented to retrieve device version as per SCA specification.

• On Nexo terminals fixed a bug to always include the ReceiptReprintFlag in the TransactionStatusRequest message.

• Fixed a bug with Merchant Cashout only for Nexo terminals

• Updated the PSDK jar files to include both 32bit and 64 bit Dlls for windows platform.

• Fix Internal windows scripts not to ignore recently deprecated APIs.

• The extended settings screen was integrated to Java and Kotlin version of the PSDK Reference Application.
• This extended barcodes configuration screen allows you to select the group of barcodes that will be used for the hardware scanner.

• Enabled TransactionManager.abort() to also abort pending input requests that are sent from the POS, instead of just payment and other similar commands.

• Added Shutdown event Notification handling on PSDK.

• Added a new library artifact to support Windows .NET 5.

• Added new transaction types to support recurring payments.

• The documentation was updated to add a section covering the multi-currency use case.

• iOS payment sdk was updated to better handle dynamically discovering the the library during apple App Store deployment.

• Added Fully integrated,Semi integrated and Slim integrated Java reference applications.

• Enabled requested numeric input to contain leading 0’s and symbols related to phone numbers in various regions.

• Update to use same ServiceId between the PrintRequest and PrintResponse

• Updated the PSDK jar files to include both 32bit and 64 bit Dlls for windows platform.

• Enabled the transaction query for the most recent transaction to work even when there is no active contextual information about that transaction.

• Unused barcodes were removed from the UI of the PSDK Reference Application written in Java.

• iOS VFIDecimal initialize function was fixed to support edge cases where amount ends with zero cents.

• Fixed cases when the default transaction amount is required for SCA terminals.

• Enabled the transaction query for the most recent transaction to work even when there is no active contextual information about that transaction.

• Added support for EBT balance check.

• Enabled EBT refunds to work with SCA terminals.

• Updated the ReconciliationEvent to have the Closing summary containing various totals if sent by the host.

• Enabled receipts to be reprinted using the AppSpecificData field of the Payment object.

• Added support for Keyed entry for gift cards actions (activate, load, and unload, etc) for SCA terminals.

• Added method getAmountAvailableForRefund() to Payment.

• Fixed defect where we still used the card data from getCardData for the payment even after abort was called if the card data was actually retrieved.

• Fixed ReportManager reports when a TransactionType.GRATUITY_ADJUSTMENT has been performed.

• Fixed an issue to enable the POS apps to refuse the PrintEvent.

• Added the reconciliation ID field to the transaction query for Nexo and SCA terminals.

• Added support for change of password and reset of password at the POS (including off-device POS systems). Payment Application and POS application changes are required to support this feature.

• Updated Documentation for android reference apps to use JDK1.8

• Fixed an overflow issue for 32-bit systems conversion from bitset<40> to unsigned long for SDI

• Fixed an issue with SCA where the wrong amount was returned as the approved amount for a partial authorization.

• Updated stored value transactions to parse and send the receipts to POS if the receipts are sent by the SCA payment application.

• Updated Debit payments to also include the word DEBIT as the brand so that existing integrations could more easily construct the receipt.

• Enabled documentation output for the .NET library.

• Fixed an issue with SCA where the wrong message was being sent to the device to tokenize a card.

• Enabled TCP/IP standard heartbeat to detect connection issues faster for SCA terminals.

• Enabled Device Tampered event notification when using AGPA or GPA.

• Enabled VCL crypto information to be sent and received for general card data and for payments.

• Added ReceiptType.Document to enable printing of reports and other documents.

• Fixed an issue in the .NET library when calling initialize after tearing down.

• Added example code for CTLS and CT configurations, and Callback mode for pin entry requests.

• Added the missing SignatureVerified field in vf_Signature for Nexo InputResponse message parsing.

• This is a public facing fix that applies only to the .NET library.Added implicit conversion to avoid API change for nullable types.

• Updated PSDK documentation to create proper SDI reference app zip files and point to the SDI reference apps to download when building documentation for SDI.

• Updated to use RecyclerView from AndroidX.

• Fixed Nexo deserializing Signature field in InputRequest message.

• Correctly passing the card acquisition reference when retrieving card data then performing a payment that should use the previously collected card data.

• Added conversion from UTF-16 (.NET) to UTF-8 (native) and back

• Now generates a random pairing PIN when first connecting to an SCA terminal, instead of a fixed PIN of “1234”.

• CardInformation.getBin() now returns an 8-digit bin based on the card. When returning an 8-digit bin, getLast4() will return two masked characters followed by two digits, preserving the PCI requirements.

• Added a section to the PSDK documentation describing the fully transparent (sdi) transaction flows and associated PSDK APIs.

• Implemented a new API requestDeviceVitals() to get the diagnosis information from the terminals. Currently none of the terminals are supporting this request yet.

• Added the AccountType::PINLESS_DEBIT to indicate when a transaction has been converted from credit to PIN-less debit.

• Add a list of currencies into the merchant

• Enabled plain text receipts when communicating with SCA terminals in North America.

• Correctly passing the card acquisition reference when retrieving card data then performing a payment that should use the previously collected card data.

• Removed autogenerated IDispatch interface from .NET Decimal class

• Resolved an issue in .NET and COM where a string-to-string map would not convert correctly, instead being passed as an empty map.

• Add SignatureType in CapturedSignature class

• TerminalData field added to API to pass custom/regional POS-to-payment application data.

• Reading the values from SCA terminals for Payment.getRetrievalReferenceNumber().

• Updated the encryption API to accept arbitrary data for encryption and allow multiple options to be sent at once for the encryption settings.

• Created code generator for COM library
• Added client application to test COM dll

• Payment Request was enhanced to contain the selected Alternative Payment Method.

• Added tests to verify that localized currency string is honoring the currency symbol position.

• Enabled to have captured signature under “_vf_Signature”(for Vim/Cobra) fragment when PSDK sends input response.

• Fixed an issue for iOS where the library would crash during a race condition when Bluetooth disconnects unexpectedly by updating the code to check if the stream is already closed before closing it programmatically.

• Abort functionality was enhanced to generate the proper abort request based on if card data was already collected.

• Added signature to dll for win32 and x64.

• Changed the DeviceScanListener API to un-capitalize the first letter of each method.

  • ScanStarted-> scanStarted
  • DeviceFound-> deviceFound
  • DeviceLost-> deviceLost
  • ScanEnded-> scanEnded

• Changed the SDI Callback API names to clearly identify the callback’s purpose and de-duplicate names to fix collisions in the Windows release.

  • SdiStatusCallback API changes:
  • callback-> statusCallback
  • SdiControlCallback API changes:
  • callback-> controlCallback
  • SdiEmvCallback API changes:
  • callback-> emvCallback
  • SdiNotifyCallback API changes:
  • callback-> notifyCallback
  • SdiNavigatorCallback API changes:
  • callback-> navigatorCallback
  • SdiCardDetectCallback API changes:
  • callback-> cardDetectCallback

Fixed bugs in uwp reference app.

Added null checker in sdk.

• Add setCustomerNote() and getCustomerNote() in Payment and TransactionQuery
• Update SaleData and TransactionReportRequest to add VF_CustomerNote field

• Added new class MerchantAccount which can be added to a Payment.
• Added new APIs to Payment for setting and getting the MerchantAccount.

• PaymentSDK now supports .NET Framework library.
• Added .NET code snippets to documentation.
• Added .NET reference app example to documentation.
• Added .NET API reference section

• PaymentSDK now supports Java for Mac, Windows, and Linux platforms.
• Added Java API reference
• Added Java code snippets to documentation

Added new feature of delayed charge to process a supplemental account charge after original services have been rendered and respective payment has been processed. This is used in pre-auth transactions.

Added new PaymentType.DELAYED_CHARGE for performing the delayed pre-auth charge.Added new PaymentOperation.DELAYED_CHARGE for expressing delayed charges in the payment operation histories.

The feature will return unsupported operation status code on terminals that don’t support it.

Added new DeviceManagementAction VCL_ADVANCE_DDK to advance the master key. Response DeviceManagementEvent will contain track1 and track2 data on success. These can be accessed with DeviceManagementEvent.getValue() using DeviceManagementEvent.TRACK1_KEY and DeviceManagementEvent.TRACK2_KEY.

For slim integrations only.

Added new DeviceManagementAction VCL_REGISTRATION to register the device with the VCL/VSP service. Response DeviceManagementEvent will contain track1 and track2 data on successful registration. These can be accessed with DeviceManagementEvent.getValue() using DeviceManagementEvent.TRACK1_KEY and DeviceManagementEvent.TRACK2_KEY.

For slim integrations only.

Added new DeviceManagementAction VCL_BIN_UPDATE to consume a previously loaded VCL BIN file. Response DeviceManagementEvent will contain track1 and track2 data on successful registration. These can be accessed with DeviceManagementEvent.getValue() using DeviceManagementEvent.TRACK1_KEY and DeviceManagementEvent.TRACK2_KEY.

For slim integrations only.

Added new DeviceManagementAction VCL_ADE_BLOB to retrieve the ADE blob. Response DeviceManagementEvent will contain ADE blob of data on success. This can be accessed with DeviceManagementEvent.getValue() using DeviceManagementEvent.ADE_BLOB_KEY.

Added new DeviceManagementAction VCL_RETRIEVE_VSP_CONFIG to retrieve the VSP config. Response DeviceManagementEvent will contain VSP config info on success. This can be accessed with DeviceManagementEvent.getValue() using:

For slim integrations only.

DeviceManagementEvent.VSP_FIRMWARE_VERSION_KEY

DeviceManagementEvent.MDK_LABEL_KEY

DeviceManagementEvent.ENCRYPTION_STATE_KEY

DeviceManagementEvent.VSP_STATE_KEY

DeviceManagementEvent.VSP_MODE_KEY

DeviceManagementEvent.BIN_TABLE_ID_KEY

DeviceManagementEvent.ENCRYPTION_ALGORITHM_KEY

DeviceManagementEvent.OPERATION_MODE_KEY

DeviceManagementEvent.INITIAL_KEY_ID_KEY

DeviceManagementEvent.CONFIG_ID_KEY

Fixed deadlock condition when performing a PaymentSdk.tearDown with SCA terminals.

Added connection keep-alive support for SCA terminals. Send keep-alive messages at 5-minute intervals and reporting a connection loss if the terminal doesn’t respond within 60 secs.

iOS arguments and return values in APIs with optional enums are automatically converted to an optional NSNumber due to an objective-c limitation.

With changes in this ticket, when these APIs are exposed to Swift, they will now take and return optional PSDK enumerations instead of Optional NSNumbers.

How these changes impact integration:

If you are integrating into Objective-C:

If you are integrating into Swift:

you will not have any impact by the changes in this ticket

you will continue to convert the enum to an NSNumber when using APIs that has an optional enum

For APIs that takes in an optional enum as an argument, you will no longer need to convert it to an NSNumber using the raw value of the enum, instead, you can pass in nil or the PSDK enum

For APIs that return an optional enum, you will no longer need to convert the returned NSNumber to the enum. Apis will return the PSDK enum or nil

Add maintenance support started/ended event notifications. New event notification types:

NotificationType.BEGIN_MAINTENANCE

Notification.END_MAINTENANCE

If a terminal has reported BEGIN_MAINTENANCE then the PSDK will automatically advance to the state of logging out.

Added private and internet capability to Windows package manifest.

Updated documentation on how to enable private network capability.

Added fields HistoricalBytes and ApplicationData to TechAltPaymentRequest trigger.

Added ErrorDescription field to TechAltPaymentResponse trigger.

Added new Payment field reference timestamp to be used in conjunction with reference payment ID. These two fields are used for performing gap payments.

New APIs: Payment::setReferenceTimestamp and Payment::getReferenceTimestamp.

Enhancement to support an externally managed connection to a terminal.

Created a method to pass an existing terminal connection to the PSDK during initialize.

Added new event notification types for terminals that support them:

WAITING_FOR_CUSTOMER_APP_SELECTION

WAITING_FOR ACCOUNT

WAITING_FOR_PIN

WAITING_FOR_TIP

WAITING_FOR_SURCHARGE

WAITING_FOR_CURRENCY

DEVICE_TAMPERED

WAITING_FOR_CASH

WAITING_FOR_SIGNATURE

Added support for plain text receipts in Receipt object.

New API Receipt::getAsPlainText()

Added support for gratuity adjustment on completed payments for terminals that support it.

New TransactionType::GRATUITY_ADJUSTMENT to be used with TransactionManager::startPayment.

New TransactionManager::GRATUITY_ADJUSTMENT_CAPABILITY to be used with TransactionManager::isCapable.

Added localization for an error condition.

Changed Event message for NEXO terminals to only include the additional response returned by the terminal.

Added Targets ElementAcquirerId and PaymentAppSpecificData for transaction_report_request.

Also modified transaction search request to update a valid invoice id from payment’s app_specific_data

Added functionality to generate an error if CreateSession was called multiple times in a transaction.

Updated the iOS Reference App so it only allows the user to click one button at a time eliminating the possibility of calling the same API multiple times.

Corrected API documentation for ReportManager::getTotalsForGroup.

Corrected following ReportManager apis to pass optional values to match API documentation, getTotalsForGroup, closePeriodAndReconcile ,reconcileWithAcquirers.

Added optional amount breakdown to transaction context to allow CP applications to accumulate shift/ transaction totals. Added below fields to transaction context.

CashBack_Amount

Gratuity_Amount

Tax_Amount

Surcharge_Amount

For basket operations If amount totals are passed as null or unset, send the event back with INVALID_ARGUMENTS and message as “Unable to perform basket operation with invalid amount totals”.

Updated basket manager APIs and basket flow documentation about amount totals as a required field.

Updated the Windows API to make it consistent across all platforms.

Changes to the Android, iOS, and Linux APIs:

Removed unused AccessibilityError enum.

Removed deprecated constants SESSION_START_FAILED, SESSION_RESUME_FAILED, and SESSION_END_FAILED from TransactionManager.

Changed RequestParameters.setIsFromRightToLeft to setFromRightToLeft

Changed MenuEntry.setIsSelectedByDefault to setSelectedByDefault.

For Windows, enabled the PerformDeviceManagement API, consistently use UWP properties for fields, fixed some constant and API names to be consistent with the documentation and the other platforms.

Updated the iOS build process to follow the latest recommendations from apple to generate a Universal Binary that support OS64 and SIM64.

The documentation has been updated to reflect the updated name of the framework “PaymentSdk.xcframework”. If you have a previous version of the PaymentSdk.framework, you will have to remove it from your codebase, remove it from the project settings (Embedded Framework), and add the new PaymentSdk.xcframework.

Adding a new API to Payment class for querying the payment operation history:

const getOperationsHistory(): list<PaymentOperationHistory>

This new call allows to get history of operations performed on a payment, including, but not limited to pre-authorizations. The new PaymentOperationHistory type provides the following fields via getters appropriate for your platform:

//The operation amount

amount: optional<Decimal>;

//Whether operation was authorized

authorized: optional<bool>;

//Operation timestamp

timestamp: string;

//Operation type

payment_operation: PaymentOperation;

Improvements to the presentation of the release notes

Improvements to the presentation of the integration diagrams.

Added CommerceListener2 & CommerceListenerAdapter migration guide to documentation.

Updated the code examples to use the CommerceListenerAdapter.

API Change

Bug fix

Windows we removed the PaymentSdk::sendEventResponse method. This method only existed on the Windows platform and is redundant to TransactionManager::sendEventResponse.

Windows we fixed handling print events.