1. Documentation
  2. AppFlow
  3. Introduction
  4. Guides

Guides


Get started

AEVI AppFlow enables applications to interact via point of sale flows from integrating with the open source Android SDK. These applications can initiate flows or get called inside the flows to perform a function, such as loyalty, ratings or to process the payment via any suitable payment method.

Based on what function your application provides, you can integrate with AppFlow by following one of our integration guides below:


POS applications

Enables applications to initiate flows for various functions such as sale, refund and tokenisation + allows querying for AppFlow information. Get started -->


Value added applications

Provides the ability for applications (such as loyalty schemes or rating services) to read and augment data at different stages of the flow. Get started -->


Payment applications

Allows integration with AppFlow to process payment related requests, using any payment method of their choice (e.g. card or invoice). Get started -->


AppFlow compliance

Due to the flexible nature of AppFlow, it is important that your application deals with flows and data correctly. These pages assist in making sure your app is AppFlow compliant and play well with other applications:


Flow Types

Definitions of the different types of flows and associated data. Read more -->


Reference Values

Details on what information can be passed through AppFlow. Read more -->


Implementation Checklists

Ensure your application plays well with AppFlow. Read more -->


Checklists

Checklists to help you ensure your application is AppFlow compliant

General

  • Proguarding your app? -> Ensure your have added the AEVI ProGuard rules to your configuration file
  • Ensure you have added the correct permissions in the manifest
  • Make sure you implement the onError callback for any Rx calls to the API

Flow Initiation

  • Ensure that you have implemented the response listeners so that your application receives flow outcomes, and launch appropriate user interface to present the outcomes
  • Ensure you handle errors properly and present these to the merchant as appropriate
  • Make sure to query for relevant information to check what the supported flows and currencies are, etc
  • Make sure you finish() any activity after you have received confirmation that the flow was initiated successfully
  • Review that you are using the correct types and data for when you create requests to initiate a flow

Flow Services

  • It is very important that you expose the correct information about your application
  • Ensure your service/activity that handles the requests deals with unknown request types and/or missing/incorrect data properly and sends back the appropriate response for these cases
  • Make sure to subscribe to and handle flow service events properly
  • Ensure your application activites have the recommended maniflags set in order to behave correctly in a flow
  • Review that you are handling types and data correctly as per documentation to ensure inter-app compatibility

Payment apps

  • Important! Make sure to use the correct structure for processed amounts
  • If you support both PAYMENT_CARD_READING and TRANSACTION_PROCESSING, ensure that the latter stage can also read payment cards as the card reading stage is optional in a flow