models

type APIError struct {

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

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

type AccountNumber string

type Amount string

type BankID string

type BankIDCode string

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"`
}

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"`
}

type Currency string

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"`
}

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"`
}

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"`
}

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"`
}

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"`
}

type PaymentCreationRequest struct {

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

type PaymentCreationResponse struct {

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

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

type PaymentDetailsListResponse struct {

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

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

type PaymentDetailsResponse struct {

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

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

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"`
}

type PaymentUpdateRequest struct {

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

type PaymentUpdateResponse struct {

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

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