au.org.consumerdatastandards.api.banking.models.BankingPayee 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
public class BankingPayee {

    public enum Type {
        DOMESTIC,
        INTERNATIONAL,
        BILLER
    }

    @Property(
        description = "ID of the payee adhering to the rules of ID permanence",
        required = true
    )
    @CDSDataType(CustomDataType.ASCII)
    String payeeId;

    @Property(
        description = "The short display name of the payee as provided by the customer",
        required = true
    )
    String nickname;

    @Property(
        description = "A description of the payee provided by the customer"
    )
    String description;

    @Property(
        description = "The type of payee. DOMESTIC means a registered payee for domestic payments including NPP. INTERNATIONAL means a registered payee for international payments. BILLER means a registered payee for BPAY",
        required = true
    )
    Type type;

    @Property(
        description = "The date the payee was created by the customer"
    )
    @CDSDataType(CustomDataType.Date)
    String creationDate;
}