models

package
v1.3.0 Latest Latest
Warning

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

 Go to latest Published: Jun 6, 2019 License: MIT Imports: 6 Imported by: 0

Documentation

Index

Constants

View Source 
const (

	// ChargesInformationBearerCodeDEBT captures enum value "DEBT"
	ChargesInformationBearerCodeDEBT string = "DEBT"

	// ChargesInformationBearerCodeCRED captures enum value "CRED"
	ChargesInformationBearerCodeCRED string = "CRED"

	// ChargesInformationBearerCodeSHAR captures enum value "SHAR"
	ChargesInformationBearerCodeSHAR string = "SHAR"

	// ChargesInformationBearerCodeSLEV captures enum value "SLEV"
	ChargesInformationBearerCodeSLEV string = "SLEV"
)
View Source 
const (

	// PaymentAttributesSchemePaymentSubTypeTelephoneBanking captures enum value "TelephoneBanking"
	PaymentAttributesSchemePaymentSubTypeTelephoneBanking string = "TelephoneBanking"

	// PaymentAttributesSchemePaymentSubTypeInternetBanking captures enum value "InternetBanking"
	PaymentAttributesSchemePaymentSubTypeInternetBanking string = "InternetBanking"

	// PaymentAttributesSchemePaymentSubTypeBranchInstruction captures enum value "BranchInstruction"
	PaymentAttributesSchemePaymentSubTypeBranchInstruction string = "BranchInstruction"

	// PaymentAttributesSchemePaymentSubTypeLetter captures enum value "Letter"
	PaymentAttributesSchemePaymentSubTypeLetter string = "Letter"

	// PaymentAttributesSchemePaymentSubTypeEmail captures enum value "Email"
	PaymentAttributesSchemePaymentSubTypeEmail string = "Email"

	// PaymentAttributesSchemePaymentSubTypeMobilePaymentsService captures enum value "MobilePaymentsService"
	PaymentAttributesSchemePaymentSubTypeMobilePaymentsService string = "MobilePaymentsService"
)
View Source 
const (

	// PaymentAttributesSchemePaymentTypeImmediatePayment captures enum value "ImmediatePayment"
	PaymentAttributesSchemePaymentTypeImmediatePayment string = "ImmediatePayment"

	// PaymentAttributesSchemePaymentTypeForwardDatedPayment captures enum value "ForwardDatedPayment"
	PaymentAttributesSchemePaymentTypeForwardDatedPayment string = "ForwardDatedPayment"

	// PaymentAttributesSchemePaymentTypeStandingOrder captures enum value "StandingOrder"
	PaymentAttributesSchemePaymentTypeStandingOrder string = "StandingOrder"
)
View Source 
const (

	// PaymentPartyAccountNumberCodeIBAN captures enum value "IBAN"
	PaymentPartyAccountNumberCodeIBAN string = "IBAN"

	// PaymentPartyAccountNumberCodeBBAN captures enum value "BBAN"
	PaymentPartyAccountNumberCodeBBAN string = "BBAN"
)
View Source 
const (

	// PaymentAttributesPaymentSchemeFPS captures enum value "FPS"
	PaymentAttributesPaymentSchemeFPS string = "FPS"
)
View Source 
const (

	// PaymentAttributesPaymentTypeCredit captures enum value "Credit"
	PaymentAttributesPaymentTypeCredit string = "Credit"
)

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 AccountNumber 

type AccountNumber string

AccountNumber Account number swagger:model AccountNumber

func (AccountNumber) Validate 

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

Validate validates this account number

type Amount 

type Amount string

Amount Amount of money. Requires 1 to 2 decimal places. swagger:model Amount

func (Amount) Validate 

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

Validate validates this amount

type BankID 

type BankID string

BankID Financial institution identification swagger:model BankId

func (BankID) Validate 

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

Validate validates this bank Id

type BankIDCode 

type BankIDCode string

BankIDCode The type of identification provided at `bank_id` attribute. Must be ISO code as listed in the [External Code Sets spreadsheet](https://www.iso20022.org/external_code_list.page) swagger:model BankIdCode 

const (

	// BankIDCodeSWBIC captures enum value "SWBIC"
	BankIDCodeSWBIC BankIDCode = "SWBIC"

	// BankIDCodeGBDSC captures enum value "GBDSC"
	BankIDCodeGBDSC BankIDCode = "GBDSC"

	// BankIDCodeBE captures enum value "BE"
	BankIDCodeBE BankIDCode = "BE"

	// BankIDCodeFR captures enum value "FR"
	BankIDCodeFR BankIDCode = "FR"

	// BankIDCodeDEBLZ captures enum value "DEBLZ"
	BankIDCodeDEBLZ BankIDCode = "DEBLZ"

	// BankIDCodeGRBIC captures enum value "GRBIC"
	BankIDCodeGRBIC BankIDCode = "GRBIC"

	// BankIDCodeITNCC captures enum value "ITNCC"
	BankIDCodeITNCC BankIDCode = "ITNCC"

	// BankIDCodePLKNR captures enum value "PLKNR"
	BankIDCodePLKNR BankIDCode = "PLKNR"

	// BankIDCodePTNCC captures enum value "PTNCC"
	BankIDCodePTNCC BankIDCode = "PTNCC"

	// BankIDCodeESNCC captures enum value "ESNCC"
	BankIDCodeESNCC BankIDCode = "ESNCC"

	// BankIDCodeCHBCC captures enum value "CHBCC"
	BankIDCodeCHBCC BankIDCode = "CHBCC"
)

func (BankIDCode) Validate 

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

Validate validates this bank Id code

type ChargesInformation 

type ChargesInformation struct {

	// Specifies which party/parties will bear the charges associated with the processing of the payment transaction.
	// Enum: [DEBT CRED SHAR SLEV]
	BearerCode string `json:"bearer_code,omitempty"`

	// Transaction charges due to the receiver of the transaction.
	ReceiverChargesAmount Amount `json:"receiver_charges_amount,omitempty"`

	// receiver charges currency
	ReceiverChargesCurrency Currency `json:"receiver_charges_currency,omitempty"`

	// sender charges
	SenderCharges []*ChargesInformationSenderChargesItems0 `json:"sender_charges"`
}

ChargesInformation charges information swagger:model ChargesInformation

func (*ChargesInformation) MarshalBinary 

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

MarshalBinary interface implementation

func (*ChargesInformation) UnmarshalBinary 

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

UnmarshalBinary interface implementation

func (*ChargesInformation) Validate 

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

Validate validates this charges information

type ChargesInformationSenderChargesItems0 

type ChargesInformationSenderChargesItems0 struct {

	// Amount of each transaction charge due to the sender of the transaction.
	Amount Amount `json:"amount,omitempty"`

	// currency
	Currency Currency `json:"currency,omitempty"`
}

ChargesInformationSenderChargesItems0 List of transaction charges due to the sender of the transaction swagger:model ChargesInformationSenderChargesItems0

func (*ChargesInformationSenderChargesItems0) MarshalBinary 

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

MarshalBinary interface implementation

func (*ChargesInformationSenderChargesItems0) UnmarshalBinary 

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

UnmarshalBinary interface implementation

func (*ChargesInformationSenderChargesItems0) Validate 

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

Validate validates this charges information sender charges items0

type Currency 

type Currency string

Currency Currency code as defined in [ISO 4217](http://www.iso.org/iso/home/standards/currency_codes.htm). swagger:model Currency

func (Currency) Validate 

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

Validate validates this currency 

type Links struct {

	// Link to the first resource in the list
	First string `json:"first,omitempty"`

	// Link to the last resource in the list
	Last string `json:"last,omitempty"`

	// Link to the next resource in the list
	Next string `json:"next,omitempty"`

	// Link to the previous resource in the list
	Prev string `json:"prev,omitempty"`

	// Link to this resource type
	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 Payment 

type Payment struct {

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

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

	// Unique ID of the organisation this resource is created by
	// Required: true
	// Format: uuid
	OrganisationID *strfmt.UUID `json:"organisation_id"`

	// Name of the resource type
	// Pattern: ^[A-Za-z_]*$
	Type string `json:"type,omitempty"`

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

Payment payment swagger:model Payment

func (*Payment) MarshalBinary 

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

MarshalBinary interface implementation

func (*Payment) UnmarshalBinary 

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

UnmarshalBinary interface implementation

func (*Payment) Validate 

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

Validate validates this payment

type PaymentAttributes 

type PaymentAttributes struct {

	// Amount of money moved between the instructing agent and instructed agent
	Amount Amount `json:"amount,omitempty"`

	// beneficiary party
	BeneficiaryParty *PaymentParty `json:"beneficiary_party,omitempty"`

	// charges information
	ChargesInformation *ChargesInformation `json:"charges_information,omitempty"`

	// currency
	Currency Currency `json:"currency,omitempty"`

	// debtor party
	DebtorParty *PaymentParty `json:"debtor_party,omitempty"`

	// Unique identification, as assigned by the initiating party, to unambiguously identify the transaction. This identification is passed on, unchanged, throughout the entire end-to-end chain.
	EndToEndReference string `json:"end_to_end_reference,omitempty"`

	// fx
	Fx *PaymentAttributesFx `json:"fx,omitempty"`

	// Numeric reference field, see scheme specific descriptions for usage
	NumericReference string `json:"numeric_reference,omitempty"`

	// Payment identification (legacy?)
	PaymentID string `json:"payment_id,omitempty"`

	// Purpose of the payment in a proprietary form
	PaymentPurpose string `json:"payment_purpose,omitempty"`

	// Clearing infrastructure through which the payment instruction is to be processed. Default for given organisation ID is used if left empty. Currently only FPS is supported.
	// Enum: [FPS]
	PaymentScheme string `json:"payment_scheme,omitempty"`

	// payment type
	// Enum: [Credit]
	PaymentType string `json:"payment_type,omitempty"`

	// Date on which the payment is to be debited from the debtor account. Formatted according to ISO 8601 format YYYY-MM-DD.
	// Format: date
	ProcessingDate strfmt.Date `json:"processing_date,omitempty"`

	// Payment reference for beneficiary use
	Reference string `json:"reference,omitempty"`

	// The scheme specific payment sub type
	// Enum: [TelephoneBanking InternetBanking BranchInstruction Letter Email MobilePaymentsService]
	SchemePaymentSubType string `json:"scheme_payment_sub_type,omitempty"`

	// The scheme-specific payment type
	// Enum: [ImmediatePayment ForwardDatedPayment StandingOrder]
	SchemePaymentType string `json:"scheme_payment_type,omitempty"`

	// sponsor party
	SponsorParty *PaymentAttributesSponsorParty `json:"sponsor_party,omitempty"`
}

PaymentAttributes payment attributes swagger:model PaymentAttributes

func (*PaymentAttributes) MarshalBinary 

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

MarshalBinary interface implementation

func (*PaymentAttributes) UnmarshalBinary 

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

UnmarshalBinary interface implementation

func (*PaymentAttributes) Validate 

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

Validate validates this payment attributes

type PaymentAttributesFx 

type PaymentAttributesFx struct {

	// Reference to the foreign exchange contract associated with the transaction
	ContractReference string `json:"contract_reference,omitempty"`

	// Factor used to convert an amount from the instructed currency into the transaction currency. Decimal value, represented as a string, maximum length 12. Must be > 0.
	ExchangeRate string `json:"exchange_rate,omitempty"`

	// Amount of money to be moved between the debtor and creditor, before deduction of charges, expressed in the currency as instructed by the initiating party. Decimal value. Must be > 0.
	OriginalAmount Amount `json:"original_amount,omitempty"`

	// Currency of `orginal_amount`.
	OriginalCurrency Currency `json:"original_currency,omitempty"`
}

PaymentAttributesFx payment attributes fx swagger:model PaymentAttributesFx

func (*PaymentAttributesFx) MarshalBinary 

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

MarshalBinary interface implementation

func (*PaymentAttributesFx) UnmarshalBinary 

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

UnmarshalBinary interface implementation

func (*PaymentAttributesFx) Validate 

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

Validate validates this payment attributes fx

type PaymentAttributesSponsorParty 

type PaymentAttributesSponsorParty struct {

	// account number
	AccountNumber AccountNumber `json:"account_number,omitempty"`

	// bank id
	BankID BankID `json:"bank_id,omitempty"`

	// bank id code
	BankIDCode BankIDCode `json:"bank_id_code,omitempty"`
}

PaymentAttributesSponsorParty Sponsor party swagger:model PaymentAttributesSponsorParty

func (*PaymentAttributesSponsorParty) MarshalBinary 

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

MarshalBinary interface implementation

func (*PaymentAttributesSponsorParty) UnmarshalBinary 

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

UnmarshalBinary interface implementation

func (*PaymentAttributesSponsorParty) Validate 

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

Validate validates this payment attributes sponsor party

type PaymentCreationRequest 

type PaymentCreationRequest struct {

	// data
	// Required: true
	Data *Payment `json:"data"`
}

PaymentCreationRequest payment creation request swagger:model PaymentCreationRequest

func (*PaymentCreationRequest) MarshalBinary 

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

MarshalBinary interface implementation

func (*PaymentCreationRequest) UnmarshalBinary 

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

UnmarshalBinary interface implementation

func (*PaymentCreationRequest) Validate 

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

Validate validates this payment creation request

type PaymentCreationResponse 

type PaymentCreationResponse struct {

	// data
	// Required: true
	Data *Payment `json:"data"`

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

PaymentCreationResponse payment creation response swagger:model PaymentCreationResponse

func (*PaymentCreationResponse) MarshalBinary 

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

MarshalBinary interface implementation

func (*PaymentCreationResponse) UnmarshalBinary 

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

UnmarshalBinary interface implementation

func (*PaymentCreationResponse) Validate 

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

Validate validates this payment creation response

type PaymentDetailsListResponse 

type PaymentDetailsListResponse struct {

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

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

PaymentDetailsListResponse payment details list response swagger:model PaymentDetailsListResponse

func (*PaymentDetailsListResponse) MarshalBinary 

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

MarshalBinary interface implementation

func (*PaymentDetailsListResponse) UnmarshalBinary 

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

UnmarshalBinary interface implementation

func (*PaymentDetailsListResponse) Validate 

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

Validate validates this payment details list response

type PaymentDetailsResponse 

type PaymentDetailsResponse struct {

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

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

PaymentDetailsResponse payment details response swagger:model PaymentDetailsResponse

func (*PaymentDetailsResponse) MarshalBinary 

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

MarshalBinary interface implementation

func (*PaymentDetailsResponse) UnmarshalBinary 

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

UnmarshalBinary interface implementation

func (*PaymentDetailsResponse) Validate 

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

Validate validates this payment details response

type PaymentParty 

type PaymentParty struct {

	// Name of beneficiary/debtor as given with account
	AccountName string `json:"account_name,omitempty"`

	// account number
	AccountNumber AccountNumber `json:"account_number,omitempty"`

	// The type of identification given at `account_number` attribute
	// Enum: [IBAN BBAN]
	AccountNumberCode string `json:"account_number_code,omitempty"`

	// The type of the account given with account_number. Single digit number. Only required if requested by the beneficiary party. Defaults to 0.
	AccountType int64 `json:"account_type,omitempty"`

	// Beneficiary/debtor address
	Address string `json:"address,omitempty"`

	// bank id
	BankID BankID `json:"bank_id,omitempty"`

	// bank id code
	BankIDCode BankIDCode `json:"bank_id_code,omitempty"`

	// Beneficiary/debtor name
	Name string `json:"name,omitempty"`
}

PaymentParty payment party swagger:model PaymentParty

func (*PaymentParty) MarshalBinary 

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

MarshalBinary interface implementation

func (*PaymentParty) UnmarshalBinary 

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

UnmarshalBinary interface implementation

func (*PaymentParty) Validate 

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

Validate validates this payment party

type PaymentUpdateRequest 

type PaymentUpdateRequest struct {

	// data
	// Required: true
	Data *Payment `json:"data"`
}

PaymentUpdateRequest payment update request swagger:model PaymentUpdateRequest

func (*PaymentUpdateRequest) MarshalBinary 

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

MarshalBinary interface implementation

func (*PaymentUpdateRequest) UnmarshalBinary 

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

UnmarshalBinary interface implementation

func (*PaymentUpdateRequest) Validate 

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

Validate validates this payment update request

type PaymentUpdateResponse 

type PaymentUpdateResponse struct {

	// data
	// Required: true
	Data *Payment `json:"data"`

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

PaymentUpdateResponse payment update response swagger:model PaymentUpdateResponse

func (*PaymentUpdateResponse) MarshalBinary 

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

MarshalBinary interface implementation

func (*PaymentUpdateResponse) UnmarshalBinary 

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

UnmarshalBinary interface implementation

func (*PaymentUpdateResponse) Validate 

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

Validate validates this payment update response

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.