Skip to main content

POS API | Getting Started

The process to get started with the POS API is outlined in the table. Note that each step is its own process.

Step

Topic

Description

1

Getting Started with APIs

Steps to obtain an integrator token and additional information about our APIs.

2

Confidentiality Statement

Information about our non-disclosure agreement (NDA) terms and conditions regarding endpoints.

3

API Prerequisites

A list of prerequisites to complete before starting the integration development process.

POS API | Next Steps

The next steps for POS API integration, if applicable, are outlined in the table. Note that each step is its own process.

Step

Topic

Description

1

Order Object

Information on the POS Order Object including field names and descriptions and code samples.

2

Payment Object

Information on the POS Payment Object including field names and descriptions and code samples.

3

Creating a Plugin for XPOS

Steps to create a plugin for POS and includes a flow diagram.

4

Custom Payment Adapter

Steps to setup a custom payment adapter including the fields and objects, payment adapter methods, and connection adapter methods.

5

Enable FreedomPay Service

Steps to enable the FreedomPay Service for POS with data flows.

6

Device Bridge Implementation

Steps to implement a device bridge for POS including installation and configuration information.