Skip to content

Sales Manager Overview

The objective of every merchant is to complete sales and make a profit, so the Sale Managers component is probably the most important API in the Wirecard ePOS SDK. This topic provides a general introduction to the Sales Manager component and the key object it uses: Sale Request.

Here is a brief index of topics for all the actions applicable to a Sale:

Payments through several methods:

Sale and Payment Operations:

Sale Info:

Sale Receipt:

A Sample User Interface

To help you visualize the end-user functionality that needs to be created, the picture below shows a simple example of a user interface that we will use throughout this documentation. Of course, you are responsible for creating the UI on your own platform and in your programming language of choice, but this gives a feel for what the user interaction might look like before your code takes over and processes the sale request.

Minimum Information for a Sales Request

Most importantly, the UI picture above highlights the kind of information that you need to provide to the Sale Request object:

  • total amount of sale
  • currency
  • inclusive / exclusive tax indicator
  • payment method (i.e. the buttons at the bottom of the UI), with the supported payment methods that you can use, included but not limited to:
    • Card (i.e. Visa and Mastercard)
    • Cash
    • Alipay
    • WeChat Pay
  • sale items are conditional. Required if you have enabled cash management, optional otherwise. For each individual item, you need to provide at least:
    • Type of item
    • Price
    • Quantity
    • Tax to be charged
    • Total amount of item (basically price multiplied by quantity with respect to discount and tax)
  • id of cash register is also conditional. Required if you have enabled cash management, optional otherwise.
  • rest of parameters are optional

Note

For simplicity, in the Integrate section of this documentation website we use a sale example with just one item. Most of the code samples also use just a single item.