models

package
v0.0.0-...-4043622 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Oct 16, 2020 License: Apache-2.0 Imports: 6 Imported by: 0

Documentation

Index

Constants

View Source
const (

	// AccountAttributesAccountClassificationPersonal captures enum value "Personal"
	AccountAttributesAccountClassificationPersonal string = "Personal"

	// AccountAttributesAccountClassificationBusiness captures enum value "Business"
	AccountAttributesAccountClassificationBusiness string = "Business"
)
View Source
const (

	// NewAccountTypeAccounts captures enum value "accounts"
	NewAccountTypeAccounts string = "accounts"
)

Variables

This section is empty.

Functions

This section is empty.

Types

type APIError

type APIError struct {

	// error code
	// Format: uuid
	ErrorCode strfmt.UUID `json:"error_code,omitempty"`

	// error message
	ErrorMessage string `json:"error_message,omitempty"`
}

APIError Api error swagger:model ApiError

func (*APIError) MarshalBinary

func (m *APIError) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*APIError) UnmarshalBinary

func (m *APIError) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*APIError) Validate

func (m *APIError) Validate(formats strfmt.Registry) error

Validate validates this Api error

type Account

type Account struct {

	// attributes
	Attributes *AccountAttributes `json:"attributes,omitempty"`

	// created on
	// Read Only: true
	// Format: date-time
	CreatedOn strfmt.DateTime `json:"created_on,omitempty"`

	// id
	// Format: uuid
	ID strfmt.UUID `json:"id,omitempty"`

	// modified on
	// Read Only: true
	// Format: date-time
	ModifiedOn strfmt.DateTime `json:"modified_on,omitempty"`

	// organisation id
	// Format: uuid
	OrganisationID strfmt.UUID `json:"organisation_id,omitempty"`

	// type
	Type ResourceType `json:"type,omitempty"`

	// version
	// Minimum: 0
	Version *int64 `json:"version,omitempty"`
}

Account account swagger:model Account

func (*Account) MarshalBinary

func (m *Account) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*Account) UnmarshalBinary

func (m *Account) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*Account) Validate

func (m *Account) Validate(formats strfmt.Registry) error

Validate validates this account

type AccountAttributes

type AccountAttributes struct {

	// Is the account business or personal?
	// Enum: [Personal Business]
	AccountClassification *string `json:"account_classification,omitempty"`

	// Is the account opted out of account matching, e.g. CoP?
	AccountMatchingOptOut *bool `json:"account_matching_opt_out,omitempty"`

	// Account number of the account. A unique number will automatically be generated if not provided.
	// Pattern: ^[A-Z0-9]{0,64}$
	AccountNumber string `json:"account_number,omitempty"`

	// Alternative account names. Used for Confirmation of Payee matching.
	// Max Items: 3
	AlternativeBankAccountNames []string `json:"alternative_bank_account_names"`

	// Primary account name. Used for Confirmation of Payee matching. Required if confirmation_of_payee_enabled is true for the organisation.
	// Max Length: 140
	// Min Length: 1
	BankAccountName string `json:"bank_account_name,omitempty"`

	// Local country bank identifier. In the UK this is the sort code.
	// Pattern: ^[A-Z0-9]{0,16}$
	BankID string `json:"bank_id,omitempty"`

	// ISO 20022 code used to identify the type of bank ID being used
	// Pattern: ^[A-Z]{0,16}$
	BankIDCode string `json:"bank_id_code,omitempty"`

	// ISO 4217 code used to identify the base currency of the account
	// Pattern: ^[A-Z]{3}$
	BaseCurrency string `json:"base_currency,omitempty"`

	// SWIFT BIC in either 8 or 11 character format
	// Pattern: ^([A-Z]{6}[A-Z0-9]{2}|[A-Z]{6}[A-Z0-9]{5})$
	Bic string `json:"bic,omitempty"`

	// ISO 3166-1 code used to identify the domicile of the account
	// Required: true
	// Pattern: ^[A-Z]{2}$
	Country *string `json:"country"`

	// A free-format reference that can be used to link this account to an external system
	// Pattern: ^[a-zA-Z0-9-$@., ]{0,256}$
	CustomerID string `json:"customer_id,omitempty"`

	// Customer first name.
	// Max Length: 40
	// Min Length: 1
	FirstName string `json:"first_name,omitempty"`

	// IBAN of the account. Will be calculated from other fields if not supplied.
	// Pattern: ^[A-Z]{2}[0-9]{2}[A-Z0-9]{0,64}$
	Iban string `json:"iban,omitempty"`

	// Is the account joint?
	JointAccount *bool `json:"joint_account,omitempty"`

	// Secondary identification, e.g. building society roll number. Used for Confirmation of Payee.
	// Max Length: 140
	// Min Length: 1
	SecondaryIdentification string `json:"secondary_identification,omitempty"`

	// Customer title.
	// Max Length: 40
	// Min Length: 1
	Title string `json:"title,omitempty"`
}

AccountAttributes account attributes swagger:model AccountAttributes

func (*AccountAttributes) MarshalBinary

func (m *AccountAttributes) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*AccountAttributes) UnmarshalBinary

func (m *AccountAttributes) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*AccountAttributes) Validate

func (m *AccountAttributes) Validate(formats strfmt.Registry) error

Validate validates this account attributes

type AccountCreation

type AccountCreation struct {

	// data
	Data *NewAccount `json:"data,omitempty"`
}

AccountCreation account creation swagger:model AccountCreation

func (*AccountCreation) MarshalBinary

func (m *AccountCreation) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*AccountCreation) UnmarshalBinary

func (m *AccountCreation) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*AccountCreation) Validate

func (m *AccountCreation) Validate(formats strfmt.Registry) error

Validate validates this account creation

type AccountCreationResponse

type AccountCreationResponse struct {

	// data
	Data *Account `json:"data,omitempty"`

	// links
	Links *Links `json:"links,omitempty"`
}

AccountCreationResponse account creation response swagger:model AccountCreationResponse

func (*AccountCreationResponse) MarshalBinary

func (m *AccountCreationResponse) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*AccountCreationResponse) UnmarshalBinary

func (m *AccountCreationResponse) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*AccountCreationResponse) Validate

func (m *AccountCreationResponse) Validate(formats strfmt.Registry) error

Validate validates this account creation response

type AccountDetailsListResponse

type AccountDetailsListResponse struct {

	// data
	Data []*Account `json:"data"`

	// links
	Links *Links `json:"links,omitempty"`
}

AccountDetailsListResponse account details list response swagger:model AccountDetailsListResponse

func (*AccountDetailsListResponse) MarshalBinary

func (m *AccountDetailsListResponse) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*AccountDetailsListResponse) UnmarshalBinary

func (m *AccountDetailsListResponse) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*AccountDetailsListResponse) Validate

func (m *AccountDetailsListResponse) Validate(formats strfmt.Registry) error

Validate validates this account details list response

type AccountDetailsResponse

type AccountDetailsResponse struct {

	// data
	Data *Account `json:"data,omitempty"`

	// links
	Links *Links `json:"links,omitempty"`
}

AccountDetailsResponse account details response swagger:model AccountDetailsResponse

func (*AccountDetailsResponse) MarshalBinary

func (m *AccountDetailsResponse) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*AccountDetailsResponse) UnmarshalBinary

func (m *AccountDetailsResponse) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*AccountDetailsResponse) Validate

func (m *AccountDetailsResponse) Validate(formats strfmt.Registry) error

Validate validates this account details response

type Links struct {

	// first
	First string `json:"first,omitempty"`

	// last
	Last string `json:"last,omitempty"`

	// next
	Next string `json:"next,omitempty"`

	// prev
	Prev string `json:"prev,omitempty"`

	// self
	Self string `json:"self,omitempty"`
}

Links links swagger:model Links

func (*Links) MarshalBinary

func (m *Links) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*Links) UnmarshalBinary

func (m *Links) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*Links) Validate

func (m *Links) Validate(formats strfmt.Registry) error

Validate validates this links

type NewAccount

type NewAccount struct {

	// attributes
	// Required: true
	Attributes *AccountAttributes `json:"attributes"`

	// id
	// Required: true
	// Format: uuid
	ID strfmt.UUID `json:"id"`

	// organisation id
	// Required: true
	// Format: uuid
	OrganisationID strfmt.UUID `json:"organisation_id"`

	// type
	// Required: true
	// Enum: [accounts]
	Type string `json:"type"`
}

NewAccount new account swagger:model NewAccount

func (*NewAccount) MarshalBinary

func (m *NewAccount) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*NewAccount) UnmarshalBinary

func (m *NewAccount) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*NewAccount) Validate

func (m *NewAccount) Validate(formats strfmt.Registry) error

Validate validates this new account

type ResourceType

type ResourceType string

ResourceType resource type swagger:model ResourceType

const (

	// ResourceTypeAccounts captures enum value "accounts"
	ResourceTypeAccounts ResourceType = "accounts"
)

func (ResourceType) Validate

func (m ResourceType) Validate(formats strfmt.Registry) error

Validate validates this resource type

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL