API Overview

Acceptance Devices | PAX Acceptance Devices App Integration Guide
- Recent Revisions to This Document
- VISA Platform Connect: Specifications and Conditions for Resellers/Partners

Introduction to Acceptance Devices | PAX Acceptance Devices App

Terminals Supported by the PAX Acceptance Devices App

Transaction Workflow for the PAX Acceptance Devices App

Getting Started with the Acceptance Devices App
- Setting Up a PAX Terminal
- Loading Printer Paper in a PAX Terminal with an Integrated Printer
- Activating a Terminal in the Acceptance Devices App
  - Generating a Terminal Activation Code in the Business Center
  - Generating a Terminal Activation Code Using a REST API Request
    - Required Fields for Generating a Terminal Activation Code
    - REST Example: Generating a Terminal Activation Code
  - Entering an Activation Code in the Acceptance Devices App
- Getting Started with the Acceptance Devices App Server
  - Starting the Acceptance Devices App Server
- Customizing the Acceptance Devices App
  - Customizable Common Parameters
  - Customizable Local Mode Parameters
  - Customizable Standalone Mode Parameters
  - Customizing Parameters in the Business Center
  - Retrieving Parameters Using a REST API Request
    - Required Fields for Retrieving Parameters Using a REST API Request
    - REST Example: Retrieving Parameters Using a REST API Request
  - Customizing Parameters Using a REST API Request
    - Required Fields for Customizing Parameters Using a REST API Request
    - REST Example: Customizing Parameters Using a REST API Request

Local Mode Payment Services
- Communication Protocol Used in Local Mode
- Retrieving the Root CA Certificate
  - Retrieving the Root CA Certificate in the Business Center
  - Retrieving the Root CA Certificate Using a REST API Request
    - Required Fields for Retrieving the Root CA Certificate Using a REST API Request
    - REST Example: Retrieving the Root CA Certificate Using a REST API Request
- Activating a Secure mTLS Connection
  - Generating a POS Connection Code for the Point-of-Sale System
  - Requesting Certificates for the Point-of-Sale System
    - Required Fields for Requesting Certificates for the Point-of-Sale System
    - REST Example: Requesting Certificates for the Point-of-Sale System
- Implementing Hostname Validation
- Processing a Sale
  - Required Fields for Processing an Sale
  - REST Example: Processing a Sale
- Processing a Refund
  - Required Fields for Processing a Refund
  - Optional Fields for Processing a Refund
  - REST Example: Processing a Refund
- Processing a Stand-Alone Credit
  - Required Fields for Processing a Stand-Alone Credit
  - REST Example: Processing a Stand-Alone Credit
- Requesting a Check Transaction Status
  - Required Fields for Requesting a Check Transaction Status
  - REST Example: Requesting a Check Transaction Status
- Processing a Cancel Transaction
  - Required Fields for Processing a Cancel Transaction
  - REST Example: Processing a Cancel Transaction
- Processing a Sale with On-Reader Tipping
  - Required Fields for Processing a Sale with On-Reader Tipping
  - REST Example: Processing a Sale with On-Reader Tipping
- Processing a Sale with On-Receipt Tipping
  - Required Fields for Processing a Sale with On-Receipt Tipping
  - REST Example: Processing a Sale with On-Receipt Tipping
- Processing a Tip Adjust
  - Required Fields for Processing a Tip Adjust
  - REST Example: Processing a Tip Adjust
- Processing a Token Refund
  - Required Fields for Processing a Token Refund
  - REST Example: Processing a Token Refund
- Processing a Pre-Authorization
  - Required Fields for Processing a Pre-Authorization
  - REST Example: Processing a Pre-Authorization
- Processing an Incremental Authorization
  - Required Fields for Processing an Incremental Authorization
  - REST Example: Processing an Incremental Authorization
- Processing a Capture
  - Required Fields for Processing a Capture
  - Optional Fields for Processing a Capture
  - REST Example: Processing a Capture
- Processing a Mail Order or Telephone Order Sale
  - Required Fields for Processing a Mail Order or Telephone Order Sale
  - REST Example: Processing a Mail Order or Telephone Order Sale
- Processing a Mail Order or Telephone Order Pre-Authorization
  - Required Fields for Processing a Mail Order or Telephone Order Pre-Authorization
  - REST Example: Processing a Mail Order or Telephone Order Pre-Authorization
- Processing a Mail Order or Telephone Order Account Verification
  - Required Fields for Processing a Mail Order or Telephone Order Account Verification
  - REST Example: Processing a Mail Order or Telephone Order Account Verification
- Processing an Account Verification
  - Required Fields for Processing an Account Verification
  - REST Example: Processing an Account Verification
- Processing an Offline Transaction
  - Enabling or Disabling Offline Mode
  - Processing an Offline Sale
    - Required Fields for Processing an Offline Sale
    - REST Example: Processing an Offline Sale
  - Processing an Offline Refund
  - Submitting an Offline Transactions Batch for Authorization
- Processing a Cashback
  - Required Fields for Processing a Cashback
  - REST Example: Processing a Cashback
- Processing a Sale with Installment Details
  - Required Fields for Processing a Sale with Installment Details
  - Optional Fields for Processing a Sale with Installment Details
  - REST Example: Processing a Sale with Installment Details
- Processing a Sale with Payment Facilitator Details
  - Required Fields for Processing a Sale with Payment Facilitator Details
  - Optional Fields for Processing a Sale with Payment Facilitator Details
  - REST Example: Processing a Sale with Payment Facilitator Details
- Processing a Sale with Tax Details
  - Required Fields for Processing a Sale with Tax Details
  - Optional Fields for Processing a Sale with Tax Details
  - REST Example: Processing a Sale with Tax Details
- Printing a Customer or Merchant Receipt
  - Required Fields for Printing a Customer or Merchant Receipt
  - REST Example: Printing a Customer or Merchant Receipt

Cloud Mode Payment Services
- Communication Protocol Used in Cloud Mode
- Generating a Bearer Token for Authentication
  - Generating a Bearer Token for Authentication
- Processing a Sale
  - Required Fields for Processing a Sale
  - REST Example: Processing a Sale
- Processing a Refund
  - Required Fields for Processing a Refund
  - Optional Fields for Processing a Refund
  - REST Example: Processing a Refund
- Processing a Stand-Alone Credit
  - Required Fields for Processing a Stand-Alone Credit
  - REST Example: Processing a Stand-Alone Credit
- Requesting a Check Transaction Status
  - Required Fields for Requesting a Check Transaction Status
  - REST Example: Requesting a Check Transaction Status
- Processing a Cancel Transaction
  - Required Fields for Processing a Cancel Transaction
  - REST Example: Processing a Cancel Transaction
- Processing a Sale with On-Reader Tipping
  - Required Fields for Processing a Sale with On-Reader Tipping
  - REST Example: Processing a Sale with On-Reader Tipping
- Processing a Sale with On-Receipt Tipping
  - Required Fields for Processing a Sale with On-Receipt Tipping
  - REST Example: Processing a Sale with On-Receipt Tipping
- Processing a Tip Adjust
  - Required Fields for Processing a Tip Adjust
  - REST Example: Processing a Tip Adjust
- Processing a Token Refund
  - Required Fields for Processing a Token Refund
  - REST Example: Processing a Token Refund
- Processing a Pre-Authorization
  - Required Fields for Processing a Pre-Authorization
  - REST Example: Processing a Pre-Authorization
- Processing an Incremental Authorization
  - Required Fields for Processing an Incremental Authorization
  - REST Example: Processing an Incremental Authorization
- Processing a Capture
  - Required Fields for Processing a Capture
  - Optional Fields for Processing a Capture
  - REST Example: Processing a Capture
- Processing a Mail Order or Telephone Order Sale
  - Required Fields for Processing a Mail Order or Telephone Order Sale
  - REST Example: Processing a Mail Order or Telephone Order Sale
- Processing a Mail Order or Telephone Order Pre-Authorization
  - Required Fields for Processing a Mail Order or Telephone Order Pre-Authorization
  - REST Example: Processing a Mail Order or Telephone Order Pre-Authorization
- Processing a Mail Order or Telephone Order Account Verification
  - Required Fields for Processing a Mail Order or Telephone Order Account Verification
  - REST Example: Processing a Mail Order or Telephone Order Account Verification
- Processing an Account Verification
  - Required Fields for Processing an Account Verification
  - REST Example: Processing an Account Verification
- Processing a Cashback
  - Required Fields for Processing a Cashback
  - REST Example: Processing a Cashback
- Processing a Sale with Installment Details
  - Required Fields for Processing a Sale with Installment Details
  - Optional Fields for Processing a Sale with Installment Details
  - REST Example: Processing a Sale with Installment Details
- Processing a Sale with Payment Facilitator Details
  - Required Fields for Processing a Sale with Payment Facilitator Details
  - Optional Fields for Processing a Sale with Payment Facilitator Details
  - REST Example: Processing a Sale with Payment Facilitator Details
- Processing a Sale with Tax Details
  - Required Fields for Processing a Sale with Tax Details
  - Optional Fields for Processing a Sale with Tax Details
  - REST Example: Processing a Sale with Tax Details
- Printing a Customer or Merchant Receipt
  - Required Fields for Printing a Customer or Merchant Receipt
  - REST Example: Printing a Customer or Merchant Receipt
- Receiving Transaction Responses Asynchronously
  - Receiving Transaction Responses Asynchronously
  - REST Example: Processing a Sale Asynchronously
  - Processing a Check Transaction Events
    - Required Fields for Processing a Check Transaction Events
    - REST Example: Processing a Check Transaction Events

Standalone Mode Payment Services
- Enabling Standalone Mode in the Acceptance Devices App
- Processing a Sale
- Processing a Refund
- Processing a Stand-Alone Credit
- Processing a Sale with On-Reader Tipping
- Processing a Pre-Authorization
- Processing a Capture
- Processing a Mail Order or Telephone Order Sale
- Processing an Account Verification
- Processing an Offline Transaction
  - Enabling or Disabling Offline Mode
  - Processing an Offline Sale
  - Processing an Offline Refund
  - Submitting an Offline Transactions Batch for Authorization
- Processing a Sale with Installment Details
- Processing a Sale with Tax Details
- Printing a Customer or Merchant Receipt
- Emailing a Customer Receipt

Release Notes for PAX Acceptance Devices App
- Acceptance Devices App Version 1.13.0 Release Notes
  - Improvements
- Acceptance Devices App Version 1.12.0 Release Notes
  - Improvements
- Acceptance Devices App Version 1.11.0 Release Notes
  - Improvements
  - Fixed Issues
- Acceptance Devices App Version 1.10.0 Release Notes
  - New Features
  - Improvements
- Archive of Release Notes
  - Acceptance Devices App Version 1.9.0 Release Notes
    - New Features
    - Improvements
  - Acceptance Devices App Version 1.8.0 Release Notes
    - Improvements
    - Fixed Issues
  - Acceptance Devices App Version 1.7.0 Release Notes
    - New Features
    - Improvements
    - Fixed Issues
  - Acceptance Devices App Version 1.6.0 Release Notes
    - Improvements
  - Acceptance Devices App Version 1.5.0 Release Notes
    - New Features
    - Improvements
    - Fixed Issues
  - Acceptance Devices App Version 1.4.0 Release Notes
    - New Features
    - Improvements
    - Fixed Issues
  - Acceptance Devices App Version 1.3.0 Release Notes
    - New Features
    - Improvements
    - Fixed Issues
  - Acceptance Devices App Version 1.2.0 Release Notes
    - Improvements
    - Fixed Issues
  - Acceptance Devices App Version 1.1.0 Release Notes
    - New Features

New Features

Added Arabic as a supported language.