requests and data introduction - AEVI-AppFlow/pos-android-sdk GitHub Wiki

As outlined elsewhere in the documentation, AppFlow has been designed to be as flexible as possible. This is achieved via the generic Request and Response models, configurable flows, support for additional/custom/bespoke data for basically any scenario and so on. Bounded types such as enum are also avoided wherever possible.

This is to avoid limitations and restrictions and to support cases where third party applications define a private/internal API/contract for proprietary data. This section of the documentation is focused on documenting the various types of requests, what data can be passed for various requests and use cases, and what format this data is in. This is to ensure applications can set and read data in a compatible way.

Although AEVI does not enforce the use of this common set of definitions, developers should always look to this to ensure consistency with other applications.

If something you consider as common or general is missing here, or you have questions, please contact AEVI or raise a ticket for it.

All data keys and types are defined and documented on this wiki, but to make life easier for application developers, we also provide a constants library with all the relevant data keys, etc. Throughout the docs we also refer to various parts of that library that you can use for specific cases. See api-constants for more info.

• To find out about defined flows and how to initiate and handle these, see Request Types.
• To see how you can send or listen to status updates from other apps, see Status Updates.
• To look up data identifiers, format and descriptions, see Reference Values.
• To find out what data to read/write for a particular use case, see Use Case Driven Data
• To view acquirer/application specific data, see Bespoke Data.