au.org.consumerdatastandards.api.banking.models.BankingScheduledPaymentSet Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of api-model Show documentation

This artefact describes the Consumer Data Standards using Java classes and annotations in a way suitable for automatic generation of Open API Specification, documentation, Server Stub, Client Libraries and Reference Test.

There is a newer version: 1.1.1

Show newest version

package au.org.consumerdatastandards.api.banking.models;

import au.org.consumerdatastandards.support.data.*;

@DataDefinition(
    description = "The set of payment amounts and destination accounts for this payment accommodating multi-part payments. A single entry indicates a simple payment with one destination account. Must have at least one entry"
)
@CustomAttributes({
    @CustomAttribute(name = "x-conditional", value = "amount", multiple = true)
})
public class BankingScheduledPaymentSet {

    @Property(
        required = true
    )
    BankingScheduledPaymentTo to;

    @Property(
        description = "Flag indicating whether the amount of the payment is calculated based on the context of the event. For instance a payment to reduce the balance of a credit card to zero. If absent then false is assumed"
    )
    @CDSDataType(CustomDataType.Boolean)
    Boolean isAmountCalculated;

    @Property(
        description = "Flag indicating whether the amount of the payment is calculated based on the context of the event. For instance a payment to reduce the balance of a credit card to zero. If absent then false is assumed"
    )
    @CDSDataType(CustomDataType.Amount)
    String amount;

    @Property(
        description = "The currency for the payment. AUD assumed if not present"
    )
    @CDSDataType(CustomDataType.Currency)
    String currency;
}