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 | Note |
|---|---|---|
| sessionId | String | |
| sessionKey | String | |
| paymentInstruments | PaymentInstrument[] | |
| 🆕 transactionDetailsRequest | TransactionDetails | |
| ⚠️ tbs | PaymentDataToBeSigned | base64 encoded string |
| 🆕 merchantId | String | |
| 🆕 merchantName | String |
🆕 TransactionDetails
| Parameter name | Parameter type | Note |
|---|---|---|
| amount | String/BigDecimal | e.g. "90.75" Includes cashBackAmount |
| cashBackAmount | String/BigDecimal | e.g. "20.35" only one of remainingAmount or cashBackAmount can be greater than "0.00". |
| currency | String | e.g. "EUR" ISO-4217 |
| remainingAmount | String/BigDecimal | e.g. "20.00" only one of remainingAmount or cashBackAmount can be greater than "0.00". |
| requestedAmount | String/BigDecimal | e.g. "110.75" amount + remainingAmount = requestedAmount |
⚠️ PaymentDataToBeSigned
| Parameter name | Parameter type | Note |
|---|---|---|
| merchantId | String | |
| merchantName | String | |
| ⚠️ amount | String/BigDecimal | e.g. "90.75" Includes cashBackAmount. This is the same value as TransactionDetails.amount. |
| ⚠️ currency | String | e.g. "EUR" ISO-4217 |
| transactionId | String | UUID |
| orderId | String | |
| timestamp | String |
⚠️ SignPaymentData
Parameter name | Parameter type | Note |
|---|---|---|
chosenPaymentInstrumentId | String | The id of the payment instrument. Selected by the user in the payment UI. If payment instrument(s) are pre-selected and can not be changed by the user, omit SignPaymentData during signPayment. |
🆕 PaymentResult
| Parameter name | Parameter type | Note |
|---|---|---|
| sessionId | String | |
| sessionKey | String | |
| paymentInstruments | PaymentInstrument[] | |
| transactionDetailsRequest | TransactionDetails | As originally sent to the DPA. |
| transactionDetailsResult | TransactionDetails | The details as used in the actual payment. (amounts can be changed due to authorization failures). |
| merchantId | String | |
| merchantName | String |
⚠️ PaymentInstrument
Parameter name | Parameter type | Note |
|---|---|---|
id | String | |
name | String? | A pre-defined key for translating display names for the instrument. Must be translated by the customer. E.g. monizze_emv |
nickname | String? | Managed by user in the Wallets Dashboard |
maskedPan | String | So consumer can identify payment instrument. Set to email or phone number for paymentInstrumentType “VOUCHER_CARD” |
participatingPaymentSystem | String | MONIZZE, XTRA |
status | String | See |
logoUrls | LogoUrls | Participating Payment System (PPS) logos in different formats, hosted by Aera |
⚠️ PaymentInstrumentType | String | VOUCHER_CARD, CARD |
🆕 amount | String? | Available after initPayment: what will be deducted from this payment instrument. |
🆕 payedAmount | String? | 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. |
LogoUrls
| Parameter name | Parameter type | Note |
|---|---|---|
| svgUrl | String | URL to the Aera hosted .svg |
SDKInfo
Parameter name | Parameter type | Note |
|---|---|---|
isInitialized | Boolean | 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 | The current Wallets SDK version |
secureIdSDKVersion | String | The current Secure ID SDK version |
Updated 3 months ago