REST API

Recent Revisions to This Document

24.12

Updates:
Added information about resetting the passcode in Setting Up the PAX Terminal.
Added option for retrieving the Root CA Certificate in Retrieving the Root CA Certificate in the Business Center.
Moved endpoints information from REST Example sections to introductory sections. No technical changes were made as part of this update.

24.11

Updates:
Added details about supported terminal types in Terminals Supported by the PAX Semi-Integrated Solution.
Added newly supported Standalone mode transaction types: sale with installment details and sale with tax details. See Processing Payment Transactions in Standalone Mode.

24.10

October 31 updates:
Updated release version to Acceptance Devices app 1.8.0. See Acceptance Devices App Version 1.8.0 Release Notes.
Removed limitation for configuring a logo in the
Business Center
. See Customizing the Acceptance Devices App.
Added customization parameters in Customizable Standalone Mode Parameters.
Removed regional limitation of cashback transaction availability for Processing a Cashback in Semi-Integrated mode and Processing a Cashback in Cloud mode.
September 30 updates:
Updated release version to Acceptance Devices app 1.7.0. See Acceptance Devices App Version 1.7.0 Release Notes.

24.09

This revision contains only editorial changes and no technical updates.

24.08

Updates:
Added step for enabling custom merchant reference codes in Enabling Standalone Mode in the Acceptance Devices App.

24.07

Updates:
Updated release version to Acceptance Devices app 1.6.0. See Acceptance Devices App Version 1.6.0 Release Notes.

24.06

New features:
Added options for sending the transaction response in Communication Protocol Used in Cloud Mode.
Added feature for receiving transaction responses. See Receiving Transaction Responses Asynchronously.

24.05

Updates:
Added devices to list of supported PAX terminals in Terminals Supported by the PAX Semi-Integrated Solution.
Updated release version to Acceptance Devices app 1.5.0. See Acceptance Devices App Version 1.5.0 Release Notes.

24.04

Updates:
Added required field (
capture
) and updated REST API request example in Processing a Sale with On-Receipt Tipping.
Updated release version to Acceptance Devices app 1.4.0. See Acceptance Devices App Version 1.4.0 Release Notes.
New features:
Added 12 new transactions types in Processing Payment Transactions in Cloud Mode.

24.02

Applied general editorial updates. Made no technical information updates.

23.03

New release:
Released a new integration protocol, Acceptance Devices protocol, which replaces the ATICA (ISO20022) protocol. The Acceptance Devices protocol is now the default integration method for the PAX Semi-Integrated Solution.
New features:
Updates:
Updated payment transaction examples with the new Acceptance Devices protocol in Processing Payment Transactions in Semi-Integrated Mode.
Updated release version to Acceptance Devices app 1.1.0. See Acceptance Devices App Version 1.1.0 Release Notes.
Replaced "Syncing a Terminal with the Acceptance Devices App Server" section with Entering an Activation Code in the Acceptance Devices App. Updated instructions and screenshots.
Replaced "Generating a Set-Up Code for the Point-of-Sale System in the Acceptance Devices App" section with Generating a POS Connection Code for the Point-of-Sale System. Updated instructions and screenshots.
Added information about WebSockets channel in Communication Protocol Used in Semi-Integrated Mode.

23.02

Updates:
Renamed
ISV Hub app
to
Acceptance Devices app
and replaced related screenshots in Getting Started with the PAX Semi-Integrated Solution.
Updated release version to Acceptance Devices app 1.0.0.
Updated code example in Processing a Token Refund.
New sections:

23.01

Initial beta release.