m8ty-dto - m8ty Data Transfer Objects/eu.m8ty.dtos.pis

Package-level declarations

Types

BeneficiaryAutocompleteRequestDto

data class BeneficiaryAutocompleteRequestDto(var search: String)

Search for Autocompletion

BeneficiaryAutocompleteResponseDto

data class BeneficiaryAutocompleteResponseDto(var beneficiaryData: MutableList<BeneficiaryMetaDataDto>? = null)

List of beneficiary metadata found during the search.

BeneficiaryMetaDataDto

data class BeneficiaryMetaDataDto(var accountId: String, var counterpartName: String, var iban: String, var bic: String? = null)

Metadata from referrals that match the search

CreatePaymentFinApiWebFormCallbackDto

data class CreatePaymentFinApiWebFormCallbackDto(var webFormId: String, var status: WebFormStatusDto)

Callback details from finAPI WebForm

CreatePaymentResponseDto

data class CreatePaymentResponseDto(var paymentId: String, var webFormURL: String, var status: WebFormStatusDto? = null, var paymentStatus: PaymentStatusEnumDto? = null)

Response object creating a payment.

FrequencyEnumDto

enum FrequencyEnumDto : Enum<FrequencyEnumDto>

Frequency in which the payment is to be repeated. Values: WEEKLY,TWO_WEEKLY,MONTHLY,TWO_MONTHLY,QUARTERLY,SEMI_ANNUAL,ANNUAL

PaymentCounterpartDto

data class PaymentCounterpartDto(var iban: String, var name: String, var bic: String? = null)

Details of the counterpart of a payment.

PaymentDetailsDto

data class PaymentDetailsDto(var amount: AmountDto, var purpose: String, var counterpart: PaymentCounterpartDto, var sepaPurposeCode: String? = null, var endToEndId: String? = null)

Details of a payment.

PaymentDto

data class PaymentDto(var accountId: String, var details: MutableList<PaymentDetailsDto>, var executionDate: LocalDate? = null, var standingOrder: PaymentStandingOrderInfoDto? = null, var batchProcessing: Boolean? = null, var instantPayment: Boolean? = false)

Information to trigger the payment.

PaymentResponseDto

data class PaymentResponseDto(var executionDate: LocalDate, var accountId: String, var details: MutableList<PaymentDetailsDto>, var paymentType: PaymentTypeEnumDto, var standingOrder: PaymentStandingOrderInfoDto? = null, var batchProcessing: Boolean? = null, var instantPayment: Boolean? = false, var paymentId: String? = null, var paymentStatus: PaymentStatusEnumDto? = null, var status: WebFormStatusDto? = null)

Payment Response

PaymentResponseListDto

data class PaymentResponseListDto(var payments: MutableList<PaymentResponseDto>? = null)

List of payments

PaymentSearchRequestDto

data class PaymentSearchRequestDto(var accountId: String? = null, var paymentType: PaymentTypeEnumDto? = null, var purpose: String? = null, var counterpartName: String? = null, var paymentStatus: PaymentStatusEnumDto? = null)

Filter for Payments search. If an empty object is specified, all payments of the customer will be returned.

PaymentStandingOrderInfoDto

data class PaymentStandingOrderInfoDto(var frequency: FrequencyEnumDto, var endDate: LocalDate? = null)

Standing Order details

PaymentStatusEnumDto

enum PaymentStatusEnumDto : Enum<PaymentStatusEnumDto>

Status of a payment on Bank side.

PENDING - Payment was not executed by the Bank
COMPLETED - Payment was successfully executed by the Bank
COMPLETED_PARTIALLY - Batch Payment was partially successfully excecuted by the Bank

Values: PENDING,COMPLETED,COMPLETED_PARTIALLY

PaymentStatusResponseDto

data class PaymentStatusResponseDto(var status: WebFormStatusDto, var paymentStatus: PaymentStatusEnumDto? = null)

Status of the payment

PaymentTypeEnumDto

enum PaymentTypeEnumDto : Enum<PaymentTypeEnumDto>

Payment Type Values: SEPA_PAYMENT,INSTANT_PAYMENT,STANDING_ORDER