reference values - AEVI-AppFlow/pos-android-sdk GitHub Wiki
This page contains references to AEVI defined keys, values and formats. If you are looking for how to pass data for specific use cases, such as ads/promotions, receipts, etc, please see Use Case Driven Data. In addition, there may be acquirer projects that define their own set of types in addition to these. Please contact AEVI for these scenarios.
Although AEVI does not force nor restrict what keys or values are used by applications, developers should always look to this for commonly used values 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.
See AdditionalData Howto for detailed information about how to read or write data of any type.
- Request Types
- Payment Methods
- Card Details
- Customer Details
- Account Types
- Additional Amounts
- Transaction Response References
- Augmented Data
These flags can be provided in the Payment or Request additional data by the client, or any flow service, to instruct or inform applications in the flow. For flags relevant for payment applications specifically, see next section.
| Data key | Value type | Format / Example | Used to |
|---|---|---|---|
| "transactionLanguage" | String | ISO 639-1 two-letter language code, example "en" | Used to instruct other applications of the language of the transaction, allowing them to show text, etc in the correct language |
| "accessibleMode" | Boolean | true / false | Whether or not apps should cater for visual impairment |
These flags, in addition to the more generic ones above, can be provided in the Payment (or Request) additional data by the client, or any flow service, to instruct or inform payment applications.
| Data key | Value type | Format / Example | Used to |
|---|---|---|---|
| "merchantId" | String | alpha-numeric | Used to specify what merchant initiated the flow in the case of multi-merchant environments |
| "cardEntryMethods" | String[] | ["insert", "swipe", "tap"] | Used to instruct the payment app what card entry methods to make available to the customer |
| "cardNetworks" | String[] | ["visa", "mastercard", "jcb"] | Used to instruct the payment app what card schemes to allow for card presentation |
| "accountTypes" | String[] | ["savings", "credit"] | Used to instruct the payment app what account types to support for the transaction |
These flags are used for various purposes where the concepts covered are required. As an example, if any scenario requires an amount to be passed, the data key "amount" as outlined here should be used.
| Data key | Value type | Format / Example | Used to |
|---|---|---|---|
| "transactionId" | String | alpha-numeric | Specify a particular transaction |
| "amount" | Amount | Represents an amount | To pass amount details |