Volt Android SDK/io.volt.sdk.model

Package-level declarations

Types

AmountType

enum AmountType : Enum<AmountType>

Determines how MandateLimits.amount is enforced: as an exact fixed amount, or as a maximum.

Currency

enum Currency : Enum<Currency>

Supported currencies

InstitutionData

data class InstitutionData(val id: String, val name: String, val logoUrl: String?, val countryCode: String) : Parcelable

Institution data

InstitutionInitiationData

data class InstitutionInitiationData(val currency: Currency, val defaultCountryCode: String?, val isInstitutionFirstTimeSelection: Boolean) : Parcelable

Data required to initiate institution selection

MandateCommunication

data class MandateCommunication(val notificationUrl: String) : Parcelable

Partner communication settings for the mandate: where Volt should send status notifications.

MandateCurrency

enum MandateCurrency : Enum<MandateCurrency>

Supported currencies for recurring payments

MandateData

data class MandateData(val mandateId: String, val status: MandateStatus?, val validity: MandateValidityData) : Parcelable

PayTo mandate information.

MandateLimits

data class MandateLimits(val limitsPeriod: PayToLimitsPeriod, val maxPaymentsCount: Int?, val amount: Int, val amountType: AmountType) : Parcelable

MandatePayerData

data class MandatePayerData(val reference: String, val firstName: String?, val lastName: String?, val email: String?) : Parcelable

MandateSetupData

data class MandateSetupData(val currency: MandateCurrency, val internalReference: String, val payerData: MandatePayerData, val validity: MandateValidityData, val limits: MandateLimits, val description: String, val communication: MandateCommunication) : Parcelable

Data required to set up a recurring payment.

MandateStatus

enum MandateStatus : Enum<MandateStatus>

Mandate statuses.

MandateValidityData

data class MandateValidityData(val from: ZonedDateTime?, val to: ZonedDateTime?) : Parcelable

PayerData

data class PayerData(val reference: String, val firstName: String?, val lastName: String?, val organisationName: String?, val email: String?, val phoneNumber: String?) : Parcelable

Information about the payer

PaymentData

data class PaymentData(val paymentId: String?, val status: PaymentStatusData?, val institutionData: InstitutionData?) : Parcelable

Payment information

PaymentInitiationData

data class PaymentInitiationData(val currency: Currency, val amount: Int, val defaultCountryCode: String?, val institutionData: InstitutionData?, val paymentReference: String?, val internalReference: String?, val userAgent: String, val payer: PayerData, val transactionType: TransactionType) : Parcelable

Data required to initiate payment

PaymentStatusData

enum PaymentStatusData : Enum<PaymentStatusData>

Payment statuses

PayToLimitsPeriod

enum PayToLimitsPeriod : Enum<PayToLimitsPeriod>

How often periodic limits reset.

TransactionType

enum TransactionType : Enum<TransactionType>

Enum of the transaction type