Definitions
Input/output definitions
AuthenticateData
| Parameter name | Parameter type | Note |
|---|---|---|
| sessionURL | String | URL must be opened before the session expires. If the session expires, a new SCA must be initiated. |
PaymentData
| Parameter name | Parameter type | Fallback | Note |
|---|---|---|---|
| sessionId | String | null | |
| sessionKey | String | null | |
| transactionType | String | null | HYBRID, SINGLE Distinguish DPA Payment UI implementations if both types are used by DPA |
| paymentInstruments | PaymentInstrument[] | listOf() | |
| transactionDetailsRequest | TransactionDetails | null | |
| merchantId | String | null | |
| merchantName | String | null | |
| merchantReference | String | null | Previously "orderId" |
| proprietaryData | ProprietaryData | null |
TransactionDetails
| Parameter name | Parameter type | Fallback | Note |
|---|---|---|---|
| amount | String | null | BigDecimal format. e.g. DPA is responsible for localization with currency. |
| cashBackAmount | String | null | BigDecimal format. e.g. DPA is responsible for localization with currency. |
| currency | String | null | e.g. "EUR" ISO-4217 |
| remainingAmount | String | null | BigDecimal format. e.g. DPA is responsible for localization with currency. |
| requestedAmount | String | null | BigDecimal format. e.g. DPA is responsible for localization with currency. |
ProprietaryData
| Parameter name | Parameter type | Fallback | Note |
|---|---|---|---|
| salesDate | String | null | |
| attributes | ProprietaryDataAttribute[] | listOf() |
ProprietaryDataAttribute
| Parameter name | Parameter type | Fallback | Note |
|---|---|---|---|
| key | String | null | |
| value | String | null |
👇 SignPaymentData
| Parameter name | Parameter type | Note |
|---|---|---|
| chosenPaymentInstrumentId | String | The id of the payment instrument. Selected by the user in the payment UI. Optional: If payment instrument(s) are pre-selected and can not be changed by the user, omit SignPaymentData during signPayment. ⚠️ Will become deprecated. |
| 🆕chosenPaymentInstrumentIds | String[] | The ids of the payment instruments. Optional: If payment instrument(s) are pre-selected and can not be changed by the user, omit SignPaymentData during signPayment. If single payment: One instrument, selected by the user in the payment UI. If hybrid payment: All instruments, sorted in correct priority order, selected by the user in the payment UI. Will be used instead of chosenPaymentInstrumentId. |
PaymentResult
| Parameter name | Parameter type | Fallback | Note |
|---|---|---|---|
| sessionId | String | null | |
| sessionKey | String | null | |
| transactionType | String | null | HYBRID, PAYMENT Distinguish Payment UI implementations if both types are used by DPA |
| paymentInstruments | PaymentInstrument[] | listOf() | |
| transactionDetailsRequest | TransactionDetails | null | As originally sent to the DPA. |
| transactionDetailsResult | TransactionDetails | null | The details as used in the actual payment. (amounts can be changed due to authorization failures). |
| merchantId | String | null | |
| merchantName | String | null | DPA is responsible for translations |
| merchantReference | String | null | Previously "orderId" |
| proprietaryData | ProprietaryData | null |
PaymentInstrument
| Parameter name | Parameter type | Fallback | Note |
|---|---|---|---|
| id | String | null | |
| name | String | null | A pre-defined key for payment instrument display name E.g. "monizze_emv", "monizze_eco" DPA is responsible for display name and translations |
| nickname | String | null | Managed by user in the Wallets Dashboard |
| maskedPan | String | null | So consumer can identify payment instrument. Set to part of email or phone number for paymentInstrumentType “VOUCHER_CARD” DPA is responsible for formatting. |
| participatingPaymentSystem | String | null | MONIZZE, XTRA |
| status | String | null | See |
| logoUrls | LogoUrls | null | Participating Payment System (PPS) logos in different formats, hosted by Aera |
| PaymentInstrumentType | String | null | VOUCHER_CARD, CARD |
| amount | String | null | BigDecimal format. Available after initPayment: what will be deducted from this payment instrument. DPA is responsible for localization with currency. |
| payedAmount | String | null | BigDecimal format. Available after a signPayment payment result for partial payments: what was actually deducted. Might not match amount, and rather be deducted from fallback instrument or remainder to pay outside wallet. DPA is responsible for localization with currency. |
| currency | String | null | Available after a initPayment: Can be used for formatting of amount and payedAmount per instrument when displayed in a list. |
LogoUrls
| Parameter name | Parameter type | Fallback | Note |
|---|---|---|---|
| svgUrl | String | null | URL to the Aera hosted .svg |
SDKInfo
| Parameter name | Parameter type | fallback | Note |
|---|---|---|---|
| isInitialized | Boolean | null | Value from Secure ID. Implies whether Secure ID SDK is usable for signing or not. Returns true if user is onboarded and security requirements are met. Returns false if e.g. user is not onboarded, user has turned off device lock screen, deleted and re-downloaded the Mobile App on the same or other device. |
| walletsSDKVersion | String | null | The current Wallets SDK version |
| secureIdSDKVersion | String | null | The current Secure ID SDK version used by Wallets SDK |
Updated about 1 month ago