scheduledpayment

Documentation

Index

• type ScheduledPayment

Types

type ScheduledPayment

type ScheduledPayment struct {
	ID               string
	User             user.User                          // FK -> users
	FinancialAccount *financialaccount.FinancialAccount // FK -> financial_accounts, nullable
	Card             *card.Card                         // FK -> cards, nullable
	Contact          contact.Contact                    // FK -> contacts
	DisplayName      string                             // req
	Description      string
	Amount           float64
	CurrencyCode     string // uses ISO-4127 standard
	IntervalDays     uint16 // req
	customtype.Auditable
}

ScheduledPayment interaction where an external agent (Contact) periodically requests financial assets from a User's FinancialAccount or Card.

Assets could come from either FinancialAccount directly or from a Card; both instruments are mutually exclusive.