Skip to content

Using This Documentation

This topic has a brief overview of the sections of this documentation and how to use each of them. The sections display in the table of contents that always appears on the left side of the window. We refer to this as the Overall Table of Contents because there is also a table of contents on the right side of the window and this is referred to as the Chapter Table of Contents. The Chapter Table of Contents lists the headings that make up each individual chapter.

Note

On smaller screens and mobile devices, the Overall Table of Contents is not shown on the left side of the window. Instead, it is available through a burger-menu that displays in the upper-left corner of the window. The burger-menu looks like this:

Start

The Start section helps you get oriented. After this topic, there are two more really important ones you should read:

  • The mPOS Architecture topic is for the entire project team, but in particular, it is for the project manager. It helps you understand the big picture by providing basic information about the overall mobile Point of Sale (mPOS) architecture and how the Wirecard ePOS SDK fits into it. It describes the full circle of the payment process, from acceptance of the consumer's payment by the merchant to processing by Wirecard's Switch back-end to the Acquiring Platform, and ultimately, to the Issuer who charges the consumer for the payment.

  • The SDK Architecture topic introduces the nine components that comprise the Wirecard ePOS SDK. It is non-platform-specific so project managers should find it particularly useful in terms of familiarizing themselves with the key functionality of the SDK. Developers should also find it useful for understanding the overall design which applies to both the Android code and the iOS code.

Setup

The Setup section has several topics that describe how to set up your development environment for both iOS and Android, including automated and manual installs.

Integrate

The Integrate section is useful for everyone on your project team, although it is more for developers than project managers. It explains each of the individual components and it describes key concepts related to implementing the Wirecard ePOS SDK, such as how Sale Requests work, how payments are configured, how purchases, returns and reversals are processed.

It also has information on additional features such as the Inventory Manager which is where you can set up a product catalogue, as well as the Cash Manager component. The general descriptions of the components are non-platform-specific, however, platform-specific code is available in the chapters of this section. The code is conveniently stored in GIST. Code is available in the following languages:

  • Swift for iOS
  • Objective-C for iOS
  • Java for Android

References

The References section actually has hundreds of pages of useful information, particularly for developers.

  • The Reference - Android SDK topic, which is below the References section, has detailed object class, method and property information for all of the Java code. This link actually takes you to a sub-site that is auto-generated directly from the code itself. This section is for developers implementing the SDK using Java.

  • The Reference - iOS SDK topic, which is below the References section, has detailed object class, method and property information for all of the Objective-C code and Swift code. This link actually takes you to a sub-site that is auto-generated directly from the code itself. Included are useful class inheritance diagrams and collaboration diagrams. This section is for iOS developers implementing the SDK using Objective-C or Swift.

Glossary

If you are new to the world of payment transactions then you may find all the acronyms and other terminology a bit overwhelming. The Glossary addresses this by providing a complete list of acronyms and what they stand for, as well as definitions of all key terminology used in this documentation. This section is for everyone on the project team.