models

package
v1.3.0 Latest Latest
Warning

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

Go to latest
Published: Jan 17, 2024 License: MIT Imports: 7 Imported by: 0

Documentation

Index

Constants

View Source
const (

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

	// AccountIdentifierTypeBBAN captures enum value "BBAN"
	AccountIdentifierTypeBBAN string = "BBAN"

	// AccountIdentifierTypeACCOUNTNUMBER captures enum value "ACCOUNT_NUMBER"
	AccountIdentifierTypeACCOUNTNUMBER string = "ACCOUNT_NUMBER"

	// AccountIdentifierTypeSEBG captures enum value "SE_BG"
	AccountIdentifierTypeSEBG string = "SE_BG"

	// AccountIdentifierTypeSEPG captures enum value "SE_PG"
	AccountIdentifierTypeSEPG string = "SE_PG"
)
View Source
const (

	// CounterpartyPartyTypeINDIVIDUAL captures enum value "INDIVIDUAL"
	CounterpartyPartyTypeINDIVIDUAL string = "INDIVIDUAL"

	// CounterpartyPartyTypeCOMPANY captures enum value "COMPANY"
	CounterpartyPartyTypeCOMPANY string = "COMPANY"
)
View Source
const (

	// CreateCounterpartyRequestPartyTypeINDIVIDUAL captures enum value "INDIVIDUAL"
	CreateCounterpartyRequestPartyTypeINDIVIDUAL string = "INDIVIDUAL"

	// CreateCounterpartyRequestPartyTypeCOMPANY captures enum value "COMPANY"
	CreateCounterpartyRequestPartyTypeCOMPANY string = "COMPANY"
)
View Source
const (

	// CreateDirectDebitRequestDirectDebitSchemeTypeSDDCORE captures enum value "SDD_CORE"
	CreateDirectDebitRequestDirectDebitSchemeTypeSDDCORE string = "SDD_CORE"

	// CreateDirectDebitRequestDirectDebitSchemeTypeSDDB2B captures enum value "SDD_B2B"
	CreateDirectDebitRequestDirectDebitSchemeTypeSDDB2B string = "SDD_B2B"

	// CreateDirectDebitRequestDirectDebitSchemeTypeAUTOGIRO captures enum value "AUTOGIRO"
	CreateDirectDebitRequestDirectDebitSchemeTypeAUTOGIRO string = "AUTOGIRO"
)
View Source
const (

	// CreateMandateRequestDirectDebitSchemeTypeSDDCORE captures enum value "SDD_CORE"
	CreateMandateRequestDirectDebitSchemeTypeSDDCORE string = "SDD_CORE"

	// CreateMandateRequestDirectDebitSchemeTypeSDDB2B captures enum value "SDD_B2B"
	CreateMandateRequestDirectDebitSchemeTypeSDDB2B string = "SDD_B2B"

	// CreateMandateRequestDirectDebitSchemeTypeAUTOGIRO captures enum value "AUTOGIRO"
	CreateMandateRequestDirectDebitSchemeTypeAUTOGIRO string = "AUTOGIRO"
)
View Source
const (

	// CreatePaymentRequestChargeBearerSHARED captures enum value "SHARED"
	CreatePaymentRequestChargeBearerSHARED string = "SHARED"

	// CreatePaymentRequestChargeBearerDEBTOR captures enum value "DEBTOR"
	CreatePaymentRequestChargeBearerDEBTOR string = "DEBTOR"

	// CreatePaymentRequestChargeBearerCREDITOR captures enum value "CREDITOR"
	CreatePaymentRequestChargeBearerCREDITOR string = "CREDITOR"
)
View Source
const (

	// CreatePaymentRequestPaymentSchemeTypeSCT captures enum value "SCT"
	CreatePaymentRequestPaymentSchemeTypeSCT string = "SCT"

	// CreatePaymentRequestPaymentSchemeTypeSCTINST captures enum value "SCT_INST"
	CreatePaymentRequestPaymentSchemeTypeSCTINST string = "SCT_INST"

	// CreatePaymentRequestPaymentSchemeTypeGBCTBACS captures enum value "GB_CT_BACS"
	CreatePaymentRequestPaymentSchemeTypeGBCTBACS string = "GB_CT_BACS"

	// CreatePaymentRequestPaymentSchemeTypeGBCTFPS captures enum value "GB_CT_FPS"
	CreatePaymentRequestPaymentSchemeTypeGBCTFPS string = "GB_CT_FPS"

	// CreatePaymentRequestPaymentSchemeTypeSEA2A captures enum value "SE_A2A"
	CreatePaymentRequestPaymentSchemeTypeSEA2A string = "SE_A2A"

	// CreatePaymentRequestPaymentSchemeTypeSEGIRO captures enum value "SE_GIRO"
	CreatePaymentRequestPaymentSchemeTypeSEGIRO string = "SE_GIRO"

	// CreatePaymentRequestPaymentSchemeTypeDKA2A captures enum value "DK_A2A"
	CreatePaymentRequestPaymentSchemeTypeDKA2A string = "DK_A2A"

	// CreatePaymentRequestPaymentSchemeTypeDKCTSAMEDAY captures enum value "DK_CT_SAMEDAY"
	CreatePaymentRequestPaymentSchemeTypeDKCTSAMEDAY string = "DK_CT_SAMEDAY"

	// CreatePaymentRequestPaymentSchemeTypeDKCTINST captures enum value "DK_CT_INST"
	CreatePaymentRequestPaymentSchemeTypeDKCTINST string = "DK_CT_INST"

	// CreatePaymentRequestPaymentSchemeTypeCHCT captures enum value "CH_CT"
	CreatePaymentRequestPaymentSchemeTypeCHCT string = "CH_CT"

	// CreatePaymentRequestPaymentSchemeTypeCROSSBORDER captures enum value "CROSS_BORDER"
	CreatePaymentRequestPaymentSchemeTypeCROSSBORDER string = "CROSS_BORDER"
)
View Source
const (

	// DirectDebitStatusCREATED captures enum value "CREATED"
	DirectDebitStatusCREATED string = "CREATED"

	// DirectDebitStatusAPPROVED captures enum value "APPROVED"
	DirectDebitStatusAPPROVED string = "APPROVED"

	// DirectDebitStatusREJECTED captures enum value "REJECTED"
	DirectDebitStatusREJECTED string = "REJECTED"

	// DirectDebitStatusPENDINGSUBMISSION captures enum value "PENDING_SUBMISSION"
	DirectDebitStatusPENDINGSUBMISSION string = "PENDING_SUBMISSION"

	// DirectDebitStatusSENT captures enum value "SENT"
	DirectDebitStatusSENT string = "SENT"

	// DirectDebitStatusACCEPTED captures enum value "ACCEPTED"
	DirectDebitStatusACCEPTED string = "ACCEPTED"

	// DirectDebitStatusEXECUTED captures enum value "EXECUTED"
	DirectDebitStatusEXECUTED string = "EXECUTED"

	// DirectDebitStatusFAILED captures enum value "FAILED"
	DirectDebitStatusFAILED string = "FAILED"

	// DirectDebitStatusRECONCILED captures enum value "RECONCILED"
	DirectDebitStatusRECONCILED string = "RECONCILED"

	// DirectDebitStatusRETURNED captures enum value "RETURNED"
	DirectDebitStatusRETURNED string = "RETURNED"
)
View Source
const (

	// MandateStatusCREATED captures enum value "CREATED"
	MandateStatusCREATED string = "CREATED"

	// MandateStatusPENDINGCANCELLATION captures enum value "PENDING_CANCELLATION"
	MandateStatusPENDINGCANCELLATION string = "PENDING_CANCELLATION"

	// MandateStatusPENDINGCANCELLATIONSUBMISSION captures enum value "PENDING_CANCELLATION_SUBMISSION"
	MandateStatusPENDINGCANCELLATIONSUBMISSION string = "PENDING_CANCELLATION_SUBMISSION"

	// MandateStatusCANCELLATIONSENT captures enum value "CANCELLATION_SENT"
	MandateStatusCANCELLATIONSENT string = "CANCELLATION_SENT"

	// MandateStatusPENDINGSUBMISSION captures enum value "PENDING_SUBMISSION"
	MandateStatusPENDINGSUBMISSION string = "PENDING_SUBMISSION"

	// MandateStatusSENT captures enum value "SENT"
	MandateStatusSENT string = "SENT"

	// MandateStatusACCEPTED captures enum value "ACCEPTED"
	MandateStatusACCEPTED string = "ACCEPTED"

	// MandateStatusACTIVE captures enum value "ACTIVE"
	MandateStatusACTIVE string = "ACTIVE"

	// MandateStatusFAILED captures enum value "FAILED"
	MandateStatusFAILED string = "FAILED"

	// MandateStatusCANCELLED captures enum value "CANCELLED"
	MandateStatusCANCELLED string = "CANCELLED"
)
View Source
const (

	// MembershipRoleTypeSERVICEROLE captures enum value "SERVICE_ROLE"
	MembershipRoleTypeSERVICEROLE string = "SERVICE_ROLE"

	// MembershipRoleTypeOPERATORROLE captures enum value "OPERATOR_ROLE"
	MembershipRoleTypeOPERATORROLE string = "OPERATOR_ROLE"

	// MembershipRoleTypeREGULARROLE captures enum value "REGULAR_ROLE"
	MembershipRoleTypeREGULARROLE string = "REGULAR_ROLE"
)
View Source
const (

	// NationalIdentifierTypeCIVIC captures enum value "CIVIC"
	NationalIdentifierTypeCIVIC string = "CIVIC"

	// NationalIdentifierTypeCOMPANY captures enum value "COMPANY"
	NationalIdentifierTypeCOMPANY string = "COMPANY"
)
View Source
const (

	// PaymentChargeBearerSHARED captures enum value "SHARED"
	PaymentChargeBearerSHARED string = "SHARED"

	// PaymentChargeBearerDEBTOR captures enum value "DEBTOR"
	PaymentChargeBearerDEBTOR string = "DEBTOR"

	// PaymentChargeBearerCREDITOR captures enum value "CREDITOR"
	PaymentChargeBearerCREDITOR string = "CREDITOR"
)
View Source
const (

	// PaymentStatusCREATED captures enum value "CREATED"
	PaymentStatusCREATED string = "CREATED"

	// PaymentStatusAPPROVED captures enum value "APPROVED"
	PaymentStatusAPPROVED string = "APPROVED"

	// PaymentStatusREJECTED captures enum value "REJECTED"
	PaymentStatusREJECTED string = "REJECTED"

	// PaymentStatusPENDINGSUBMISSION captures enum value "PENDING_SUBMISSION"
	PaymentStatusPENDINGSUBMISSION string = "PENDING_SUBMISSION"

	// PaymentStatusSENT captures enum value "SENT"
	PaymentStatusSENT string = "SENT"

	// PaymentStatusPENDINGATBANK captures enum value "PENDING_AT_BANK"
	PaymentStatusPENDINGATBANK string = "PENDING_AT_BANK"

	// PaymentStatusACCEPTED captures enum value "ACCEPTED"
	PaymentStatusACCEPTED string = "ACCEPTED"

	// PaymentStatusEXECUTED captures enum value "EXECUTED"
	PaymentStatusEXECUTED string = "EXECUTED"

	// PaymentStatusFAILED captures enum value "FAILED"
	PaymentStatusFAILED string = "FAILED"

	// PaymentStatusRECONCILED captures enum value "RECONCILED"
	PaymentStatusRECONCILED string = "RECONCILED"

	// PaymentStatusRETURNED captures enum value "RETURNED"
	PaymentStatusRETURNED string = "RETURNED"
)
View Source
const (

	// ReconciliationDetailsStatusBOOKED captures enum value "BOOKED"
	ReconciliationDetailsStatusBOOKED string = "BOOKED"

	// ReconciliationDetailsStatusEXPECTED captures enum value "EXPECTED"
	ReconciliationDetailsStatusEXPECTED string = "EXPECTED"

	// ReconciliationDetailsStatusRECONCILED captures enum value "RECONCILED"
	ReconciliationDetailsStatusRECONCILED string = "RECONCILED"
)
View Source
const (

	// ReconciliationDetailsTransactableTypePAYMENT captures enum value "PAYMENT"
	ReconciliationDetailsTransactableTypePAYMENT string = "PAYMENT"

	// ReconciliationDetailsTransactableTypeEXPECTEDTRANSACTION captures enum value "EXPECTED_TRANSACTION"
	ReconciliationDetailsTransactableTypeEXPECTEDTRANSACTION string = "EXPECTED_TRANSACTION"
)
View Source
const (

	// RegulatoryReportingDetailIndicatorDEBTOR captures enum value "DEBTOR"
	RegulatoryReportingDetailIndicatorDEBTOR string = "DEBTOR"

	// RegulatoryReportingDetailIndicatorCREDITOR captures enum value "CREDITOR"
	RegulatoryReportingDetailIndicatorCREDITOR string = "CREDITOR"

	// RegulatoryReportingDetailIndicatorBOTH captures enum value "BOTH"
	RegulatoryReportingDetailIndicatorBOTH string = "BOTH"
)
View Source
const (

	// RemittanceInformationTypeOCR captures enum value "OCR"
	RemittanceInformationTypeOCR string = "OCR"

	// RemittanceInformationTypeUNSTRUCTURED captures enum value "UNSTRUCTURED"
	RemittanceInformationTypeUNSTRUCTURED string = "UNSTRUCTURED"

	// RemittanceInformationTypeSTRUCTURED captures enum value "STRUCTURED"
	RemittanceInformationTypeSTRUCTURED string = "STRUCTURED"
)
View Source
const (

	// RoleTypeSERVICEROLE captures enum value "SERVICE_ROLE"
	RoleTypeSERVICEROLE string = "SERVICE_ROLE"

	// RoleTypeOPERATORROLE captures enum value "OPERATOR_ROLE"
	RoleTypeOPERATORROLE string = "OPERATOR_ROLE"

	// RoleTypeREGULARROLE captures enum value "REGULAR_ROLE"
	RoleTypeREGULARROLE string = "REGULAR_ROLE"
)
View Source
const (

	// TransactionCounterpartyDetailsPartyTypeINDIVIDUAL captures enum value "INDIVIDUAL"
	TransactionCounterpartyDetailsPartyTypeINDIVIDUAL string = "INDIVIDUAL"

	// TransactionCounterpartyDetailsPartyTypeCOMPANY captures enum value "COMPANY"
	TransactionCounterpartyDetailsPartyTypeCOMPANY string = "COMPANY"
)
View Source
const (

	// UpdateCounterpartyRequestPartyTypeINDIVIDUAL captures enum value "INDIVIDUAL"
	UpdateCounterpartyRequestPartyTypeINDIVIDUAL string = "INDIVIDUAL"

	// UpdateCounterpartyRequestPartyTypeCOMPANY captures enum value "COMPANY"
	UpdateCounterpartyRequestPartyTypeCOMPANY string = "COMPANY"
)

Variables

This section is empty.

Functions

This section is empty.

Types

type Account

type Account struct {

	// alias
	// Example: My Business Account
	Alias string `json:"alias,omitempty"`

	// balance
	Balance *Balance `json:"balance,omitempty"`

	// DEPRECATED
	Bank *BankSlim `json:"bank,omitempty"`

	// BIC of the Bank & Branch of the account
	// Example: DEUTDEFFXXX
	Bic string `json:"bic,omitempty"`

	// created
	// Example: 2022-05-04T18:31:12.889104898Z
	Created string `json:"created,omitempty"`

	// 3-letter ISO currency code
	// Example: EUR
	Currency string `json:"currency,omitempty"`

	// external metadata
	ExternalMetadata ExternalMetadata `json:"externalMetadata,omitempty"`

	// fictive
	// Example: true
	Fictive bool `json:"fictive,omitempty"`

	// id
	// Example: 31d593d7-fff9-4783-aa1d-92acb7b21a19
	// Required: true
	ID *string `json:"id"`

	// identifiers
	Identifiers []*AccountIdentifier `json:"identifiers"`

	// 2-letter ISO country code
	// Example: DE
	Market string `json:"market,omitempty"`

	// name
	// Example: Company Account
	Name string `json:"name,omitempty"`

	// organization Id
	// Example: 605e26fc-4fce-495a-a92f-2c3592d7287e
	// Required: true
	OrganizationID *string `json:"organizationId"`

	// owner
	Owner *PartyIdentification `json:"owner,omitempty"`

	// ID of the associated third-party, e.g. the bank in which the account is held.
	ThirdPartyID string `json:"thirdPartyId,omitempty"`

	// updated
	// Example: 2022-05-04T18:31:12.889104898Z
	Updated string `json:"updated,omitempty"`

	// version
	Version int64 `json:"version,omitempty"`
}

Account account

swagger:model Account

func (*Account) ContextValidate

func (m *Account) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validate this account based on the context it is used

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 AccountIdentifier

type AccountIdentifier struct {

	// The legal name of the individual or company holding the account
	// Example: John Smith
	// Required: true
	HolderName *string `json:"holderName"`

	// ISO3166 Alpha2 country code
	// Example: DE
	// Required: true
	Market *string `json:"market"`

	// The unformatted identifier itself. For BBAN type the number is country-specific.
	// Example: DE47500105175557488443
	// Required: true
	Number *string `json:"number"`

	// Type of the identifier. For country specific basic bank account number with bank identifier (e.g. routing or clearing number) choose BBAN. For country specific bank account number without bank identifier (e.g. routing or clearing number) choose ACCOUNT_NUMBER. For further information please refer to Account Identifiers section.
	// Example: IBAN
	// Required: true
	// Enum: [IBAN BBAN ACCOUNT_NUMBER SE_BG SE_PG]
	Type *string `json:"type"`
}

AccountIdentifier account identifier

swagger:model AccountIdentifier

func (*AccountIdentifier) ContextValidate

func (m *AccountIdentifier) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validates this account identifier based on context it is used

func (*AccountIdentifier) MarshalBinary

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

MarshalBinary interface implementation

func (*AccountIdentifier) UnmarshalBinary

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

UnmarshalBinary interface implementation

func (*AccountIdentifier) Validate

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

Validate validates this account identifier

type AccountIdentifierSlim

type AccountIdentifierSlim struct {

	// holder name
	// Example: John Smith
	// Required: true
	HolderName *string `json:"holderName"`

	// market
	// Example: DE
	Market string `json:"market,omitempty"`

	// number
	// Example: DE47500105175557488443
	Number string `json:"number,omitempty"`

	// Type of the identifier. For country specific basic bank account number with bank identifier (e.g. routing or clearing number) choose BBAN. For country specific bank account number without bank identifier (e.g. routing or clearing number) choose ACCOUNT_NUMBER. For further information please refer to Account Identifiers section.
	// Example: IBAN
	Type string `json:"type,omitempty"`
}

AccountIdentifierSlim Slim variant of AccountIdentifier, a strict subset.

swagger:model AccountIdentifierSlim

func (*AccountIdentifierSlim) ContextValidate

func (m *AccountIdentifierSlim) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validates this account identifier slim based on context it is used

func (*AccountIdentifierSlim) MarshalBinary

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

MarshalBinary interface implementation

func (*AccountIdentifierSlim) UnmarshalBinary

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

UnmarshalBinary interface implementation

func (*AccountIdentifierSlim) Validate

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

Validate validates this account identifier slim

type AccountSlim

type AccountSlim struct {

	// bank
	Bank *BankSlim `json:"bank,omitempty"`

	// id
	// Example: 31d593d7-fff9-4783-aa1d-92acb7b21a19
	// Required: true
	ID *string `json:"id"`

	// identifiers
	Identifiers []*AccountIdentifierSlim `json:"identifiers"`

	// name
	// Example: Company Account
	Name string `json:"name,omitempty"`
}

AccountSlim account slim

swagger:model AccountSlim

func (*AccountSlim) ContextValidate

func (m *AccountSlim) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validate this account slim based on the context it is used

func (*AccountSlim) MarshalBinary

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

MarshalBinary interface implementation

func (*AccountSlim) UnmarshalBinary

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

UnmarshalBinary interface implementation

func (*AccountSlim) Validate

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

Validate validates this account slim

type AccountTrx

type AccountTrx struct {

	// bank
	Bank *BankSlim `json:"bank,omitempty"`

	// id
	// Example: 31d593d7-fff9-4783-aa1d-92acb7b21a19
	// Required: true
	ID *string `json:"id"`

	// Name of the account
	// Example: Company Account
	Name string `json:"name,omitempty"`
}

AccountTrx a subset of an Account set on each Transaction

swagger:model AccountTrx

func (*AccountTrx) ContextValidate

func (m *AccountTrx) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validate this account trx based on the context it is used

func (*AccountTrx) MarshalBinary

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

MarshalBinary interface implementation

func (*AccountTrx) UnmarshalBinary

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

UnmarshalBinary interface implementation

func (*AccountTrx) Validate

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

Validate validates this account trx

type AddBankRequest

type AddBankRequest struct {

	// accounts
	Accounts []*CreateTestbankAccountRequest `json:"accounts"`

	// affiliation
	Affiliation *CreateAffiliationRequest `json:"affiliation,omitempty"`

	// connection
	Connection *CreateWizardConnectionRequest `json:"connection,omitempty"`

	// secrets
	Secrets map[string]string `json:"secrets,omitempty"`
}

AddBankRequest add bank request

swagger:model AddBankRequest

func (*AddBankRequest) ContextValidate

func (m *AddBankRequest) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validate this add bank request based on the context it is used

func (*AddBankRequest) MarshalBinary

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

MarshalBinary interface implementation

func (*AddBankRequest) UnmarshalBinary

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

UnmarshalBinary interface implementation

func (*AddBankRequest) Validate

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

Validate validates this add bank request

type AddBankResponse

type AddBankResponse struct {

	// affiliation
	Affiliation *Affiliation `json:"affiliation,omitempty"`

	// connection
	Connection *Connection `json:"connection,omitempty"`
}

AddBankResponse add bank response

swagger:model AddBankResponse

func (*AddBankResponse) ContextValidate

func (m *AddBankResponse) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validate this add bank response based on the context it is used

func (*AddBankResponse) MarshalBinary

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

MarshalBinary interface implementation

func (*AddBankResponse) UnmarshalBinary

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

UnmarshalBinary interface implementation

func (*AddBankResponse) Validate

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

Validate validates this add bank response

type Address

type Address struct {

	// city
	// Example: Stockholm
	City string `json:"city,omitempty"`

	// ISO 3166-1 alpha-2 country code. Examples: DE, DK, SE
	// Example: SE
	// Max Length: 2
	// Min Length: 2
	Country string `json:"country,omitempty"`

	// postal code
	// Example: 11111
	PostalCode string `json:"postalCode,omitempty"`

	// International unstructured address lines, as they might appear on a mailing label, are presented in their raw, unformatted form. This array is populated with raw address lines only when Atlar receives such information from the bank. While the bank might not always provide these lines, when available, they will appear here in their unaltered state.
	RawAddressLines []string `json:"rawAddressLines"`

	// street name
	// Example: Example street
	StreetName string `json:"streetName,omitempty"`

	// street number
	// Example: 47
	StreetNumber string `json:"streetNumber,omitempty"`
}

Address address

swagger:model Address

func (*Address) ContextValidate

func (m *Address) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validates this address based on context it is used

func (*Address) MarshalBinary

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

MarshalBinary interface implementation

func (*Address) UnmarshalBinary

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

UnmarshalBinary interface implementation

func (*Address) Validate

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

Validate validates this address

type Affiliation

type Affiliation struct {

	// DEPRECATED
	Bank *BankSlim `json:"bank,omitempty"`

	// created
	Created string `json:"created,omitempty"`

	// id
	ID string `json:"id,omitempty"`

	// name
	Name string `json:"name,omitempty"`

	// organization Id
	OrganizationID string `json:"organizationId,omitempty"`

	// third party
	ThirdParty *ThirdParty `json:"thirdParty,omitempty"`

	// updated
	Updated string `json:"updated,omitempty"`
}

Affiliation affiliation

swagger:model Affiliation

func (*Affiliation) ContextValidate

func (m *Affiliation) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validate this affiliation based on the context it is used

func (*Affiliation) MarshalBinary

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

MarshalBinary interface implementation

func (*Affiliation) UnmarshalBinary

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

UnmarshalBinary interface implementation

func (*Affiliation) Validate

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

Validate validates this affiliation

type Amount

type Amount struct {

	// 3-letter ISO 4217 currency code.
	// Example: EUR
	// Required: true
	Currency *string `json:"currency"`

	// A string representation of the amount value, which will be a decimal number if the currency has decimals. The number is not formatted for display purposes (e.g. with thousand separator) and always contains the dot `.` character as decimal separator.
	// Example: 15.02
	// Required: true
	StringValue *string `json:"stringValue"`

	// The amount value as an integer (int64) represented in currency minor units (e.g. 15.02 EUR is represented as the value 1502).
	// Example: 1502
	// Required: true
	Value *int64 `json:"value"`
}

Amount amount

swagger:model Amount

func (*Amount) ContextValidate

func (m *Amount) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validates this amount based on context it is used

func (*Amount) MarshalBinary

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

MarshalBinary interface implementation

func (*Amount) UnmarshalBinary

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

UnmarshalBinary interface implementation

func (*Amount) Validate

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

Validate validates this amount

type AmountInput

type AmountInput struct {

	// 3-letter ISO 4217 currency code.
	// Example: EUR
	// Required: true
	Currency *string `json:"currency"`

	// A string representation of the amount value, which should be a decimal number if the currency has decimals. The number must contain the exact number of decimals for the currency (e.g. 1.0 SEK won't be accepted, but 1.00 SEK will). The number must also contain a dot `.` as decimal separator. NOTE: either this field or `value` must be provided.
	// Example: 15.02
	StringValue string `json:"stringValue,omitempty"`

	// The amount value as an integer (int64) represented in minor currency units (e.g. 15.02 EUR should be represented as the value 1502). NOTE: either this field or `stringValue` must be provided.
	// Example: 1502
	Value int64 `json:"value,omitempty"`
}

AmountInput amount input

swagger:model AmountInput

func (*AmountInput) ContextValidate

func (m *AmountInput) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validates this amount input based on context it is used

func (*AmountInput) MarshalBinary

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

MarshalBinary interface implementation

func (*AmountInput) UnmarshalBinary

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

UnmarshalBinary interface implementation

func (*AmountInput) Validate

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

Validate validates this amount input

type ApprovalStep

type ApprovalStep struct {

	// Allow approval by the user creating this resource if if has the role required for this step. By default this is not allowed to conform with a four-eyes principle where approval by another person is required.
	AllowCreatorApproval bool `json:"allowCreatorApproval,omitempty"`

	// the Role that is required in order to approve/reject payments
	RequiredApproverRoleID string `json:"requiredApproverRoleId,omitempty"`
}

ApprovalStep approval step

swagger:model ApprovalStep

func (*ApprovalStep) ContextValidate

func (m *ApprovalStep) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validates this approval step based on context it is used

func (*ApprovalStep) MarshalBinary

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

MarshalBinary interface implementation

func (*ApprovalStep) UnmarshalBinary

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

UnmarshalBinary interface implementation

func (*ApprovalStep) Validate

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

Validate validates this approval step

type AttachedTransaction

type AttachedTransaction struct {

	// event
	Event string `json:"event,omitempty"`

	// transaction Id
	TransactionID string `json:"transactionId,omitempty"`
}

AttachedTransaction attached transaction

swagger:model AttachedTransaction

func (*AttachedTransaction) ContextValidate

func (m *AttachedTransaction) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validates this attached transaction based on context it is used

func (*AttachedTransaction) MarshalBinary

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

MarshalBinary interface implementation

func (*AttachedTransaction) UnmarshalBinary

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

UnmarshalBinary interface implementation

func (*AttachedTransaction) Validate

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

Validate validates this attached transaction

type AuthTypeInfo

type AuthTypeInfo struct {

	// created
	// Example: 2022-05-04T18:31:12.889104898Z
	Created string `json:"created,omitempty"`
}

AuthTypeInfo auth type info

swagger:model AuthTypeInfo

func (*AuthTypeInfo) ContextValidate

func (m *AuthTypeInfo) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validates this auth type info based on context it is used

func (*AuthTypeInfo) MarshalBinary

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

MarshalBinary interface implementation

func (*AuthTypeInfo) UnmarshalBinary

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

UnmarshalBinary interface implementation

func (*AuthTypeInfo) Validate

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

Validate validates this auth type info

type Balance

type Balance struct {

	// account Id
	AccountID string `json:"accountId,omitempty"`

	// amount
	Amount *Amount `json:"amount,omitempty"`

	// id
	ID string `json:"id,omitempty"`

	// The local date for this balance input, no TZ info included. The date is in the local TZ of the account/bank.
	// Example: 2022-05-04
	LocalDate string `json:"localDate,omitempty"`

	// organization Id
	OrganizationID string `json:"organizationId,omitempty"`

	// reported type
	// Example: CLOSE
	ReportedType string `json:"reportedType,omitempty"`

	// timestamp
	// Example: 2022-05-04T18:31:12.889104898Z
	Timestamp string `json:"timestamp,omitempty"`

	// type
	// Example: BOOKED
	Type string `json:"type,omitempty"`

	// version
	Version int64 `json:"version,omitempty"`
}

Balance balance

swagger:model Balance

func (*Balance) ContextValidate

func (m *Balance) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validate this balance based on the context it is used

func (*Balance) MarshalBinary

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

MarshalBinary interface implementation

func (*Balance) UnmarshalBinary

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

UnmarshalBinary interface implementation

func (*Balance) Validate

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

Validate validates this balance

type BalanceByCurrencyDetails

type BalanceByCurrencyDetails struct {

	// account ids
	AccountIds []string `json:"accountIds"`

	// reported types
	ReportedTypes []string `json:"reportedTypes"`

	// timestamps
	Timestamps []string `json:"timestamps"`

	// types
	Types []string `json:"types"`
}

BalanceByCurrencyDetails balance by currency details

swagger:model BalanceByCurrencyDetails

func (*BalanceByCurrencyDetails) ContextValidate

func (m *BalanceByCurrencyDetails) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validates this balance by currency details based on context it is used

func (*BalanceByCurrencyDetails) MarshalBinary

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

MarshalBinary interface implementation

func (*BalanceByCurrencyDetails) UnmarshalBinary

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

UnmarshalBinary interface implementation

func (*BalanceByCurrencyDetails) Validate

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

Validate validates this balance by currency details

type BankSlim

type BankSlim struct {

	// bic
	// Example: ESSESESSXXX
	Bic string `json:"bic,omitempty"`

	// id
	// Example: 5013c38e-8e01-4ad3-aff6-a57d51ec2158
	ID string `json:"id,omitempty"`

	// name
	// Example: SEB
	Name string `json:"name,omitempty"`
}

BankSlim Slim variant of Bank, a strict subset.

swagger:model BankSlim

func (*BankSlim) ContextValidate

func (m *BankSlim) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validates this bank slim based on context it is used

func (*BankSlim) MarshalBinary

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

MarshalBinary interface implementation

func (*BankSlim) UnmarshalBinary

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

UnmarshalBinary interface implementation

func (*BankSlim) Validate

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

Validate validates this bank slim

type BankTransactionCode

type BankTransactionCode struct {

	// Free-form textual description of the Bank Transaction Code.
	// Example: SEPA Credit Transfer
	Description string `json:"description,omitempty"`

	// ISO 20022 BTC Domain - Defines the business area of the underlying transaction, e.g. payments or cash management.
	// Example: PMNT
	Domain string `json:"domain,omitempty"`

	// ISO 20022 BTC Family - May for example define the type of transaction, e.g. credit transfer or direct debit.
	// Example: IDDT
	Family string `json:"family,omitempty"`

	// Proprietary bank transaction codes are provided when the bank provides a proprietary transaction code. This field will be set as the code provided by the bank.
	Proprietary *ProprietaryBankTransactionCode `json:"proprietary,omitempty"`

	// ISO 20022 BTC Subfamily - May for example specify a scheme specific transaction type, e.g. SEPA credit transfer, or a Cross-Border credit transfer.
	// Example: ESCT
	Subfamily string `json:"subfamily,omitempty"`
}

BankTransactionCode bank transaction code

swagger:model BankTransactionCode

func (*BankTransactionCode) ContextValidate

func (m *BankTransactionCode) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validate this bank transaction code based on the context it is used

func (*BankTransactionCode) MarshalBinary

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

MarshalBinary interface implementation

func (*BankTransactionCode) UnmarshalBinary

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

UnmarshalBinary interface implementation

func (*BankTransactionCode) Validate

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

Validate validates this bank transaction code

type ChallengeResponse

type ChallengeResponse struct {

	// challenge
	Challenge string `json:"challenge,omitempty"`

	// session
	Session string `json:"session,omitempty"`
}

ChallengeResponse challenge response

swagger:model ChallengeResponse

func (*ChallengeResponse) ContextValidate

func (m *ChallengeResponse) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validates this challenge response based on context it is used

func (*ChallengeResponse) MarshalBinary

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

MarshalBinary interface implementation

func (*ChallengeResponse) UnmarshalBinary

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

UnmarshalBinary interface implementation

func (*ChallengeResponse) Validate

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

Validate validates this challenge response

type Connection

type Connection struct {

	// affiliation
	Affiliation *SlimAffiliation `json:"affiliation,omitempty"`

	// bank
	Bank *BankSlim `json:"bank,omitempty"`

	// connection type
	ConnectionType *SlimConnectionType `json:"connectionType,omitempty"`

	// created
	Created string `json:"created,omitempty"`

	// id
	ID string `json:"id,omitempty"`

	// organization Id
	OrganizationID string `json:"organizationId,omitempty"`

	// updated
	Updated string `json:"updated,omitempty"`

	// verified
	Verified string `json:"verified,omitempty"`
}

Connection connection

swagger:model Connection

func (*Connection) ContextValidate

func (m *Connection) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validate this connection based on the context it is used

func (*Connection) MarshalBinary

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

MarshalBinary interface implementation

func (*Connection) UnmarshalBinary

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

UnmarshalBinary interface implementation

func (*Connection) Validate

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

Validate validates this connection

type ConnectionCapabilities

type ConnectionCapabilities struct {

	// fetch capabilities
	FetchCapabilities *FetchCapabilities `json:"fetchCapabilities,omitempty"`

	// push capabilities
	PushCapabilities *PushCapabilities `json:"pushCapabilities,omitempty"`
}

ConnectionCapabilities connection capabilities

swagger:model ConnectionCapabilities

func (*ConnectionCapabilities) ContextValidate

func (m *ConnectionCapabilities) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validate this connection capabilities based on the context it is used

func (*ConnectionCapabilities) MarshalBinary

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

MarshalBinary interface implementation

func (*ConnectionCapabilities) UnmarshalBinary

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

UnmarshalBinary interface implementation

func (*ConnectionCapabilities) Validate

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

Validate validates this connection capabilities

type ConnectionType

type ConnectionType struct {

	// capabilities
	Capabilities *ConnectionCapabilities `json:"capabilities,omitempty"`

	// id
	ID string `json:"id,omitempty"`

	// name
	Name string `json:"name,omitempty"`

	// secrets
	Secrets []*SecretDefinition `json:"secrets"`

	// type
	Type string `json:"type,omitempty"`
}

ConnectionType connection type

swagger:model ConnectionType

func (*ConnectionType) ContextValidate

func (m *ConnectionType) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validate this connection type based on the context it is used

func (*ConnectionType) MarshalBinary

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

MarshalBinary interface implementation

func (*ConnectionType) UnmarshalBinary

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

UnmarshalBinary interface implementation

func (*ConnectionType) Validate

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

Validate validates this connection type

type ContactDetails

type ContactDetails struct {

	// Address details for the counterparty.
	Address *Address `json:"address,omitempty"`

	// Email of the counterparty
	// Example: john.smith@example.com
	Email string `json:"email,omitempty"`

	// Deprecated. Has moved to mandates. NationalId is a country-specific identifier of the Counterparty. Could be an SSN, a person-number, company registration code, organization number, etc.
	// Example: 201212121212
	NationalID string `json:"nationalId,omitempty"`

	// Phone number of the counterparty
	// Example: +46123456789
	Phone string `json:"phone,omitempty"`
}

ContactDetails contact details

swagger:model ContactDetails

func (*ContactDetails) ContextValidate

func (m *ContactDetails) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validate this contact details based on the context it is used

func (*ContactDetails) MarshalBinary

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

MarshalBinary interface implementation

func (*ContactDetails) UnmarshalBinary

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

UnmarshalBinary interface implementation

func (*ContactDetails) Validate

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

Validate validates this contact details

type ContactDetailsSlim

type ContactDetailsSlim struct {

	// Address details for the counterparty.
	Address *Address `json:"address,omitempty"`
}

ContactDetailsSlim contact details slim

swagger:model ContactDetailsSlim

func (*ContactDetailsSlim) ContextValidate

func (m *ContactDetailsSlim) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validate this contact details slim based on the context it is used

func (*ContactDetailsSlim) MarshalBinary

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

MarshalBinary interface implementation

func (*ContactDetailsSlim) UnmarshalBinary

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

UnmarshalBinary interface implementation

func (*ContactDetailsSlim) Validate

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

Validate validates this contact details slim

type Counterparty

type Counterparty struct {

	// Contact details of your counterparty.
	// Required: true
	ContactDetails *ContactDetails `json:"contactDetails"`

	// created
	// Example: 2022-05-04T18:31:12.889104898Z
	// Required: true
	Created *string `json:"created"`

	// external accounts
	ExternalAccounts []*ExternalAccount `json:"externalAccounts"`

	// ExternalId is optional to use, but if used, the Atlar platform will persist it, index it, as well as require it to be unique across all Counterparties. It is also possible to retrieve the identified Counterparty using the ExternalId.
	// Example: walVNuin6X5Mvte4xhg1ibTAVSACfN4Q9hl
	ExternalID string `json:"externalId,omitempty"`

	// external metadata
	ExternalMetadata ExternalMetadata `json:"externalMetadata,omitempty"`

	// id
	// Example: f3efbb73-4e5b-4b22-adeb-918bbf1dfbd8
	// Required: true
	ID *string `json:"id"`

	// A list of account identifiers with account numbers that identify this account. A single account identifier can be enough, but some countries use multiple. For example, an account can be described both with an IBAN and one or more local formats.
	Identifiers []*AccountIdentifier `json:"identifiers"`

	// Name of your Counterparty
	// Example: Customer #312
	Name string `json:"name,omitempty"`

	// organization Id
	// Example: 605e26fc-4fce-495a-a92f-2c3592d7287e
	// Required: true
	OrganizationID *string `json:"organizationId"`

	// The legal type of the Counterparty
	// Example: INDIVIDUAL
	// Enum: [INDIVIDUAL COMPANY]
	PartyType string `json:"partyType,omitempty"`

	// updated
	// Example: 2022-05-04T18:31:12.889104898Z
	Updated string `json:"updated,omitempty"`

	// version
	Version int64 `json:"version,omitempty"`
}

Counterparty A Counterparty represents a person or business.

swagger:model Counterparty

func (*Counterparty) ContextValidate

func (m *Counterparty) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validate this counterparty based on the context it is used

func (*Counterparty) MarshalBinary

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

MarshalBinary interface implementation

func (*Counterparty) UnmarshalBinary

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

UnmarshalBinary interface implementation

func (*Counterparty) Validate

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

Validate validates this counterparty

type CounterpartyIdentifier

type CounterpartyIdentifier struct {

	// Type of the identifier. For country specific basic bank account number with bank identifier (e.g. routing or clearing number) choose BBAN. For country specific bank account number without bank identifier (e.g. routing or clearing number) choose ACCOUNT_NUMBER. For further information please refer to Account Identifiers section.
	IdentifierType string `json:"identifierType,omitempty"`

	// markets
	Markets []string `json:"markets"`
}

CounterpartyIdentifier counterparty identifier

swagger:model CounterpartyIdentifier

func (*CounterpartyIdentifier) ContextValidate

func (m *CounterpartyIdentifier) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validates this counterparty identifier based on context it is used

func (*CounterpartyIdentifier) MarshalBinary

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

MarshalBinary interface implementation

func (*CounterpartyIdentifier) UnmarshalBinary

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

UnmarshalBinary interface implementation

func (*CounterpartyIdentifier) Validate

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

Validate validates this counterparty identifier

type CounterpartySlim

type CounterpartySlim struct {

	// contact details
	ContactDetails *ContactDetailsSlim `json:"contactDetails,omitempty"`

	// id
	// Example: f3efbb73-4e5b-4b22-adeb-918bbf1dfbd8
	// Required: true
	ID *string `json:"id"`

	// Deprecated. Has moved to external accounts. A list of AccountIdentifiers. An AccountIdentifier uniquely identifies one bank account.
	Identifiers []*AccountIdentifierSlim `json:"identifiers"`

	// Name of your Counterparty
	// Example: Customer #312
	Name string `json:"name,omitempty"`

	// The legal type of the Counterparty
	// Example: INDIVIDUAL
	PartyType string `json:"partyType,omitempty"`
}

CounterpartySlim counterparty slim

swagger:model CounterpartySlim

func (*CounterpartySlim) ContextValidate

func (m *CounterpartySlim) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validate this counterparty slim based on the context it is used

func (*CounterpartySlim) MarshalBinary

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

MarshalBinary interface implementation

func (*CounterpartySlim) UnmarshalBinary

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

UnmarshalBinary interface implementation

func (*CounterpartySlim) Validate

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

Validate validates this counterparty slim

type CreateAffiliationRequest

type CreateAffiliationRequest struct {

	// DEPRECATED
	BankID string `json:"bankId,omitempty"`

	// name
	Name string `json:"name,omitempty"`

	// third party Id
	ThirdPartyID string `json:"thirdPartyId,omitempty"`
}

CreateAffiliationRequest create affiliation request

swagger:model CreateAffiliationRequest

func (*CreateAffiliationRequest) ContextValidate

func (m *CreateAffiliationRequest) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validates this create affiliation request based on context it is used

func (*CreateAffiliationRequest) MarshalBinary

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

MarshalBinary interface implementation

func (*CreateAffiliationRequest) UnmarshalBinary

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

UnmarshalBinary interface implementation

func (*CreateAffiliationRequest) Validate

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

Validate validates this create affiliation request

type CreateCounterpartyRequest

type CreateCounterpartyRequest struct {

	// Contact details of your counterparty.
	ContactDetails *ContactDetails `json:"contactDetails,omitempty"`

	// An optional list of external accounts to create for this counterparty. This is a separate resource on the API. One counterparty can have multiple external accounts.
	ExternalAccounts []*CreateEmbeddedExternalAccountRequest `json:"externalAccounts"`

	// ExternalId is optional to use, but if used, the Atlar platform will persist it, index it, as well as require it to be unique. It is also possible to retrieve the identified resource using the ExternalId.
	// Example: walVNuin6X5Mvte4xhg1ibTAVSACfN4Q9hl
	ExternalID string `json:"externalId,omitempty"`

	// Any metadata that you might want to store close to the counterparty. This could for example be your own customer ID.
	ExternalMetadata ExternalMetadata `json:"externalMetadata,omitempty"`

	// Name of your Counterparty
	// Example: Customer #312
	// Required: true
	Name *string `json:"name"`

	// The legal type of the Counterparty
	// Example: INDIVIDUAL
	// Enum: [INDIVIDUAL COMPANY]
	PartyType string `json:"partyType,omitempty"`
}

CreateCounterpartyRequest create counterparty request

swagger:model CreateCounterpartyRequest

func (*CreateCounterpartyRequest) ContextValidate

func (m *CreateCounterpartyRequest) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validate this create counterparty request based on the context it is used

func (*CreateCounterpartyRequest) MarshalBinary

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

MarshalBinary interface implementation

func (*CreateCounterpartyRequest) UnmarshalBinary

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

UnmarshalBinary interface implementation

func (*CreateCounterpartyRequest) Validate

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

Validate validates this create counterparty request

type CreateDirectDebitRequest

type CreateDirectDebitRequest struct {

	// The amount that should be collected.
	// Required: true
	Amount *AmountInput `json:"amount"`

	// ISO 20022 Category Purpose Code (ExternalCategoryPurpose1Code). Whether the category purpose code is
	// propagated and/or used throughout the complete chain of payment processing intermediaries and made available to the
	// debtor bank may be subject to bank and scheme specifics. Specifying category purpose is supported for
	// the following schemes: SDD_CORE.
	// Example: SUPP
	CategoryPurpose string `json:"categoryPurpose,omitempty"`

	// The requested execution date with format: `yyyy-mm-dd`. It is a local date from the destination account's point-of-view, without timezone. Cannot be set to before the current date, and not more than 60 days into the future.
	// Example: 2022-05-07
	// Required: true
	Date *string `json:"date"`

	// The ID of your internal account that the money should go to.
	// Example: 75c5b34c-e2b4-416b-9f23-8e797a620768
	// Required: true
	DestinationAccountID *string `json:"destinationAccountId"`

	// The type of this direct debit.
	// Example: SDD_CORE
	// Required: true
	// Enum: [SDD_CORE SDD_B2B AUTOGIRO]
	DirectDebitSchemeType *string `json:"directDebitSchemeType"`

	// ExternalId is optional to use, but if used, the Atlar platform will persist it, index it, as well as require it to be unique across all DirectDebits. It is also possible to retrieve the identified DirectDebit using the ExternalId.
	// Example: walVNuin6X5Mvte4xhg1ibTAVSACfN4Q9hl
	ExternalID string `json:"externalId,omitempty"`

	// Any external metadata you want to attach, such as your own IDs.
	ExternalMetadata ExternalMetadata `json:"externalMetadata,omitempty"`

	// Remittance information that might show up on the debtor's account statement. Whether or not it will show up depends on the direct debit scheme. Should not be set when scheme type is AUTOGIRO.
	RemittanceInformation *RemittanceInformation `json:"remittanceInformation,omitempty"`

	// The ID of the external account to collect money from. External accounts can be created via the API.
	// Example: ba0ad236-2904-4b01-8e85-a4ef3a73c353
	// Required: true
	SourceExternalAccountID *string `json:"sourceExternalAccountId"`
}

CreateDirectDebitRequest create direct debit request

swagger:model CreateDirectDebitRequest

func (*CreateDirectDebitRequest) ContextValidate

func (m *CreateDirectDebitRequest) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validate this create direct debit request based on the context it is used

func (*CreateDirectDebitRequest) MarshalBinary

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

MarshalBinary interface implementation

func (*CreateDirectDebitRequest) UnmarshalBinary

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

UnmarshalBinary interface implementation

func (*CreateDirectDebitRequest) Validate

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

Validate validates this create direct debit request

type CreateEmbeddedExternalAccountRequest

type CreateEmbeddedExternalAccountRequest struct {

	// bank
	Bank *UpdatableBank `json:"bank,omitempty"`

	// Deprecated. Use bank.bic
	Bic string `json:"bic,omitempty"`

	// ExternalId is optional to use, but if used, the Atlar platform will persist it, index it, as well as require it to be unique. It is also possible to retrieve the identified resource using the ExternalId.
	// Example: walVNuin6X5Mvte4xhg1ibTAVSACfN4Q9hl
	ExternalID string `json:"externalId,omitempty"`

	// Any external metadata you want to attach, such as your own internal IDs.
	ExternalMetadata ExternalMetadata `json:"externalMetadata,omitempty"`

	// A list of account identifiers with account numbers that identify this account. A single account identifier can be enough, but some countries use multiple. For example, an account can be described both with an IBAN and one or more local formats.
	// Required: true
	Identifiers []*AccountIdentifier `json:"identifiers"`
}

CreateEmbeddedExternalAccountRequest create embedded external account request

swagger:model CreateEmbeddedExternalAccountRequest

func (*CreateEmbeddedExternalAccountRequest) ContextValidate

func (m *CreateEmbeddedExternalAccountRequest) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validate this create embedded external account request based on the context it is used

func (*CreateEmbeddedExternalAccountRequest) MarshalBinary

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

MarshalBinary interface implementation

func (*CreateEmbeddedExternalAccountRequest) UnmarshalBinary

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

UnmarshalBinary interface implementation

func (*CreateEmbeddedExternalAccountRequest) Validate

Validate validates this create embedded external account request

type CreateExpectedTransactionRequest

type CreateExpectedTransactionRequest struct {

	// The id of the account that the transaction is to be attached to
	// Example: 037a005b-fc83-4c46-95fa-f3922f7ec1f2
	// Required: true
	AccountID *string `json:"accountId"`

	// amount
	// Required: true
	Amount *AmountInput `json:"amount"`

	// Estimated booking date of the transaction on your account. Format as `yyyy-mm-dd`, local date with no timezone from your account's point-of-view.
	// Example: 2022-05-01
	// Required: true
	Date *string `json:"date"`

	// external metadata
	ExternalMetadata ExternalMetadata `json:"externalMetadata,omitempty"`

	// remittance information
	// Required: true
	RemittanceInformation *RemittanceInformation `json:"remittanceInformation"`
}

CreateExpectedTransactionRequest create expected transaction request

swagger:model CreateExpectedTransactionRequest

func (*CreateExpectedTransactionRequest) ContextValidate

func (m *CreateExpectedTransactionRequest) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validate this create expected transaction request based on the context it is used

func (*CreateExpectedTransactionRequest) MarshalBinary

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

MarshalBinary interface implementation

func (*CreateExpectedTransactionRequest) UnmarshalBinary

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

UnmarshalBinary interface implementation

func (*CreateExpectedTransactionRequest) Validate

Validate validates this create expected transaction request

type CreateExternalAccountRequest

type CreateExternalAccountRequest struct {

	// bank
	Bank *UpdatableBank `json:"bank,omitempty"`

	// Deprecated. Use bank.bic
	Bic string `json:"bic,omitempty"`

	// The ID of the counterparty which owns the account.
	// Example: f3efbb73-4e5b-4b22-adeb-918bbf1dfbd8
	// Required: true
	CounterpartyID *string `json:"counterpartyId"`

	// ExternalId is optional to use, but if used, the Atlar platform will persist it, index it, as well as require it to be unique. It is also possible to retrieve the identified resource using the ExternalId.
	// Example: walVNuin6X5Mvte4xhg1ibTAVSACfN4Q9hl
	ExternalID string `json:"externalId,omitempty"`

	// Any external metadata you want to attach, such as your own internal IDs.
	ExternalMetadata ExternalMetadata `json:"externalMetadata,omitempty"`

	// A list of account identifiers with account numbers that identify this account. A single account identifier can be enough, but some countries use multiple. For example, an account can be described both with an IBAN and one or more local formats.
	// Required: true
	Identifiers []*AccountIdentifier `json:"identifiers"`
}

CreateExternalAccountRequest create external account request

swagger:model CreateExternalAccountRequest

func (*CreateExternalAccountRequest) ContextValidate

func (m *CreateExternalAccountRequest) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validate this create external account request based on the context it is used

func (*CreateExternalAccountRequest) MarshalBinary

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

MarshalBinary interface implementation

func (*CreateExternalAccountRequest) UnmarshalBinary

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

UnmarshalBinary interface implementation

func (*CreateExternalAccountRequest) Validate

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

Validate validates this create external account request

type CreateMandateRequest

type CreateMandateRequest struct {

	// Set this to true if this mandate is already known by the bank. This is for example a good option if you're migrating a lot of mandates that you know are already active. The actual outcome of using this flag depends on the direct debit scheme, since all schemes work in slightly different ways. For example, for `AUTOGIRO`, it means that we won't send the mandate prior to making the collection. For other schemes, it could have an effect on how quickly the collection can be executed.
	// Example: false
	Active bool `json:"active,omitempty"`

	// The customer number that you have received from the bank. For `AUTOGIRO` this is your 6 digit customer number.
	// Example: creditor_id_123
	// Required: true
	// Max Length: 35
	// Min Length: 1
	CreditorReference *string `json:"creditorReference"`

	// The ID of the destination account where money will be collected for this mandate. This is only needed for `AUTOGIRO` mandates.
	// Example: 31d593d7-fff9-4783-aa1d-92acb7b21a19
	DestinationAccountID string `json:"destinationAccountId,omitempty"`

	// The scheme type of the direct debits for which this mandate will be used.
	// Example: SDD_CORE
	// Required: true
	// Enum: [SDD_CORE SDD_B2B AUTOGIRO]
	DirectDebitSchemeType *string `json:"directDebitSchemeType"`

	// The ID of the external account which you will make the direct debit collection from. External accounts can be created via the API.
	// Example: ba0ad236-2904-4b01-8e85-a4ef3a73c353
	// Required: true
	ExternalAccountID *string `json:"externalAccountId"`

	// ExternalId is optional to use, but if used, the Atlar platform will persist it, index it, as well as require it to be unique. It is also possible to retrieve the identified resource using the ExternalId.
	// Example: walVNuin6X5Mvte4xhg1ibTAVSACfN4Q9hl
	ExternalID string `json:"externalId,omitempty"`

	// Any external metadata you want to attach, such as your own internal IDs.
	ExternalMetadata ExternalMetadata `json:"externalMetadata,omitempty"`

	// A unique reference to the mandate that you have signed with the debtor. For `AUTOGIRO` this is used as payer number associated with the mandate and validated as 1-16 digits. For `AUTOGIRO`, this reference cannot contain leading 0's.
	// Example: mandate_id_123
	// Required: true
	// Max Length: 35
	// Min Length: 1
	MandateReference *string `json:"mandateReference"`

	// The national identifier of the debtor. This cannot be changed after the mandate has been created.
	NationalIdentifier *NationalIdentifier `json:"nationalIdentifier,omitempty"`

	// The date that this mandate was signed by the end user. Only required for `SDD_CORE`.
	// Example: 2022-08-01
	SignatureDate string `json:"signatureDate,omitempty"`
}

CreateMandateRequest create mandate request

swagger:model CreateMandateRequest

func (*CreateMandateRequest) ContextValidate

func (m *CreateMandateRequest) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validate this create mandate request based on the context it is used

func (*CreateMandateRequest) MarshalBinary

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

MarshalBinary interface implementation

func (*CreateMandateRequest) UnmarshalBinary

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

UnmarshalBinary interface implementation

func (*CreateMandateRequest) Validate

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

Validate validates this create mandate request

type CreateOrderEventBatchRequest

type CreateOrderEventBatchRequest struct {

	// details
	Details OrderEventDetails `json:"details,omitempty"`

	// etag
	Etag string `json:"etag,omitempty"`

	// event
	Event string `json:"event,omitempty"`

	// message
	Message string `json:"message,omitempty"`

	// originator
	Originator string `json:"originator,omitempty"`

	// timestamp
	Timestamp string `json:"timestamp,omitempty"`
}

CreateOrderEventBatchRequest create order event batch request

swagger:model CreateOrderEventBatchRequest

func (*CreateOrderEventBatchRequest) ContextValidate

func (m *CreateOrderEventBatchRequest) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validates this create order event batch request based on context it is used

func (*CreateOrderEventBatchRequest) MarshalBinary

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

MarshalBinary interface implementation

func (*CreateOrderEventBatchRequest) UnmarshalBinary

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

UnmarshalBinary interface implementation

func (*CreateOrderEventBatchRequest) Validate

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

Validate validates this create order event batch request

type CreatePaymentRequest

type CreatePaymentRequest struct {

	// amount
	// Required: true
	Amount *AmountInput `json:"amount"`

	// ISO 20022 Category Purpose Code (ExternalCategoryPurpose1Code). Whether the category purpose code is
	// propagated and/or used throughout the complete chain of payment processing intermediaries and made available to the
	// creditor bank may be subject to bank and scheme specifics. Specifying category purpose is supported for
	// the following schemes: SCT, CROSS_BORDER.
	// Example: SALA
	CategoryPurpose string `json:"categoryPurpose,omitempty"`

	// This field specifies which party should bear the charges of the transaction.
	// If not specified, a default value will be used. This depends on the bank and the scheme, but typically
	// this means that the cost will be shared between the parties.
	// Example: SHARED
	// Enum: [SHARED DEBTOR CREDITOR]
	ChargeBearer string `json:"chargeBearer,omitempty"`

	// The requested execution date with format: `yyyy-mm-dd`. It is a local date from the source account's point-of-view, without timezone. Cannot be set to before the current date, and not more than 60 days into the future.
	// Example: 2022-05-07
	// Required: true
	Date *string `json:"date"`

	// The unique ID of the external destination account as found from /v1/external-accounts.
	// Example: bd8377bf-3eb7-44df-8638-203457afeedf
	// Required: true
	DestinationExternalAccountID *string `json:"destinationExternalAccountId"`

	// ExternalId is optional to use, but if used, the Atlar platform will persist it, index it, as well as require it to be unique. It is also possible to retrieve the identified resource using the ExternalId.
	// Example: walVNuin6X5Mvte4xhg1ibTAVSACfN4Q9hl
	ExternalID string `json:"externalId,omitempty"`

	// external metadata
	ExternalMetadata ExternalMetadata `json:"externalMetadata,omitempty"`

	// The payment scheme that is desired. Choose among SCT (SEPA Credit Transfer), SCT_INST (SEPA Instant Credit Transfer), GB_CT_BACS (UK account-to-account BACS), GB_CT_FPS (UK account-to-account Faster Payments), SE_A2A (Swedish account-to-account), SE_GIRO (Swedish Bank/Plus-giro), DK_A2A (Danish account-to-account), DK_CT_SAMEDAY (Danish same-day credit transfer), DK_CT_INST (Danish instant credit transfer), NO_CT (Norwegian credit transfer), CROSS_BORDER (swift).
	// Example: SCT
	// Required: true
	// Enum: [SCT SCT_INST GB_CT_BACS GB_CT_FPS SE_A2A SE_GIRO DK_A2A DK_CT_SAMEDAY DK_CT_INST CH_CT CROSS_BORDER]
	PaymentSchemeType *string `json:"paymentSchemeType"`

	// RegulatoryReporting is an optional field that can be set when additional
	// information is needed due to regulatory and statutory requirements.
	RegulatoryReporting []*RegulatoryReportingDetail `json:"regulatoryReporting"`

	// remittance information
	// Required: true
	RemittanceInformation *RemittanceInformation `json:"remittanceInformation"`

	// The unique ID of the source account as found from /v1/accounts
	// Example: 75c5b34c-e2b4-416b-9f23-8e797a620768
	// Required: true
	SourceAccountID *string `json:"sourceAccountId"`
}

CreatePaymentRequest create payment request

swagger:model CreatePaymentRequest

func (*CreatePaymentRequest) ContextValidate

func (m *CreatePaymentRequest) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validate this create payment request based on the context it is used

func (*CreatePaymentRequest) MarshalBinary

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

MarshalBinary interface implementation

func (*CreatePaymentRequest) UnmarshalBinary

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

UnmarshalBinary interface implementation

func (*CreatePaymentRequest) Validate

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

Validate validates this create payment request

type CreateRejectRequest

type CreateRejectRequest struct {

	// An optional rejection reason that will propagate to the reject event on the payment.
	// Example: This looks like a duplicate
	// Max Length: 512
	// Min Length: 0
	Reason *string `json:"reason,omitempty"`
}

CreateRejectRequest create reject request

swagger:model CreateRejectRequest

func (*CreateRejectRequest) ContextValidate

func (m *CreateRejectRequest) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validates this create reject request based on context it is used

func (*CreateRejectRequest) MarshalBinary

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

MarshalBinary interface implementation

func (*CreateRejectRequest) UnmarshalBinary

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

UnmarshalBinary interface implementation

func (*CreateRejectRequest) Validate

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

Validate validates this create reject request

type CreateTestbankAccountRequest

type CreateTestbankAccountRequest struct {

	// The BIC code of the bank for the account. Always formatted as 11 characters, if your BIC is only 8 chars, add "XXX" as the last 3 characters.
	Bic string `json:"bic,omitempty"`

	// booked balance
	BookedBalance *AmountInput `json:"bookedBalance,omitempty"`

	// iban
	Iban string `json:"iban,omitempty"`

	// name
	Name string `json:"name,omitempty"`

	// owner name
	OwnerName string `json:"ownerName,omitempty"`
}

CreateTestbankAccountRequest create testbank account request

swagger:model CreateTestbankAccountRequest

func (*CreateTestbankAccountRequest) ContextValidate

func (m *CreateTestbankAccountRequest) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validate this create testbank account request based on the context it is used

func (*CreateTestbankAccountRequest) MarshalBinary

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

MarshalBinary interface implementation

func (*CreateTestbankAccountRequest) UnmarshalBinary

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

UnmarshalBinary interface implementation

func (*CreateTestbankAccountRequest) Validate

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

Validate validates this create testbank account request

type CreateTransactionCharacteristics

type CreateTransactionCharacteristics struct {

	// bank transaction code
	BankTransactionCode *BankTransactionCode `json:"bankTransactionCode,omitempty"`

	// virtual account
	VirtualAccount *TransactionVirtualAccount `json:"virtualAccount,omitempty"`
}

CreateTransactionCharacteristics create transaction characteristics

swagger:model CreateTransactionCharacteristics

func (*CreateTransactionCharacteristics) ContextValidate

func (m *CreateTransactionCharacteristics) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validate this create transaction characteristics based on the context it is used

func (*CreateTransactionCharacteristics) MarshalBinary

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

MarshalBinary interface implementation

func (*CreateTransactionCharacteristics) UnmarshalBinary

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

UnmarshalBinary interface implementation

func (*CreateTransactionCharacteristics) Validate

Validate validates this create transaction characteristics

type CreateWebhookRequest

type CreateWebhookRequest struct {

	// An inclusive filter to specify which resources and events that you are interested in.
	// Required: true
	Filter []*WebhookFilter `json:"filter"`

	// An optional name for your webhook where you could describe its purpose.
	// Example: Payment updates
	Name string `json:"name,omitempty"`

	// The URL to which webhooks will be sent via HTTP POST requests in JSON format. Must use https.
	// Example: https://example.com
	// Required: true
	URL *string `json:"url"`
}

CreateWebhookRequest create webhook request

swagger:model CreateWebhookRequest

func (*CreateWebhookRequest) ContextValidate

func (m *CreateWebhookRequest) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validate this create webhook request based on the context it is used

func (*CreateWebhookRequest) MarshalBinary

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

MarshalBinary interface implementation

func (*CreateWebhookRequest) UnmarshalBinary

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

UnmarshalBinary interface implementation

func (*CreateWebhookRequest) Validate

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

Validate validates this create webhook request

type CreateWizardConnectionRequest

type CreateWizardConnectionRequest struct {

	// connection type Id
	ConnectionTypeID string `json:"connectionTypeId,omitempty"`

	// id
	ID string `json:"id,omitempty"`
}

CreateWizardConnectionRequest create wizard connection request

swagger:model CreateWizardConnectionRequest

func (*CreateWizardConnectionRequest) ContextValidate

func (m *CreateWizardConnectionRequest) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validates this create wizard connection request based on context it is used

func (*CreateWizardConnectionRequest) MarshalBinary

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

MarshalBinary interface implementation

func (*CreateWizardConnectionRequest) UnmarshalBinary

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

UnmarshalBinary interface implementation

func (*CreateWizardConnectionRequest) Validate

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

Validate validates this create wizard connection request

type Currency

type Currency struct {

	// code
	Code string `json:"code,omitempty"`

	// number decimals
	NumberDecimals int64 `json:"numberDecimals,omitempty"`
}

Currency currency

swagger:model Currency

func (*Currency) ContextValidate

func (m *Currency) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validates this currency based on context it is used

func (*Currency) MarshalBinary

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

MarshalBinary interface implementation

func (*Currency) UnmarshalBinary

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

UnmarshalBinary interface implementation

func (*Currency) Validate

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

Validate validates this currency

type CurrencyExchange

type CurrencyExchange struct {

	// The exchange rate that was reported by the bank. Atlar will not try to calculate this in cases where the information isn't present.
	// Example: 11.21320
	ExchangeRate string `json:"exchangeRate,omitempty"`

	// The currency from which the amount was converted.
	// Example: EUR
	SourceCurrency string `json:"sourceCurrency,omitempty"`

	// The currency to which the amount was converted.
	// Example: SEK
	TargetCurrency string `json:"targetCurrency,omitempty"`

	// One unit of this currency multiplied by the exchange rate will equal the target currency.
	// Example: EUR
	UnitCurrency string `json:"unitCurrency,omitempty"`
}

CurrencyExchange currency exchange

swagger:model CurrencyExchange

func (*CurrencyExchange) ContextValidate

func (m *CurrencyExchange) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validates this currency exchange based on context it is used

func (*CurrencyExchange) MarshalBinary

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

MarshalBinary interface implementation

func (*CurrencyExchange) UnmarshalBinary

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

UnmarshalBinary interface implementation

func (*CurrencyExchange) Validate

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

Validate validates this currency exchange

type DataPoint

type DataPoint struct {

	// The X-axis value (group). Depends on what groupBy was set to in the DataSeries.
	X string `json:"x,omitempty"`

	// The Y-axis value for this group.
	Y float64 `json:"y,omitempty"`
}

DataPoint data point

swagger:model DataPoint

func (*DataPoint) ContextValidate

func (m *DataPoint) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validates this data point based on context it is used

func (*DataPoint) MarshalBinary

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

MarshalBinary interface implementation

func (*DataPoint) UnmarshalBinary

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

UnmarshalBinary interface implementation

func (*DataPoint) Validate

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

Validate validates this data point

type DataSeries

type DataSeries struct {

	// A list of data points for an x- and y-axis.
	DataPoints []*DataPoint `json:"dataPoints"`

	// The grouping factor. Could e.g. be date, hour or account ID. Each statistic will support different grouping options.
	// Example: DATE
	GroupBy string `json:"groupBy,omitempty"`
}

DataSeries data series

swagger:model DataSeries

func (*DataSeries) ContextValidate

func (m *DataSeries) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validate this data series based on the context it is used

func (*DataSeries) MarshalBinary

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

MarshalBinary interface implementation

func (*DataSeries) UnmarshalBinary

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

UnmarshalBinary interface implementation

func (*DataSeries) Validate

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

Validate validates this data series

type DeprecatedCreditTransferScheme added in v1.2.0

type DeprecatedCreditTransferScheme struct {

	// display name
	// Example: Sepa Credit Transfer
	DisplayName string `json:"displayName,omitempty"`

	// type
	// Example: SCT
	Type string `json:"type,omitempty"`
}

DeprecatedCreditTransferScheme Deprecated. Use `paymentSchemeType` instead.

swagger:model DeprecatedCreditTransferScheme

func (*DeprecatedCreditTransferScheme) ContextValidate added in v1.2.0

func (m *DeprecatedCreditTransferScheme) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validates this deprecated credit transfer scheme based on context it is used

func (*DeprecatedCreditTransferScheme) MarshalBinary added in v1.2.0

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

MarshalBinary interface implementation

func (*DeprecatedCreditTransferScheme) UnmarshalBinary added in v1.2.0

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

UnmarshalBinary interface implementation

func (*DeprecatedCreditTransferScheme) Validate added in v1.2.0

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

Validate validates this deprecated credit transfer scheme

type DirectDebit

type DirectDebit struct {

	// The amount and currency of this direct debit.
	Amount *Amount `json:"amount,omitempty"`

	// The approval chain that this direct debit triggered. The direct debit will stay in `CREATED` until the full chain is approved. You can configure approval chains in the Dashboard.
	ApprovalChain *PaymentApprovalChain `json:"approvalChain,omitempty"`

	// attached transactions
	AttachedTransactions []*AttachedTransaction `json:"attachedTransactions"`

	// ISO 20022 Category Purpose Code.
	// Example: SUPP
	CategoryPurpose string `json:"categoryPurpose,omitempty"`

	// The ID of the instruction that was sent to the bank where this direct debit was included when it was created.
	// Example: c1d6502c-07c7-4c77-bee5-963f9464c7d8
	ConnectionInstructionID string `json:"connectionInstructionId,omitempty"`

	// The time that this resource was created.
	// Example: 2023-01-20T18:31:12.889104898Z
	Created string `json:"created,omitempty"`

	// The requested execution date. Format: `yyyy-mm-dd`.
	// Example: 2022-05-07
	Date string `json:"date,omitempty"`

	// @description Your bank account where money will be collected. The account is frozen in time at creation of the direct debit which means that if it's modified later on the API it won't change here.
	DestinationAccount *AccountSlim `json:"destinationAccount,omitempty"`

	// The scheme for this direct debit.
	// Example: SDD_CORE
	DirectDebitSchemeType string `json:"directDebitSchemeType,omitempty"`

	// The ETag based on version. To be passed along in `If-Match` header when updating a DirectDebit
	// Example: version:1
	Etag string `json:"etag,omitempty"`

	// ExternalId is optional to use, but if used, the Atlar platform will persist it, index it, as well as require it to be unique across all DirectDebits. It is also possible to retrieve the identified DirectDebit using the ExternalId.
	// Example: walVNuin6X5Mvte4xhg1ibTAVSACfN4Q9hl
	ExternalID string `json:"externalId,omitempty"`

	// Any external metadata you want to attach, such as your own IDs.
	ExternalMetadata ExternalMetadata `json:"externalMetadata,omitempty"`

	// The unique ID of this direct debit.
	// Example: 76992987-48fc-4b03-b609-ea6fdc3045b4
	ID string `json:"id,omitempty"`

	// The mandate which represents the end user's consent to executing this direct debit.
	Mandate *Mandate `json:"mandate,omitempty"`

	// Your organization ID.
	// Example: 605e26fc-4fce-495a-a92f-2c3592d7287e
	OrganizationID string `json:"organizationId,omitempty"`

	// Will become populated if/when this direct debit is reconciled.
	Reconciliation *ReconciliationDetails `json:"reconciliation,omitempty"`

	// Remittance information that might show up on the debtor's account statement. Whether or not it will show up depends on the direct debit scheme.
	RemittanceInformation *RemittanceInformation `json:"remittanceInformation,omitempty"`

	// The external account from where the money has or will be collected. The external account is frozen in time at creation of the direct debit which means that if it's modified later on the API it won't change here.
	SourceExternalAccount *ExternalAccount `json:"sourceExternalAccount,omitempty"`

	// The current status of the direct debit.
	// Example: SENT
	// Enum: [CREATED APPROVED REJECTED PENDING_SUBMISSION SENT ACCEPTED EXECUTED FAILED RECONCILED RETURNED]
	Status string `json:"status,omitempty"`

	// starts at 1 when the direct debit is created and increases by one in each successive update
	// Example: 1
	Version int64 `json:"version,omitempty"`
}

DirectDebit direct debit

swagger:model DirectDebit

func (*DirectDebit) ContextValidate

func (m *DirectDebit) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validate this direct debit based on the context it is used

func (*DirectDebit) MarshalBinary

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

MarshalBinary interface implementation

func (*DirectDebit) UnmarshalBinary

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

UnmarshalBinary interface implementation

func (*DirectDebit) Validate

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

Validate validates this direct debit

type DirectDebitScheme

type DirectDebitScheme struct {

	// counterparty identifiers
	CounterpartyIdentifiers []*CounterpartyIdentifier `json:"counterpartyIdentifiers"`

	// currency
	// Example: EUR
	Currency string `json:"currency,omitempty"`

	// markets
	// Example: ["SE","DE","FI","NO"]
	Markets []string `json:"markets"`

	// type
	// Example: SDD_CORE
	Type string `json:"type,omitempty"`
}

DirectDebitScheme direct debit scheme

swagger:model DirectDebitScheme

func (*DirectDebitScheme) ContextValidate

func (m *DirectDebitScheme) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validate this direct debit scheme based on the context it is used

func (*DirectDebitScheme) MarshalBinary

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

MarshalBinary interface implementation

func (*DirectDebitScheme) UnmarshalBinary

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

UnmarshalBinary interface implementation

func (*DirectDebitScheme) Validate

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

Validate validates this direct debit scheme

type Email

type Email struct {

	// address
	// Example: john.smith@johnnysmithson.com
	Address string `json:"address,omitempty"`

	// verified
	// Example: true
	Verified string `json:"verified,omitempty"`
}

Email email

swagger:model Email

func (*Email) ContextValidate

func (m *Email) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validates this email based on context it is used

func (*Email) MarshalBinary

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

MarshalBinary interface implementation

func (*Email) UnmarshalBinary

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

UnmarshalBinary interface implementation

func (*Email) Validate

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

Validate validates this email

type ErrorDetails

type ErrorDetails struct {

	// An error code for this error. Not always present.
	// Example: invalid_value
	Code string `json:"code,omitempty"`

	// A description of this specific error.
	// Example: Must be one of [direct_debits mandates payments]
	Error string `json:"error,omitempty"`

	// The field which has an error. This only set if the error has to do with a specific field, such as for validation errors. Nested fields are concatenated with `.`, as well as indexed fields in lists.
	// Example: filter.0.resource
	Field string `json:"field,omitempty"`
}

ErrorDetails error details

swagger:model ErrorDetails

func (*ErrorDetails) ContextValidate

func (m *ErrorDetails) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validates this error details based on context it is used

func (*ErrorDetails) MarshalBinary

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

MarshalBinary interface implementation

func (*ErrorDetails) UnmarshalBinary

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

UnmarshalBinary interface implementation

func (*ErrorDetails) Validate

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

Validate validates this error details

type ErrorResponse

type ErrorResponse struct {

	// A list of details for each error that occurred.
	Details []*ErrorDetails `json:"details"`

	// A top-level message describing the error(s).
	// Example: There is some problem with the data you submitted.
	Message string `json:"message,omitempty"`

	// The HTTP status code.
	// Example: 400
	Status int64 `json:"status,omitempty"`
}

ErrorResponse error response

swagger:model ErrorResponse

func (*ErrorResponse) ContextValidate

func (m *ErrorResponse) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validate this error response based on the context it is used

func (*ErrorResponse) MarshalBinary

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

MarshalBinary interface implementation

func (*ErrorResponse) UnmarshalBinary

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

UnmarshalBinary interface implementation

func (*ErrorResponse) Validate

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

Validate validates this error response

type Event

type Event struct {

	// Additional details which help describe this event.
	Details map[string]string `json:"details,omitempty"`

	// The ID of the API resource that this event belongs to.
	// Example: bc14f69b-a191-4dce-9f70-48376bbed8d2
	// Required: true
	EntityID *string `json:"entityId"`

	// The ID of the event.
	// Example: 0
	// Required: true
	ID *int64 `json:"id"`

	// A message which could either be a message from the bank or an explanation of the event.
	Message string `json:"message,omitempty"`

	// The event name. Different resources have different sets of event names.
	// Example: CREATED
	// Required: true
	Name *string `json:"name"`

	// Your organization ID.
	// Example: 605e26fc-4fce-495a-a92f-2c3592d7287e
	// Required: true
	OrganizationID *string `json:"organizationId"`

	// The originator of the event which could be either a user ID, BANK or AVANTIR.
	// Required: true
	Originator *string `json:"originator"`

	// When the event happened.
	// Example: 2022-08-20T12:20:40.866061374Z
	// Required: true
	Timestamp *string `json:"timestamp"`
}

Event event

swagger:model Event

func (*Event) ContextValidate

func (m *Event) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validates this event based on context it is used

func (*Event) MarshalBinary

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

MarshalBinary interface implementation

func (*Event) UnmarshalBinary

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

UnmarshalBinary interface implementation

func (*Event) Validate

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

Validate validates this event

type ExpectedTransaction

type ExpectedTransaction struct {

	// account
	Account *AccountTrx `json:"account,omitempty"`

	// amount
	Amount *Amount `json:"amount,omitempty"`

	// The time this resource was created.
	// Example: 2022-07-20T18:31:12.889104898Z
	Created string `json:"created,omitempty"`

	// yyyy-mm-dd
	// Example: 2022-05-01
	Date string `json:"date,omitempty"`

	// external metadata
	ExternalMetadata ExternalMetadata `json:"externalMetadata,omitempty"`

	// id
	// Example: e37235aa-adab-11ec-8029-96ac651c9332
	ID string `json:"id,omitempty"`

	// organization Id
	// Example: 605e26fc-4fce-495a-a92f-2c3592d7287e
	OrganizationID string `json:"organizationId,omitempty"`

	// reconciliation
	Reconciliation *ReconciliationDetails `json:"reconciliation,omitempty"`

	// remittance information
	RemittanceInformation *RemittanceInformation `json:"remittanceInformation,omitempty"`

	// The current status of the expected transaction.
	// Example: RECONCILED
	Status string `json:"status,omitempty"`

	// The time this resource was updated.
	// Example: 2022-07-20T18:33:12.889104898Z
	Updated string `json:"updated,omitempty"`

	// version
	Version int64 `json:"version,omitempty"`
}

ExpectedTransaction expected transaction

swagger:model ExpectedTransaction

func (*ExpectedTransaction) ContextValidate

func (m *ExpectedTransaction) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validate this expected transaction based on the context it is used

func (*ExpectedTransaction) MarshalBinary

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

MarshalBinary interface implementation

func (*ExpectedTransaction) UnmarshalBinary

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

UnmarshalBinary interface implementation

func (*ExpectedTransaction) Validate

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

Validate validates this expected transaction

type ExternalAccount

type ExternalAccount struct {

	// The bank to which this external account belongs.
	Bank *BankSlim `json:"bank,omitempty"`

	// The ID of the counterparty to which this external account belongs.
	// Example: f3efbb73-4e5b-4b22-adeb-918bbf1dfbd8
	CounterpartyID string `json:"counterpartyId,omitempty"`

	// The time this resource was created.
	// Example: 2022-07-20T18:31:12.889104898Z
	Created string `json:"created,omitempty"`

	// ExternalId is optional to use, but if used, the Atlar platform will persist it, index it, as well as require it to be unique. It is also possible to retrieve the identified resource using the ExternalId.
	// Example: walVNuin6X5Mvte4xhg1ibTAVSACfN4Q9hl
	ExternalID string `json:"externalId,omitempty"`

	// Any external metadata you want to attach, such as your own internal IDs.
	ExternalMetadata ExternalMetadata `json:"externalMetadata,omitempty"`

	// The unique identifier of this external acocunt.
	// Example: be7e04fe-3fa0-48f5-a993-2008409255f2
	ID string `json:"id,omitempty"`

	// A list of account identifiers with account numbers that identify this account. A single account identifier can be enough, but some countries use multiple. For example, an account can be described both with an IBAN and one or more local formats.
	Identifiers []*AccountIdentifier `json:"identifiers"`

	// Your organization ID.
	// Example: 605e26fc-4fce-495a-a92f-2c3592d7287e
	OrganizationID string `json:"organizationId,omitempty"`

	// The last time this resource was updated.
	// Example: 2022-05-20T18:31:12.889104898Z
	Updated string `json:"updated,omitempty"`
}

ExternalAccount An ExternalAccount represents an account that does not belong to your organization. A Counterparty can have multiple external accounts.

swagger:model ExternalAccount

func (*ExternalAccount) ContextValidate

func (m *ExternalAccount) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validate this external account based on the context it is used

func (*ExternalAccount) MarshalBinary

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

MarshalBinary interface implementation

func (*ExternalAccount) UnmarshalBinary

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

UnmarshalBinary interface implementation

func (*ExternalAccount) Validate

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

Validate validates this external account

type ExternalAccountSlim

type ExternalAccountSlim struct {

	// The bank to which this external account belongs.
	// Required: true
	Bank *BankSlim `json:"bank"`

	// The ID of the counterparty to which this external account belongs.
	// Example: f3efbb73-4e5b-4b22-adeb-918bbf1dfbd8
	// Required: true
	CounterpartyID *string `json:"counterpartyId"`

	// The unique identifier of this external acocunt.
	// Example: be7e04fe-3fa0-48f5-a993-2008409255f2
	// Required: true
	ID *string `json:"id"`

	// A list of account identifiers with account numbers that identify this account. A single account identifier can be enough, but some countries use multiple. For example, an account can be described both with an IBAN and one or more local formats.
	// Required: true
	Identifiers []*AccountIdentifierSlim `json:"identifiers"`

	// Your organization ID.
	// Example: 605e26fc-4fce-495a-a92f-2c3592d7287e
	// Required: true
	OrganizationID *string `json:"organizationId"`
}

ExternalAccountSlim external account slim

swagger:model ExternalAccountSlim

func (*ExternalAccountSlim) ContextValidate

func (m *ExternalAccountSlim) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validate this external account slim based on the context it is used

func (*ExternalAccountSlim) MarshalBinary

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

MarshalBinary interface implementation

func (*ExternalAccountSlim) UnmarshalBinary

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

UnmarshalBinary interface implementation

func (*ExternalAccountSlim) Validate

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

Validate validates this external account slim

type ExternalMetadata

type ExternalMetadata map[string]string

ExternalMetadata ExternalMetadata is a string-string key-value store that can be used to store information known at the time of resource creation. This way it can be retrieved later on, for instance when a payment or expected transaction is reconciled with the booked transaction on the bank statement. ExternalMetadata can have at most 20 entries. Keys may have a maximum length of 64 chars and values a maximum length of 512 chars. By default, this field is optional. It is possible to make it required in the Atlar Dashboard by visiting the Metadata keys page. Requirement rules can be specified per API resource. Both the Dashboard and the API will then enforce these rules and give validation errors when the required fields are not set.

swagger:model ExternalMetadata

func (ExternalMetadata) ContextValidate

func (m ExternalMetadata) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validates this external metadata based on context it is used

func (ExternalMetadata) Validate

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

Validate validates this external metadata

type FetchCapabilities

type FetchCapabilities struct {

	// supported
	Supported bool `json:"supported,omitempty"`
}

FetchCapabilities fetch capabilities

swagger:model FetchCapabilities

func (*FetchCapabilities) ContextValidate

func (m *FetchCapabilities) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validates this fetch capabilities based on context it is used

func (*FetchCapabilities) MarshalBinary

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

MarshalBinary interface implementation

func (*FetchCapabilities) UnmarshalBinary

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

UnmarshalBinary interface implementation

func (*FetchCapabilities) Validate

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

Validate validates this fetch capabilities

type IdentifierMarketIdentifiers

type IdentifierMarketIdentifiers struct {

	// identifiers
	Identifiers []string `json:"identifiers"`

	// market
	Market string `json:"market,omitempty"`
}

IdentifierMarketIdentifiers identifier market identifiers

swagger:model identifier.MarketIdentifiers

func (*IdentifierMarketIdentifiers) ContextValidate

func (m *IdentifierMarketIdentifiers) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validates this identifier market identifiers based on context it is used

func (*IdentifierMarketIdentifiers) MarshalBinary

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

MarshalBinary interface implementation

func (*IdentifierMarketIdentifiers) UnmarshalBinary

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

UnmarshalBinary interface implementation

func (*IdentifierMarketIdentifiers) Validate

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

Validate validates this identifier market identifiers

type Limitations added in v1.2.0

type Limitations struct {

	// currencies
	Currencies []string `json:"currencies"`

	// identifier types
	IdentifierTypes []string `json:"identifierTypes"`

	// markets
	Markets []string `json:"markets"`
}

Limitations limitations

swagger:model Limitations

func (*Limitations) ContextValidate added in v1.2.0

func (m *Limitations) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validates this limitations based on context it is used

func (*Limitations) MarshalBinary added in v1.2.0

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

MarshalBinary interface implementation

func (*Limitations) UnmarshalBinary added in v1.2.0

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

UnmarshalBinary interface implementation

func (*Limitations) Validate added in v1.2.0

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

Validate validates this limitations

type MainapiDirectDebitCapability

type MainapiDirectDebitCapability struct {

	// possible counterparty identifier types
	PossibleCounterpartyIdentifierTypes []*CounterpartyIdentifier `json:"possibleCounterpartyIdentifierTypes"`

	// scheme
	Scheme *DirectDebitScheme `json:"scheme,omitempty"`
}

MainapiDirectDebitCapability mainapi direct debit capability

swagger:model mainapi.DirectDebitCapability

func (*MainapiDirectDebitCapability) ContextValidate

func (m *MainapiDirectDebitCapability) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validate this mainapi direct debit capability based on the context it is used

func (*MainapiDirectDebitCapability) MarshalBinary

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

MarshalBinary interface implementation

func (*MainapiDirectDebitCapability) UnmarshalBinary

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

UnmarshalBinary interface implementation

func (*MainapiDirectDebitCapability) Validate

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

Validate validates this mainapi direct debit capability

type MainapiSearchResponseTotalHits

type MainapiSearchResponseTotalHits struct {

	// Indicates whether the number of resources in the value parameter is exact (eq) or a lower bound (gte).
	// Example: eq
	Relation string `json:"relation,omitempty"`

	// Indicates the number of resources in the search response
	// Example: 100
	Value int64 `json:"value,omitempty"`
}

MainapiSearchResponseTotalHits mainapi search response total hits

swagger:model mainapi.SearchResponseTotalHits

func (*MainapiSearchResponseTotalHits) ContextValidate

func (m *MainapiSearchResponseTotalHits) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validates this mainapi search response total hits based on context it is used

func (*MainapiSearchResponseTotalHits) MarshalBinary

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

MarshalBinary interface implementation

func (*MainapiSearchResponseTotalHits) UnmarshalBinary

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

UnmarshalBinary interface implementation

func (*MainapiSearchResponseTotalHits) Validate

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

Validate validates this mainapi search response total hits

type MainapiSignatureCapability

type MainapiSignatureCapability struct {

	// scheme
	Scheme *SchemesSignatureScheme `json:"scheme,omitempty"`
}

MainapiSignatureCapability mainapi signature capability

swagger:model mainapi.SignatureCapability

func (*MainapiSignatureCapability) ContextValidate

func (m *MainapiSignatureCapability) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validate this mainapi signature capability based on the context it is used

func (*MainapiSignatureCapability) MarshalBinary

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

MarshalBinary interface implementation

func (*MainapiSignatureCapability) UnmarshalBinary

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

UnmarshalBinary interface implementation

func (*MainapiSignatureCapability) Validate

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

Validate validates this mainapi signature capability

type MainapiTransferCapability

type MainapiTransferCapability struct {

	// destination bic required
	DestinationBicRequired bool `json:"destinationBicRequired,omitempty"`

	// possible counterparty identifier types
	PossibleCounterpartyIdentifierTypes []*CounterpartyIdentifier `json:"possibleCounterpartyIdentifierTypes"`

	// scheme
	Scheme *TransferScheme `json:"scheme,omitempty"`
}

MainapiTransferCapability mainapi transfer capability

swagger:model mainapi.TransferCapability

func (*MainapiTransferCapability) ContextValidate

func (m *MainapiTransferCapability) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validate this mainapi transfer capability based on the context it is used

func (*MainapiTransferCapability) MarshalBinary

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

MarshalBinary interface implementation

func (*MainapiTransferCapability) UnmarshalBinary

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

UnmarshalBinary interface implementation

func (*MainapiTransferCapability) Validate

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

Validate validates this mainapi transfer capability

type Mandate

type Mandate struct {

	// The ID of the instruction that was sent to the bank where this mandate was included when it was created. Subsequent instructions, such as mandate cancellations, won't update this ID. It will always refer to the instruction which created the resource.
	// Example: c1d6502c-07c7-4c77-bee5-963f9464c7d8
	ConnectionInstructionID string `json:"connectionInstructionId,omitempty"`

	// The ID of the counterparty which owns this mandate.
	// Example: f3efbb73-4e5b-4b22-adeb-918bbf1dfbd8
	// Required: true
	CounterpartyID *string `json:"counterpartyId"`

	// A timestamp showing when this mandate was created.
	// Example: 2022-07-20T18:31:12.889104898Z
	// Required: true
	Created *string `json:"created"`

	// The customer number that you have received from the bank.
	CreditorReference string `json:"creditorReference,omitempty"`

	// The ID of the destination account where money will be collected for this mandate. This is only needed for `AUTOGIRO` mandates.
	// Example: 31d593d7-fff9-4783-aa1d-92acb7b21a19
	DestinationAccountID string `json:"destinationAccountId,omitempty"`

	// The scheme type of the direct debits for which this mandate will be used.
	// Example: SDD_CORE
	// Required: true
	DirectDebitSchemeType *string `json:"directDebitSchemeType"`

	// The ETag based on version. To be passed along in `If-Match` header when updating a Mandate
	// Example: version:1
	Etag string `json:"etag,omitempty"`

	// The ID of the external account to which this mandate belongs.
	// Example: ba0ad236-2904-4b01-8e85-a4ef3a73c353
	// Required: true
	ExternalAccountID *string `json:"externalAccountId"`

	// ExternalId is optional to use, but if used, the Atlar platform will persist it, index it, as well as require it to be unique. It is also possible to retrieve the identified resource using the ExternalId.
	// Example: walVNuin6X5Mvte4xhg1ibTAVSACfN4Q9hl
	ExternalID string `json:"externalId,omitempty"`

	// Any external metadata you want to attach, such as your own internal IDs.
	ExternalMetadata ExternalMetadata `json:"externalMetadata,omitempty"`

	// The unique identifier of this mandate.
	// Example: be7e04fe-3fa0-48f5-a993-2008409255f2
	// Required: true
	ID *string `json:"id"`

	// A unique reference to the mandate that you have signed with the debtor.
	MandateReference string `json:"mandateReference,omitempty"`

	// The national identifier of the debtor. This cannot be changed after the mandate has been created.
	NationalIdentifier *NationalIdentifier `json:"nationalIdentifier,omitempty"`

	// Your organization ID.
	// Example: 605e26fc-4fce-495a-a92f-2c3592d7287e
	// Required: true
	OrganizationID *string `json:"organizationId"`

	// The date that this mandate was signed by the end user.
	// Example: 2022-08-01
	SignatureDate string `json:"signatureDate,omitempty"`

	// The current status of the mandate.
	// Example: SENT
	// Required: true
	// Enum: [CREATED PENDING_CANCELLATION PENDING_CANCELLATION_SUBMISSION CANCELLATION_SENT PENDING_SUBMISSION SENT ACCEPTED ACTIVE FAILED CANCELLED]
	Status *string `json:"status"`

	// A timestamp showing when this mandate was last updated.
	// Example: 2022-05-20T18:31:12.889104898Z
	// Required: true
	Updated *string `json:"updated"`

	// starts at 1 when the mandate is created and increases by one in each successive update
	Version int64 `json:"version,omitempty"`
}

Mandate mandate

swagger:model Mandate

func (*Mandate) ContextValidate

func (m *Mandate) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validate this mandate based on the context it is used

func (*Mandate) MarshalBinary

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

MarshalBinary interface implementation

func (*Mandate) UnmarshalBinary

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

UnmarshalBinary interface implementation

func (*Mandate) Validate

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

Validate validates this mandate

type MandateEventDetails

type MandateEventDetails interface{}

MandateEventDetails mandate event details

swagger:model MandateEventDetails

type Market

type Market struct {

	// code
	Code string `json:"code,omitempty"`

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

Market market

swagger:model Market

func (*Market) ContextValidate

func (m *Market) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validate this market based on the context it is used

func (*Market) MarshalBinary

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

MarshalBinary interface implementation

func (*Market) UnmarshalBinary

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

UnmarshalBinary interface implementation

func (*Market) Validate

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

Validate validates this market

type Membership

type Membership struct {

	// created
	Created string `json:"created,omitempty"`

	// mfa settings
	MfaSettings []*MfaSetting `json:"mfaSettings"`

	// organization Id
	OrganizationID string `json:"organizationId,omitempty"`

	// organization name
	OrganizationName string `json:"organizationName,omitempty"`

	// role Id
	RoleID string `json:"roleId,omitempty"`

	// role type
	// Example: REGULAR_ROLE
	// Enum: [SERVICE_ROLE OPERATOR_ROLE REGULAR_ROLE]
	RoleType string `json:"roleType,omitempty"`

	// updated
	Updated string `json:"updated,omitempty"`

	// user
	User *UserSlim `json:"user,omitempty"`
}

Membership membership

swagger:model Membership

func (*Membership) ContextValidate

func (m *Membership) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validate this membership based on the context it is used

func (*Membership) MarshalBinary

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

MarshalBinary interface implementation

func (*Membership) UnmarshalBinary

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

UnmarshalBinary interface implementation

func (*Membership) Validate

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

Validate validates this membership

type MfaSetting

type MfaSetting struct {

	// type
	Type string `json:"type,omitempty"`
}

MfaSetting mfa setting

swagger:model MfaSetting

func (*MfaSetting) ContextValidate

func (m *MfaSetting) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validates this mfa setting based on context it is used

func (*MfaSetting) MarshalBinary

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

MarshalBinary interface implementation

func (*MfaSetting) UnmarshalBinary

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

UnmarshalBinary interface implementation

func (*MfaSetting) Validate

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

Validate validates this mfa setting

type MfaTotpParams

type MfaTotpParams struct {

	// code
	Code string `json:"code,omitempty"`
}

MfaTotpParams mfa totp params

swagger:model MfaTotpParams

func (*MfaTotpParams) ContextValidate

func (m *MfaTotpParams) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validates this mfa totp params based on context it is used

func (*MfaTotpParams) MarshalBinary

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

MarshalBinary interface implementation

func (*MfaTotpParams) UnmarshalBinary

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

UnmarshalBinary interface implementation

func (*MfaTotpParams) Validate

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

Validate validates this mfa totp params

type MiscAvailableScopes

type MiscAvailableScopes struct {

	// methods
	Methods []string `json:"methods"`

	// resources
	Resources []string `json:"resources"`
}

MiscAvailableScopes misc available scopes

swagger:model misc.availableScopes

func (*MiscAvailableScopes) ContextValidate

func (m *MiscAvailableScopes) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validates this misc available scopes based on context it is used

func (*MiscAvailableScopes) MarshalBinary

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

MarshalBinary interface implementation

func (*MiscAvailableScopes) UnmarshalBinary

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

UnmarshalBinary interface implementation

func (*MiscAvailableScopes) Validate

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

Validate validates this misc available scopes

type NationalIdentifier

type NationalIdentifier struct {

	// ISO3166 Alpha2 country code
	// Example: SE
	Market string `json:"market,omitempty"`

	// The identifier itself.
	// Example: 2012121212
	Number string `json:"number,omitempty"`

	// Type of the national identifier.
	// Example: CIVIC
	// Enum: [CIVIC COMPANY]
	Type string `json:"type,omitempty"`
}

NationalIdentifier national identifier

swagger:model NationalIdentifier

func (*NationalIdentifier) ContextValidate

func (m *NationalIdentifier) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validates this national identifier based on context it is used

func (*NationalIdentifier) MarshalBinary

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

MarshalBinary interface implementation

func (*NationalIdentifier) UnmarshalBinary

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

UnmarshalBinary interface implementation

func (*NationalIdentifier) Validate

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

Validate validates this national identifier

type OrderEventDetails

type OrderEventDetails interface{}

OrderEventDetails order event details

swagger:model OrderEventDetails

type Organization

type Organization struct {

	// created
	Created string `json:"created,omitempty"`

	// id
	ID string `json:"id,omitempty"`

	// name
	Name string `json:"name,omitempty"`

	// updated
	Updated string `json:"updated,omitempty"`
}

Organization organization

swagger:model Organization

func (*Organization) ContextValidate

func (m *Organization) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validates this organization based on context it is used

func (*Organization) MarshalBinary

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

MarshalBinary interface implementation

func (*Organization) UnmarshalBinary

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

UnmarshalBinary interface implementation

func (*Organization) Validate

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

Validate validates this organization

type PartyIdentification

type PartyIdentification struct {

	// name
	// Example: Example Company Inc.
	Name string `json:"name,omitempty"`
}

PartyIdentification party identification

swagger:model PartyIdentification

func (*PartyIdentification) ContextValidate

func (m *PartyIdentification) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validates this party identification based on context it is used

func (*PartyIdentification) MarshalBinary

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

MarshalBinary interface implementation

func (*PartyIdentification) UnmarshalBinary

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

UnmarshalBinary interface implementation

func (*PartyIdentification) Validate

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

Validate validates this party identification

type Payment

type Payment struct {

	// amount
	Amount *Amount `json:"amount,omitempty"`

	// approval chain
	ApprovalChain *PaymentApprovalChain `json:"approvalChain,omitempty"`

	// attached transactions
	AttachedTransactions []*AttachedTransaction `json:"attachedTransactions"`

	// ISO 20022 Category Purpose Code (ExternalCategoryPurpose1Code).
	// Example: SALA
	CategoryPurpose string `json:"categoryPurpose,omitempty"`

	// This field specifies which party should bear the charges of the transaction.
	// Example: SHARED
	// Enum: [SHARED DEBTOR CREDITOR]
	ChargeBearer string `json:"chargeBearer,omitempty"`

	// The ID of the instruction that was sent to the bank where this credit transfer was included when it was created.
	// Example: c1d6502c-07c7-4c77-bee5-963f9464c7d8
	ConnectionInstructionID string `json:"connectionInstructionId,omitempty"`

	// created
	Created string `json:"created,omitempty"`

	// yyyy-mm-dd local date, no timezone
	// Example: 2022-05-07
	Date string `json:"date,omitempty"`

	// destination counterparty
	DestinationCounterparty *CounterpartySlim `json:"destinationCounterparty,omitempty"`

	// destination external account
	DestinationExternalAccount *ExternalAccountSlim `json:"destinationExternalAccount,omitempty"`

	// The ETag based on version. To be passed along in `If-Match` header when updating a CreditTransfer
	// Example: version:1
	Etag string `json:"etag,omitempty"`

	// ExternalId is optional to use, but if used, the Atlar platform will persist it, index it, as well as require it to be unique. It is also possible to retrieve the identified resource using the ExternalId.
	// Example: walVNuin6X5Mvte4xhg1ibTAVSACfN4Q9hl
	ExternalID string `json:"externalId,omitempty"`

	// external metadata
	ExternalMetadata ExternalMetadata `json:"externalMetadata,omitempty"`

	// id
	// Example: 76992987-48fc-4b03-b609-ea6fdc3045b4
	ID string `json:"id,omitempty"`

	// organization Id
	// Example: 605e26fc-4fce-495a-a92f-2c3592d7287e
	OrganizationID string `json:"organizationId,omitempty"`

	// payment scheme
	PaymentScheme *DeprecatedCreditTransferScheme `json:"paymentScheme,omitempty"`

	// payment scheme type
	PaymentSchemeType string `json:"paymentSchemeType,omitempty"`

	// reconciliation
	Reconciliation *ReconciliationDetails `json:"reconciliation,omitempty"`

	// regulatory reporting
	RegulatoryReporting []*RegulatoryReportingDetail `json:"regulatoryReporting"`

	// remittance information
	RemittanceInformation *RemittanceInformation `json:"remittanceInformation,omitempty"`

	// source account
	SourceAccount *AccountSlim `json:"sourceAccount,omitempty"`

	// status
	// Example: SENT
	// Enum: [CREATED APPROVED REJECTED PENDING_SUBMISSION SENT PENDING_AT_BANK ACCEPTED EXECUTED FAILED RECONCILED RETURNED]
	Status string `json:"status,omitempty"`

	// starts at 1 when the Credit Transfer is created and increases by one in each successive update
	// Example: 1
	Version int64 `json:"version,omitempty"`
}

Payment payment

swagger:model Payment

func (*Payment) ContextValidate

func (m *Payment) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validate this payment based on the context it is used

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 PaymentApprovalChain

type PaymentApprovalChain struct {

	// approval steps
	ApprovalSteps []*PaymentApprovalStep `json:"approvalSteps"`

	// triggered approval chain Id
	TriggeredApprovalChainID string `json:"triggeredApprovalChainId,omitempty"`
}

PaymentApprovalChain payment approval chain

swagger:model PaymentApprovalChain

func (*PaymentApprovalChain) ContextValidate

func (m *PaymentApprovalChain) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validate this payment approval chain based on the context it is used

func (*PaymentApprovalChain) MarshalBinary

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

MarshalBinary interface implementation

func (*PaymentApprovalChain) UnmarshalBinary

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

UnmarshalBinary interface implementation

func (*PaymentApprovalChain) Validate

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

Validate validates this payment approval chain

type PaymentApprovalStep

type PaymentApprovalStep struct {

	// Allow approval by the user creating this resource if if has the role required for this step. By default this is not allowed to conform with a four-eyes principle where approval by another person is required.
	AllowCreatorApproval bool `json:"allowCreatorApproval,omitempty"`

	// user id of user who approved/rejected, empty if not yet approved/rejected.
	Approver *User `json:"approver,omitempty"`

	// the id of this step, used when approving/rejecting
	// Example: 735c7b8c-ef29-456a-8caf-113be117d131
	ID string `json:"id,omitempty"`

	// the Role that is required in order to approve/reject
	RequiredRole *RoleSlim `json:"requiredRole,omitempty"`

	// the status of the approval step (PENDING, APPROVED or REJECTED). PENDING if step is not yet interacted with.
	Status string `json:"status,omitempty"`

	// timestamp when approved/rejected, zero if not yet approved/rejected.
	Updated string `json:"updated,omitempty"`
}

PaymentApprovalStep payment approval step

swagger:model PaymentApprovalStep

func (*PaymentApprovalStep) ContextValidate

func (m *PaymentApprovalStep) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validate this payment approval step based on the context it is used

func (*PaymentApprovalStep) MarshalBinary

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

MarshalBinary interface implementation

func (*PaymentApprovalStep) UnmarshalBinary

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

UnmarshalBinary interface implementation

func (*PaymentApprovalStep) Validate

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

Validate validates this payment approval step

type PaymentScheme

type PaymentScheme struct {

	// display name
	// Example: Sepa Credit Transfer
	DisplayName string `json:"displayName,omitempty"`

	// type
	// Example: SCT
	Type string `json:"type,omitempty"`
}

PaymentScheme Deprecated. Use `paymentSchemeType` instead.

swagger:model PaymentScheme

func (*PaymentScheme) ContextValidate

func (m *PaymentScheme) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validates this payment scheme based on context it is used

func (*PaymentScheme) MarshalBinary

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

MarshalBinary interface implementation

func (*PaymentScheme) UnmarshalBinary

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

UnmarshalBinary interface implementation

func (*PaymentScheme) Validate

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

Validate validates this payment scheme

type PopulateFlags

type PopulateFlags struct {

	// accounts
	Accounts bool `json:"accounts,omitempty"`

	// counterparties are required for CTs and DDs
	Counterparties bool `json:"counterparties,omitempty"`

	// credit transfers
	CreditTransfers bool `json:"creditTransfers,omitempty"`

	// direct debits
	DirectDebits bool `json:"directDebits,omitempty"`

	// expected transactions
	ExpectedTransactions bool `json:"expectedTransactions,omitempty"`

	// mandates are required for DDs
	Mandates bool `json:"mandates,omitempty"`

	// transactions
	Transactions bool `json:"transactions,omitempty"`
}

PopulateFlags populate flags

swagger:model PopulateFlags

func (*PopulateFlags) ContextValidate

func (m *PopulateFlags) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validates this populate flags based on context it is used

func (*PopulateFlags) MarshalBinary

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

MarshalBinary interface implementation

func (*PopulateFlags) UnmarshalBinary

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

UnmarshalBinary interface implementation

func (*PopulateFlags) Validate

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

Validate validates this populate flags

type ProprietaryBankTransactionCode

type ProprietaryBankTransactionCode struct {

	// code
	Code string `json:"code,omitempty"`

	// issuer
	Issuer string `json:"issuer,omitempty"`
}

ProprietaryBankTransactionCode proprietary bank transaction code

swagger:model ProprietaryBankTransactionCode

func (*ProprietaryBankTransactionCode) ContextValidate

func (m *ProprietaryBankTransactionCode) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validates this proprietary bank transaction code based on context it is used

func (*ProprietaryBankTransactionCode) MarshalBinary

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

MarshalBinary interface implementation

func (*ProprietaryBankTransactionCode) UnmarshalBinary

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

UnmarshalBinary interface implementation

func (*ProprietaryBankTransactionCode) Validate

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

Validate validates this proprietary bank transaction code

type PushCapabilities

type PushCapabilities struct {

	// direct debit schemes
	DirectDebitSchemes []string `json:"directDebitSchemes"`

	// signature schemes
	SignatureSchemes []string `json:"signatureSchemes"`

	// transfer schemes
	TransferSchemes []string `json:"transferSchemes"`
}

PushCapabilities push capabilities

swagger:model PushCapabilities

func (*PushCapabilities) ContextValidate

func (m *PushCapabilities) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validates this push capabilities based on context it is used

func (*PushCapabilities) MarshalBinary

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

MarshalBinary interface implementation

func (*PushCapabilities) UnmarshalBinary

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

UnmarshalBinary interface implementation

func (*PushCapabilities) Validate

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

Validate validates this push capabilities

type QueryResponse

type QueryResponse struct {

	// An array of the queried resource.
	// Required: true
	Items interface{} `json:"items"`

	// Same limit that was used for this request.
	// Example: 100
	Limit int64 `json:"limit,omitempty"`

	// Populated if there are more resources to be fetched.
	// Example: MjAyMi0wM3xleUprWVhSbElqb2lNakF5TW...
	NextToken string `json:"nextToken,omitempty"`

	// Same token that was used for this request.
	// Example: MjpMHdNeUlzSW5Cbwd00zd3hNMlF6TURBNU...
	Token string `json:"token,omitempty"`
}

QueryResponse query response

swagger:model QueryResponse

func (*QueryResponse) ContextValidate

func (m *QueryResponse) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validates this query response based on context it is used

func (*QueryResponse) MarshalBinary

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

MarshalBinary interface implementation

func (*QueryResponse) UnmarshalBinary

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

UnmarshalBinary interface implementation

func (*QueryResponse) Validate

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

Validate validates this query response

type ReconcileExpectedTransactionRequest

type ReconcileExpectedTransactionRequest struct {

	// The id of the transaction which the expected transaction should be reconciled against.
	// Example: e37235aa-adab-11ec-8029-96ac651c9332
	// Required: true
	TransactionID *string `json:"transactionId"`
}

ReconcileExpectedTransactionRequest reconcile expected transaction request

swagger:model ReconcileExpectedTransactionRequest

func (*ReconcileExpectedTransactionRequest) ContextValidate

func (m *ReconcileExpectedTransactionRequest) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validates this reconcile expected transaction request based on context it is used

func (*ReconcileExpectedTransactionRequest) MarshalBinary

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

MarshalBinary interface implementation

func (*ReconcileExpectedTransactionRequest) UnmarshalBinary

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

UnmarshalBinary interface implementation

func (*ReconcileExpectedTransactionRequest) Validate

Validate validates this reconcile expected transaction request

type ReconciliationDetails

type ReconciliationDetails struct {

	// Populated if transactable is reconciled with a booked transaction. This field is also populated on booked transactions themselves (no matter if they are reconciled or not) and will always be the same id as the transaction's own id.
	// Example: e37235aa-adab-11ec-8029-96ac651c9332
	BookedTransactionID string `json:"bookedTransactionId,omitempty"`

	// Populated if booked transaction is reconciled with an underlying transactable. This field is also populated on expected transactions themselves (no matter if they are reconciled or not) and will always be the same id as the expected transaction's own id.
	// Example: a18ef4e2-bd24-42cc-af52-6ed3b93cdb45
	ExpectedTransactionID string `json:"expectedTransactionId,omitempty"`

	// The reconciliation status. Booked transactions can either be BOOKED (ie. not reconciled), or RECONCILED, while Expected Transactions or Payments can either be EXPECTED or RECONCILED.
	// Example: RECONCILED
	// Enum: [BOOKED EXPECTED RECONCILED]
	Status string `json:"status,omitempty"`

	// The id of the underlying transactable. Only populated for booked transactions if they are reconciled. For Payments and Expected Transactions, the transactableId will be the object's own id.
	// Example: 1d1a4c84-adac-11ec-b909-0242ac120002
	TransactableID string `json:"transactableId,omitempty"`

	// The type of the Transactable. This helps a client to know from where to fetch the transactable id (e.g. from payments endpoint or expected-transactions)
	// Example: PAYMENT
	// Enum: [PAYMENT EXPECTED_TRANSACTION]
	TransactableType string `json:"transactableType,omitempty"`
}

ReconciliationDetails The ReconciliationDetails object is attached to Transactions, Expected-Transactions and Payments. The data on the reconciliation object, will be identical on reconciled (paired) booked transactions and their underlying transactable (e.g. Payment or Expected-Transaction).

swagger:model ReconciliationDetails

func (*ReconciliationDetails) ContextValidate

func (m *ReconciliationDetails) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validates this reconciliation details based on context it is used

func (*ReconciliationDetails) MarshalBinary

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

MarshalBinary interface implementation

func (*ReconciliationDetails) UnmarshalBinary

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

UnmarshalBinary interface implementation

func (*ReconciliationDetails) Validate

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

Validate validates this reconciliation details

type RegulatoryReportingDetail added in v1.2.0

type RegulatoryReportingDetail struct {

	// Code specifies the nature, purpose and reason for the transaction.
	Code string `json:"code,omitempty"`

	// Indicator indentifies wether the regulatory reporting information applies to the debit/credit side or both.
	// Example: CREDITOR
	// Enum: [DEBTOR CREDITOR BOTH]
	Indicator string `json:"indicator,omitempty"`

	// Market is the ISO 3166-1 alpha-2 country code of the entity requiring the details.
	Market string `json:"market,omitempty"`
}

RegulatoryReportingDetail RegulatoryReporting is an optional field that can be set when additional information is needed due to regulatory and statutory requirements.

swagger:model RegulatoryReportingDetail

func (*RegulatoryReportingDetail) ContextValidate added in v1.2.0

func (m *RegulatoryReportingDetail) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validates this regulatory reporting detail based on context it is used

func (*RegulatoryReportingDetail) MarshalBinary added in v1.2.0

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

MarshalBinary interface implementation

func (*RegulatoryReportingDetail) UnmarshalBinary added in v1.2.0

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

UnmarshalBinary interface implementation

func (*RegulatoryReportingDetail) Validate added in v1.2.0

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

Validate validates this regulatory reporting detail

type RemittanceInformation

type RemittanceInformation struct {

	// The type of remittance information
	// Example: UNSTRUCTURED
	// Required: true
	// Enum: [OCR UNSTRUCTURED STRUCTURED]
	Type *string `json:"type"`

	// The remittance information to be sent to the destination bank and recipient. Maximum length is 140 characters.
	// Example: invoice-2022-05-03-0124
	// Required: true
	Value *string `json:"value"`
}

RemittanceInformation remittance information

swagger:model RemittanceInformation

func (*RemittanceInformation) ContextValidate

func (m *RemittanceInformation) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validates this remittance information based on context it is used

func (*RemittanceInformation) MarshalBinary

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

MarshalBinary interface implementation

func (*RemittanceInformation) UnmarshalBinary

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

UnmarshalBinary interface implementation

func (*RemittanceInformation) Validate

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

Validate validates this remittance information

type ReturnReason

type ReturnReason struct {

	// code
	Code string `json:"code,omitempty"`

	// description
	Description string `json:"description,omitempty"`

	// original bank transaction code
	OriginalBankTransactionCode *BankTransactionCode `json:"originalBankTransactionCode,omitempty"`
}

ReturnReason return reason

swagger:model ReturnReason

func (*ReturnReason) ContextValidate

func (m *ReturnReason) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validate this return reason based on the context it is used

func (*ReturnReason) MarshalBinary

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

MarshalBinary interface implementation

func (*ReturnReason) UnmarshalBinary

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

UnmarshalBinary interface implementation

func (*ReturnReason) Validate

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

Validate validates this return reason

type Role

type Role struct {

	// Created timestamp
	Created string `json:"created,omitempty"`

	// id
	// Example: 54c71c82-82f0-439c-996f-c8bd62c3fe0a
	ID string `json:"id,omitempty"`

	// name
	// Example: FINANCE
	Name string `json:"name,omitempty"`

	// organization Id
	// Example: 605e26fc-4fce-495a-a92f-2c3592d7287e
	OrganizationID string `json:"organizationId,omitempty"`

	// owner
	// Example: false
	Owner bool `json:"owner,omitempty"`

	// comma-separated scopes (which is on form resource:method)
	// Example: accounts:read,payments:create
	Scopes string `json:"scopes,omitempty"`

	// type
	// Example: REGULAR_ROLE
	// Enum: [SERVICE_ROLE OPERATOR_ROLE REGULAR_ROLE]
	Type string `json:"type,omitempty"`

	// Updated timestamp
	Updated string `json:"updated,omitempty"`
}

Role role

swagger:model Role

func (*Role) ContextValidate

func (m *Role) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validates this role based on context it is used

func (*Role) MarshalBinary

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

MarshalBinary interface implementation

func (*Role) UnmarshalBinary

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

UnmarshalBinary interface implementation

func (*Role) Validate

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

Validate validates this role

type RoleSlim

type RoleSlim struct {

	// id
	// Example: 54c71c82-82f0-439c-996f-c8bd62c3fe0a
	ID string `json:"id,omitempty"`

	// name
	// Example: FINANCE
	Name string `json:"name,omitempty"`

	// owner
	// Example: false
	Owner bool `json:"owner,omitempty"`
}

RoleSlim role slim

swagger:model RoleSlim

func (*RoleSlim) ContextValidate

func (m *RoleSlim) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validates this role slim based on context it is used

func (*RoleSlim) MarshalBinary

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

MarshalBinary interface implementation

func (*RoleSlim) UnmarshalBinary

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

UnmarshalBinary interface implementation

func (*RoleSlim) Validate

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

Validate validates this role slim

type SchemesSignatureScheme

type SchemesSignatureScheme struct {

	// type
	// Example: EBICS_VEU
	Type string `json:"type,omitempty"`
}

SchemesSignatureScheme schemes signature scheme

swagger:model schemes.SignatureScheme

func (*SchemesSignatureScheme) ContextValidate

func (m *SchemesSignatureScheme) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validates this schemes signature scheme based on context it is used

func (*SchemesSignatureScheme) MarshalBinary

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

MarshalBinary interface implementation

func (*SchemesSignatureScheme) UnmarshalBinary

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

UnmarshalBinary interface implementation

func (*SchemesSignatureScheme) Validate

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

Validate validates this schemes signature scheme

type SecretDefinition

type SecretDefinition struct {

	// display name
	DisplayName string `json:"displayName,omitempty"`

	// generatable
	Generatable bool `json:"generatable,omitempty"`

	// help text
	HelpText string `json:"helpText,omitempty"`

	// a managed secret is only creatable with non-public scope connection_managed_secrets:create,
	// these secrets are not indicated by the public /v1/banks list, but once a managed
	// secret is set on a connection, queriers will get the secret
	Managed bool `json:"managed,omitempty"`

	// max length
	MaxLength int64 `json:"maxLength,omitempty"`

	// min length
	MinLength int64 `json:"minLength,omitempty"`

	// pattern
	Pattern string `json:"pattern,omitempty"`

	// type
	Type string `json:"type,omitempty"`
}

SecretDefinition secret definition

swagger:model SecretDefinition

func (*SecretDefinition) ContextValidate

func (m *SecretDefinition) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validates this secret definition based on context it is used

func (*SecretDefinition) MarshalBinary

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

MarshalBinary interface implementation

func (*SecretDefinition) UnmarshalBinary

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

UnmarshalBinary interface implementation

func (*SecretDefinition) Validate

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

Validate validates this secret definition

type SlimAffiliation

type SlimAffiliation struct {

	// id
	ID string `json:"id,omitempty"`

	// name
	Name string `json:"name,omitempty"`

	// third party Id
	ThirdPartyID string `json:"thirdPartyId,omitempty"`
}

SlimAffiliation slim affiliation

swagger:model SlimAffiliation

func (*SlimAffiliation) ContextValidate

func (m *SlimAffiliation) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validates this slim affiliation based on context it is used

func (*SlimAffiliation) MarshalBinary

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

MarshalBinary interface implementation

func (*SlimAffiliation) UnmarshalBinary

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

UnmarshalBinary interface implementation

func (*SlimAffiliation) Validate

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

Validate validates this slim affiliation

type SlimConnectionType

type SlimConnectionType struct {

	// capabilities
	Capabilities *ConnectionCapabilities `json:"capabilities,omitempty"`

	// id
	ID string `json:"id,omitempty"`

	// name
	Name string `json:"name,omitempty"`

	// type
	Type string `json:"type,omitempty"`
}

SlimConnectionType slim connection type

swagger:model SlimConnectionType

func (*SlimConnectionType) ContextValidate

func (m *SlimConnectionType) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validate this slim connection type based on the context it is used

func (*SlimConnectionType) MarshalBinary

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

MarshalBinary interface implementation

func (*SlimConnectionType) UnmarshalBinary

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

UnmarshalBinary interface implementation

func (*SlimConnectionType) Validate

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

Validate validates this slim connection type

type TestbankAccountIdentifier added in v1.3.0

type TestbankAccountIdentifier struct {

	// number
	Number string `json:"number,omitempty"`

	// type
	Type string `json:"type,omitempty"`
}

TestbankAccountIdentifier testbank account identifier

swagger:model testbank.AccountIdentifier

func (*TestbankAccountIdentifier) ContextValidate added in v1.3.0

func (m *TestbankAccountIdentifier) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validates this testbank account identifier based on context it is used

func (*TestbankAccountIdentifier) MarshalBinary added in v1.3.0

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

MarshalBinary interface implementation

func (*TestbankAccountIdentifier) UnmarshalBinary added in v1.3.0

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

UnmarshalBinary interface implementation

func (*TestbankAccountIdentifier) Validate added in v1.3.0

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

Validate validates this testbank account identifier

type TestbankAddress added in v1.3.0

type TestbankAddress struct {

	// city
	City string `json:"city,omitempty"`

	// ISO 3166-1 alpha-2 country code. Examples: DE, DK, SE
	Country string `json:"country,omitempty"`

	// postal code
	PostalCode string `json:"postalCode,omitempty"`

	// International unstructured address lines, as they might appear on a mailing label, are presented in their raw, unformatted form. This array is populated with raw address lines only when Atlar receives such information from the bank. While the bank might not always provide these lines, when available, they will appear here in their unaltered state.
	RawAddressLines []string `json:"rawAddressLines"`

	// street name
	StreetName string `json:"streetName,omitempty"`

	// street number
	StreetNumber string `json:"streetNumber,omitempty"`
}

TestbankAddress testbank address

swagger:model testbank.Address

func (*TestbankAddress) ContextValidate added in v1.3.0

func (m *TestbankAddress) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validates this testbank address based on context it is used

func (*TestbankAddress) MarshalBinary added in v1.3.0

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

MarshalBinary interface implementation

func (*TestbankAddress) UnmarshalBinary added in v1.3.0

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

UnmarshalBinary interface implementation

func (*TestbankAddress) Validate added in v1.3.0

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

Validate validates this testbank address

type TestbankAmount

type TestbankAmount struct {

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

	// value
	Value int64 `json:"value,omitempty"`
}

TestbankAmount testbank amount

swagger:model testbank.Amount

func (*TestbankAmount) ContextValidate

func (m *TestbankAmount) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validates this testbank amount based on context it is used

func (*TestbankAmount) MarshalBinary

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

MarshalBinary interface implementation

func (*TestbankAmount) UnmarshalBinary

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

UnmarshalBinary interface implementation

func (*TestbankAmount) Validate

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

Validate validates this testbank amount

type TestbankBankSlim added in v1.3.0

type TestbankBankSlim struct {

	// The BIC code of the bank for the account. Always formatted as 11 characters, if your BIC is only 8 chars, add "XXX" as the last 3 characters.
	Bic string `json:"bic,omitempty"`

	// id
	ID string `json:"id,omitempty"`

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

TestbankBankSlim testbank bank slim

swagger:model testbank.BankSlim

func (*TestbankBankSlim) ContextValidate added in v1.3.0

func (m *TestbankBankSlim) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validates this testbank bank slim based on context it is used

func (*TestbankBankSlim) MarshalBinary added in v1.3.0

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

MarshalBinary interface implementation

func (*TestbankBankSlim) UnmarshalBinary added in v1.3.0

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

UnmarshalBinary interface implementation

func (*TestbankBankSlim) Validate added in v1.3.0

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

Validate validates this testbank bank slim

type TestbankBankTransactionCode

type TestbankBankTransactionCode struct {

	// domain
	Domain string `json:"domain,omitempty"`

	// family
	Family string `json:"family,omitempty"`

	// subfamily
	Subfamily string `json:"subfamily,omitempty"`
}

TestbankBankTransactionCode testbank bank transaction code

swagger:model testbank.BankTransactionCode

func (*TestbankBankTransactionCode) ContextValidate

func (m *TestbankBankTransactionCode) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validates this testbank bank transaction code based on context it is used

func (*TestbankBankTransactionCode) MarshalBinary

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

MarshalBinary interface implementation

func (*TestbankBankTransactionCode) UnmarshalBinary

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

UnmarshalBinary interface implementation

func (*TestbankBankTransactionCode) Validate

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

Validate validates this testbank bank transaction code

type TestbankContactDetails added in v1.3.0

type TestbankContactDetails struct {

	// Address details for the counterparty.
	Address *TestbankAddress `json:"address,omitempty"`

	// Email of the counterparty
	Email string `json:"email,omitempty"`

	// Phone number of the counterparty
	Phone string `json:"phone,omitempty"`
}

TestbankContactDetails testbank contact details

swagger:model testbank.ContactDetails

func (*TestbankContactDetails) ContextValidate added in v1.3.0

func (m *TestbankContactDetails) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validate this testbank contact details based on the context it is used

func (*TestbankContactDetails) MarshalBinary added in v1.3.0

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

MarshalBinary interface implementation

func (*TestbankContactDetails) UnmarshalBinary added in v1.3.0

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

UnmarshalBinary interface implementation

func (*TestbankContactDetails) Validate added in v1.3.0

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

Validate validates this testbank contact details

type TestbankCurrencyExchange

type TestbankCurrencyExchange struct {

	// exchange rate
	ExchangeRate string `json:"exchangeRate,omitempty"`
}

TestbankCurrencyExchange testbank currency exchange

swagger:model testbank.CurrencyExchange

func (*TestbankCurrencyExchange) ContextValidate

func (m *TestbankCurrencyExchange) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validates this testbank currency exchange based on context it is used

func (*TestbankCurrencyExchange) MarshalBinary

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

MarshalBinary interface implementation

func (*TestbankCurrencyExchange) UnmarshalBinary

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

UnmarshalBinary interface implementation

func (*TestbankCurrencyExchange) Validate

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

Validate validates this testbank currency exchange

type TestbankNationalIdentifier added in v1.3.0

type TestbankNationalIdentifier struct {

	// ISO3166 Alpha2 country code
	Market string `json:"market,omitempty"`

	// The identifier itself.
	Number string `json:"number,omitempty"`

	// Type of the national identifier.
	Type string `json:"type,omitempty"`
}

TestbankNationalIdentifier testbank national identifier

swagger:model testbank.NationalIdentifier

func (*TestbankNationalIdentifier) ContextValidate added in v1.3.0

func (m *TestbankNationalIdentifier) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validates this testbank national identifier based on context it is used

func (*TestbankNationalIdentifier) MarshalBinary added in v1.3.0

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

MarshalBinary interface implementation

func (*TestbankNationalIdentifier) UnmarshalBinary added in v1.3.0

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

UnmarshalBinary interface implementation

func (*TestbankNationalIdentifier) Validate added in v1.3.0

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

Validate validates this testbank national identifier

type TestbankReturnReason

type TestbankReturnReason struct {

	// code
	Code string `json:"code,omitempty"`
}

TestbankReturnReason testbank return reason

swagger:model testbank.ReturnReason

func (*TestbankReturnReason) ContextValidate

func (m *TestbankReturnReason) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validates this testbank return reason based on context it is used

func (*TestbankReturnReason) MarshalBinary

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

MarshalBinary interface implementation

func (*TestbankReturnReason) UnmarshalBinary

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

UnmarshalBinary interface implementation

func (*TestbankReturnReason) Validate

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

Validate validates this testbank return reason

type TestbankTransactionCharacteristics

type TestbankTransactionCharacteristics struct {

	// ISO20022 Bank Transaction Codes
	BankTransactionCode *TestbankBankTransactionCode `json:"bankTransactionCode,omitempty"`

	// currency exchange
	CurrencyExchange *TestbankCurrencyExchange `json:"currencyExchange,omitempty"`

	// instructed amount
	InstructedAmount *TestbankAmount `json:"instructedAmount,omitempty"`

	// ISO20022 Return Reasons
	ReturnReason *TestbankReturnReason `json:"returnReason,omitempty"`

	// virtual account
	VirtualAccount *TestbankTransactionVirtualAccount `json:"virtualAccount,omitempty"`
}

TestbankTransactionCharacteristics testbank transaction characteristics

swagger:model testbank.TransactionCharacteristics

func (*TestbankTransactionCharacteristics) ContextValidate

func (m *TestbankTransactionCharacteristics) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validate this testbank transaction characteristics based on the context it is used

func (*TestbankTransactionCharacteristics) MarshalBinary

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

MarshalBinary interface implementation

func (*TestbankTransactionCharacteristics) UnmarshalBinary

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

UnmarshalBinary interface implementation

func (*TestbankTransactionCharacteristics) Validate

Validate validates this testbank transaction characteristics

type TestbankTransactionCounterpartyDetails added in v1.3.0

type TestbankTransactionCounterpartyDetails struct {

	// contact details
	ContactDetails *TestbankContactDetails `json:"contactDetails,omitempty"`

	// external account
	ExternalAccount *TestbankTransactionExternalAccount `json:"externalAccount,omitempty"`

	// populated if Mandate reference was given on the transaction by the bank. Typically, if a transaction stems from a DirectDebit payment, the mandate reference that was used to pull the funds will be given
	MandateReference string `json:"mandateReference,omitempty"`

	// Name of the Counterparty
	Name string `json:"name,omitempty"`

	// national identifier
	NationalIdentifier *TestbankNationalIdentifier `json:"nationalIdentifier,omitempty"`

	// The legal type of the Counterparty
	PartyType string `json:"partyType,omitempty"`
}

TestbankTransactionCounterpartyDetails testbank transaction counterparty details

swagger:model testbank.TransactionCounterpartyDetails

func (*TestbankTransactionCounterpartyDetails) ContextValidate added in v1.3.0

ContextValidate validate this testbank transaction counterparty details based on the context it is used

func (*TestbankTransactionCounterpartyDetails) MarshalBinary added in v1.3.0

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

MarshalBinary interface implementation

func (*TestbankTransactionCounterpartyDetails) UnmarshalBinary added in v1.3.0

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

UnmarshalBinary interface implementation

func (*TestbankTransactionCounterpartyDetails) Validate added in v1.3.0

Validate validates this testbank transaction counterparty details

type TestbankTransactionExternalAccount added in v1.3.0

type TestbankTransactionExternalAccount struct {

	// bank
	Bank *TestbankBankSlim `json:"bank,omitempty"`

	// identifier
	Identifier *TestbankAccountIdentifier `json:"identifier,omitempty"`

	// market
	Market string `json:"market,omitempty"`

	// raw identifier
	RawIdentifier string `json:"rawIdentifier,omitempty"`
}

TestbankTransactionExternalAccount testbank transaction external account

swagger:model testbank.TransactionExternalAccount

func (*TestbankTransactionExternalAccount) ContextValidate added in v1.3.0

func (m *TestbankTransactionExternalAccount) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validate this testbank transaction external account based on the context it is used

func (*TestbankTransactionExternalAccount) MarshalBinary added in v1.3.0

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

MarshalBinary interface implementation

func (*TestbankTransactionExternalAccount) UnmarshalBinary added in v1.3.0

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

UnmarshalBinary interface implementation

func (*TestbankTransactionExternalAccount) Validate added in v1.3.0

Validate validates this testbank transaction external account

type TestbankTransactionVirtualAccount added in v1.3.0

type TestbankTransactionVirtualAccount struct {

	// bank
	Bank *TestbankBankSlim `json:"bank,omitempty"`

	// identifier
	Identifier *TestbankAccountIdentifier `json:"identifier,omitempty"`

	// market
	Market string `json:"market,omitempty"`

	// raw identifier
	RawIdentifier string `json:"rawIdentifier,omitempty"`
}

TestbankTransactionVirtualAccount testbank transaction virtual account

swagger:model testbank.TransactionVirtualAccount

func (*TestbankTransactionVirtualAccount) ContextValidate added in v1.3.0

func (m *TestbankTransactionVirtualAccount) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validate this testbank transaction virtual account based on the context it is used

func (*TestbankTransactionVirtualAccount) MarshalBinary added in v1.3.0

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

MarshalBinary interface implementation

func (*TestbankTransactionVirtualAccount) UnmarshalBinary added in v1.3.0

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

UnmarshalBinary interface implementation

func (*TestbankTransactionVirtualAccount) Validate added in v1.3.0

Validate validates this testbank transaction virtual account

type ThirdParty

type ThirdParty struct {

	// icon Url
	// Example: https://cdn.atlar.com/icons/esse.png
	IconURL string `json:"iconUrl,omitempty"`

	// id
	// Example: 5013c38e-8e01-4ad3-aff6-a57d51ec2158
	ID string `json:"id,omitempty"`

	// name
	// Example: SEB
	Name string `json:"name,omitempty"`

	// type
	// Example: BANK
	Type string `json:"type,omitempty"`

	// the vendorId is an identifier for the thirdparty that is known outside of the Atlar platform. For BANKs, the vendorId is the first four characters of the BIC
	// Example: ESSE
	VendorID string `json:"vendorId,omitempty"`
}

ThirdParty third party

swagger:model ThirdParty

func (*ThirdParty) ContextValidate

func (m *ThirdParty) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validates this third party based on context it is used

func (*ThirdParty) MarshalBinary

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

MarshalBinary interface implementation

func (*ThirdParty) UnmarshalBinary

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

UnmarshalBinary interface implementation

func (*ThirdParty) Validate

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

Validate validates this third party

type Transaction

type Transaction struct {

	// account
	Account *AccountTrx `json:"account,omitempty"`

	// amount
	Amount *Amount `json:"amount,omitempty"`

	// only populated for booked
	Characteristics *TransactionCharacteristics `json:"characteristics,omitempty"`

	// Deprecated. Use CounterpartyDetails instead.
	Counterparty *CounterpartySlim `json:"counterparty,omitempty"`

	// counterparty details
	CounterpartyDetails *TransactionCounterpartyDetails `json:"counterpartyDetails,omitempty"`

	// created
	Created string `json:"created,omitempty"`

	// Booking date of the transaction on your account. Format as `yyyy-mm-dd`, local date with no timezone from your account's point-of-view.
	// Example: 2022-05-01
	Date string `json:"date,omitempty"`

	// The Description field will in most cases hold the same value (text) as remittance information. In case the
	// remittance information is not meaningful, the description may be derived from the bank transaction code. This
	// Description field should only be used for purposes of displaying a meaningful description to humans.
	Description string `json:"description,omitempty"`

	// id
	// Example: e37235aa-adab-11ec-8029-96ac651c9332
	ID string `json:"id,omitempty"`

	// organization Id
	// Example: 605e26fc-4fce-495a-a92f-2c3592d7287e
	OrganizationID string `json:"organizationId,omitempty"`

	// reconciliation
	Reconciliation *ReconciliationDetails `json:"reconciliation,omitempty"`

	// remittance information
	RemittanceInformation *RemittanceInformation `json:"remittanceInformation,omitempty"`

	// Value date of the transaction on your account. Format as `yyyy-mm-dd`, local date with no timezone from your account's point-of-view.
	// Example: 2022-05-01
	ValueDate string `json:"valueDate,omitempty"`

	// version
	Version int64 `json:"version,omitempty"`
}

Transaction transaction

swagger:model Transaction

func (*Transaction) ContextValidate

func (m *Transaction) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validate this transaction based on the context it is used

func (*Transaction) MarshalBinary

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

MarshalBinary interface implementation

func (*Transaction) UnmarshalBinary

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

UnmarshalBinary interface implementation

func (*Transaction) Validate

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

Validate validates this transaction

type TransactionCharacteristics

type TransactionCharacteristics struct {

	// ISO 20022 Bank Transaction Code.
	BankTransactionCode *BankTransactionCode `json:"bankTransactionCode,omitempty"`

	// Optional. If any currency conversion happened at the bank holding the account, conversion details may be present here.
	CurrencyExchange *CurrencyExchange `json:"currencyExchange,omitempty"`

	// The amount that the initiator of the transaction instructed.
	InstructedAmount *Amount `json:"instructedAmount,omitempty"`

	// ISO 20022 Return Reason.
	ReturnReason *ReturnReason `json:"returnReason,omitempty"`

	// Whether or not the transaction is considered a return or reversal.
	Returned bool `json:"returned,omitempty"`

	// Optional. If virtual account details are provided by the bank they will be present here.
	VirtualAccount *TransactionVirtualAccount `json:"virtualAccount,omitempty"`
}

TransactionCharacteristics transaction characteristics

swagger:model TransactionCharacteristics

func (*TransactionCharacteristics) ContextValidate

func (m *TransactionCharacteristics) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validate this transaction characteristics based on the context it is used

func (*TransactionCharacteristics) MarshalBinary

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

MarshalBinary interface implementation

func (*TransactionCharacteristics) UnmarshalBinary

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

UnmarshalBinary interface implementation

func (*TransactionCharacteristics) Validate

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

Validate validates this transaction characteristics

type TransactionCounterpartyDetails

type TransactionCounterpartyDetails struct {

	// contact details
	ContactDetails *ContactDetails `json:"contactDetails,omitempty"`

	// external account
	ExternalAccount *TransactionExternalAccount `json:"externalAccount,omitempty"`

	// populated if Mandate reference was given on the transaction by the bank. Typically, if a transaction stems from a DirectDebit payment, the mandate reference that was used to pull the funds will be given
	// Example: 123456
	MandateReference string `json:"mandateReference,omitempty"`

	// Name of the Counterparty
	// Example: Customer #312
	Name string `json:"name,omitempty"`

	// national identifier
	NationalIdentifier *NationalIdentifier `json:"nationalIdentifier,omitempty"`

	// The legal type of the Counterparty
	// Example: INDIVIDUAL
	// Enum: [INDIVIDUAL COMPANY]
	PartyType string `json:"partyType,omitempty"`
}

TransactionCounterpartyDetails transaction counterparty details

swagger:model TransactionCounterpartyDetails

func (*TransactionCounterpartyDetails) ContextValidate

func (m *TransactionCounterpartyDetails) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validate this transaction counterparty details based on the context it is used

func (*TransactionCounterpartyDetails) MarshalBinary

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

MarshalBinary interface implementation

func (*TransactionCounterpartyDetails) UnmarshalBinary

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

UnmarshalBinary interface implementation

func (*TransactionCounterpartyDetails) Validate

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

Validate validates this transaction counterparty details

type TransactionExternalAccount

type TransactionExternalAccount struct {

	// bank
	Bank *BankSlim `json:"bank,omitempty"`

	// identifier
	Identifier *AccountIdentifierSlim `json:"identifier,omitempty"`

	// market
	Market string `json:"market,omitempty"`

	// raw identifier
	RawIdentifier string `json:"rawIdentifier,omitempty"`
}

TransactionExternalAccount transaction external account

swagger:model TransactionExternalAccount

func (*TransactionExternalAccount) ContextValidate

func (m *TransactionExternalAccount) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validate this transaction external account based on the context it is used

func (*TransactionExternalAccount) MarshalBinary

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

MarshalBinary interface implementation

func (*TransactionExternalAccount) UnmarshalBinary

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

UnmarshalBinary interface implementation

func (*TransactionExternalAccount) Validate

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

Validate validates this transaction external account

type TransactionVirtualAccount added in v1.2.0

type TransactionVirtualAccount struct {

	// bank
	Bank *BankSlim `json:"bank,omitempty"`

	// identifier
	Identifier *AccountIdentifierSlim `json:"identifier,omitempty"`

	// market
	Market string `json:"market,omitempty"`

	// raw identifier
	RawIdentifier string `json:"rawIdentifier,omitempty"`
}

TransactionVirtualAccount transaction virtual account

swagger:model TransactionVirtualAccount

func (*TransactionVirtualAccount) ContextValidate added in v1.2.0

func (m *TransactionVirtualAccount) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validate this transaction virtual account based on the context it is used

func (*TransactionVirtualAccount) MarshalBinary added in v1.2.0

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

MarshalBinary interface implementation

func (*TransactionVirtualAccount) UnmarshalBinary added in v1.2.0

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

UnmarshalBinary interface implementation

func (*TransactionVirtualAccount) Validate added in v1.2.0

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

Validate validates this transaction virtual account

type TransferScheme

type TransferScheme struct {

	// counterparty identifiers
	CounterpartyIdentifiers []*CounterpartyIdentifier `json:"counterpartyIdentifiers"`

	// currencies
	// Example: ["SEK","DKK"]
	Currencies []string `json:"currencies"`

	// Deprecated
	// Example: EUR
	Currency string `json:"currency,omitempty"`

	// markets
	// Example: ["SE","DE","FI","NO"]
	Markets []string `json:"markets"`

	// type
	// Example: SCT
	Type string `json:"type,omitempty"`
}

TransferScheme transfer scheme

swagger:model TransferScheme

func (*TransferScheme) ContextValidate

func (m *TransferScheme) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validate this transfer scheme based on the context it is used

func (*TransferScheme) MarshalBinary

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

MarshalBinary interface implementation

func (*TransferScheme) UnmarshalBinary

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

UnmarshalBinary interface implementation

func (*TransferScheme) Validate

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

Validate validates this transfer scheme

type TriggerCondition

type TriggerCondition struct {

	// Payments with an amount value less than this value will trigger the chain.
	AmountLt *Amount `json:"amountLt,omitempty"`

	// Payments created by this (optional) role ID will trigger the chain.
	CreatorRoleID string `json:"creatorRoleId,omitempty"`
}

TriggerCondition trigger condition

swagger:model TriggerCondition

func (*TriggerCondition) ContextValidate

func (m *TriggerCondition) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validate this trigger condition based on the context it is used

func (*TriggerCondition) MarshalBinary

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

MarshalBinary interface implementation

func (*TriggerCondition) UnmarshalBinary

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

UnmarshalBinary interface implementation

func (*TriggerCondition) Validate

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

Validate validates this trigger condition

type TriggerConditionInput

type TriggerConditionInput struct {

	// Payments with an amount value less than this value will trigger the chain.
	// Required: true
	AmountLt *AmountInput `json:"amountLt"`

	// Payments created by this (optional) role ID will trigger the chain.
	CreatorRoleID string `json:"creatorRoleId,omitempty"`
}

TriggerConditionInput trigger condition input

swagger:model TriggerConditionInput

func (*TriggerConditionInput) ContextValidate

func (m *TriggerConditionInput) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validate this trigger condition input based on the context it is used

func (*TriggerConditionInput) MarshalBinary

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

MarshalBinary interface implementation

func (*TriggerConditionInput) UnmarshalBinary

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

UnmarshalBinary interface implementation

func (*TriggerConditionInput) Validate

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

Validate validates this trigger condition input

type UnreconcileExpectedTransactionRequest

type UnreconcileExpectedTransactionRequest struct {

	// The id of the transaction which the expected transaction is to be unreconciled against.
	// Example: e37235aa-adab-11ec-8029-96ac651c9332
	// Required: true
	TransactionID *string `json:"transactionId"`
}

UnreconcileExpectedTransactionRequest unreconcile expected transaction request

swagger:model UnreconcileExpectedTransactionRequest

func (*UnreconcileExpectedTransactionRequest) ContextValidate

func (m *UnreconcileExpectedTransactionRequest) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validates this unreconcile expected transaction request based on context it is used

func (*UnreconcileExpectedTransactionRequest) MarshalBinary

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

MarshalBinary interface implementation

func (*UnreconcileExpectedTransactionRequest) UnmarshalBinary

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

UnmarshalBinary interface implementation

func (*UnreconcileExpectedTransactionRequest) Validate

Validate validates this unreconcile expected transaction request

type UpdatableBank

type UpdatableBank struct {

	// The BIC code of the bank for the account. Always formatted as 11 characters, if your BIC is only 8 chars, add "XXX" as the last 3 characters.
	// Example: VGAGDEHHXXX
	Bic string `json:"bic,omitempty"`
}

UpdatableBank updatable bank

swagger:model UpdatableBank

func (*UpdatableBank) ContextValidate

func (m *UpdatableBank) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validates this updatable bank based on context it is used

func (*UpdatableBank) MarshalBinary

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

MarshalBinary interface implementation

func (*UpdatableBank) UnmarshalBinary

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

UnmarshalBinary interface implementation

func (*UpdatableBank) Validate

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

Validate validates this updatable bank

type UpdateAccountRequest

type UpdateAccountRequest struct {

	// alias
	Alias string `json:"alias,omitempty"`

	// external metadata
	ExternalMetadata ExternalMetadata `json:"externalMetadata,omitempty"`
}

UpdateAccountRequest update account request

swagger:model UpdateAccountRequest

func (*UpdateAccountRequest) ContextValidate

func (m *UpdateAccountRequest) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validate this update account request based on the context it is used

func (*UpdateAccountRequest) MarshalBinary

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

MarshalBinary interface implementation

func (*UpdateAccountRequest) UnmarshalBinary

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

UnmarshalBinary interface implementation

func (*UpdateAccountRequest) Validate

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

Validate validates this update account request

type UpdateCounterpartyRequest

type UpdateCounterpartyRequest struct {

	// contact details
	ContactDetails *ContactDetails `json:"contactDetails,omitempty"`

	// external metadata
	ExternalMetadata ExternalMetadata `json:"externalMetadata,omitempty"`

	// name
	// Example: Customer #312
	// Required: true
	Name *string `json:"name"`

	// The legal type of the Counterparty
	// Example: INDIVIDUAL
	// Enum: [INDIVIDUAL COMPANY]
	PartyType string `json:"partyType,omitempty"`
}

UpdateCounterpartyRequest update counterparty request

swagger:model UpdateCounterpartyRequest

func (*UpdateCounterpartyRequest) ContextValidate

func (m *UpdateCounterpartyRequest) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validate this update counterparty request based on the context it is used

func (*UpdateCounterpartyRequest) MarshalBinary

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

MarshalBinary interface implementation

func (*UpdateCounterpartyRequest) UnmarshalBinary

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

UnmarshalBinary interface implementation

func (*UpdateCounterpartyRequest) Validate

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

Validate validates this update counterparty request

type UpdateExternalAccountRequest

type UpdateExternalAccountRequest struct {

	// The Bank
	Bank *UpdatableBank `json:"bank,omitempty"`

	// A list of account identifiers with account numbers that identify this account. A single account identifier can be enough, but some countries use multiple. For example, an account can be described both with an IBAN and one or more local formats.
	Identifiers []*AccountIdentifier `json:"identifiers"`
}

UpdateExternalAccountRequest update external account request

swagger:model UpdateExternalAccountRequest

func (*UpdateExternalAccountRequest) ContextValidate

func (m *UpdateExternalAccountRequest) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validate this update external account request based on the context it is used

func (*UpdateExternalAccountRequest) MarshalBinary

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

MarshalBinary interface implementation

func (*UpdateExternalAccountRequest) UnmarshalBinary

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

UnmarshalBinary interface implementation

func (*UpdateExternalAccountRequest) Validate

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

Validate validates this update external account request

type UpdateWebhookRequest

type UpdateWebhookRequest struct {

	// An inclusive filter to specify which resources and events that you are interested in.
	// Required: true
	Filter []*WebhookFilter `json:"filter"`

	// The unique identifier of the webhook to update.
	// Example: be7e04fe-3fa0-48f5-a993-2008409255f2
	ID string `json:"id,omitempty"`

	// An optional name for your webhook where you could describe its purpose.
	// Example: Payment updates
	Name string `json:"name,omitempty"`

	// The URL to which webhooks will be sent via HTTP POST requests in JSON format. Must use https.
	// Example: https://example.com
	// Required: true
	URL *string `json:"url"`
}

UpdateWebhookRequest update webhook request

swagger:model UpdateWebhookRequest

func (*UpdateWebhookRequest) ContextValidate

func (m *UpdateWebhookRequest) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validate this update webhook request based on the context it is used

func (*UpdateWebhookRequest) MarshalBinary

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

MarshalBinary interface implementation

func (*UpdateWebhookRequest) UnmarshalBinary

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

UnmarshalBinary interface implementation

func (*UpdateWebhookRequest) Validate

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

Validate validates this update webhook request

type User

type User struct {

	// auth types
	AuthTypes map[string]AuthTypeInfo `json:"authTypes,omitempty"`

	// created
	// Example: 2022-05-04T18:31:12.889104898Z
	Created string `json:"created,omitempty"`

	// emails
	Emails []*Email `json:"emails"`

	// first name
	// Example: John
	FirstName string `json:"firstName,omitempty"`

	// id
	// Example: 54528335-739e-4de9-bdb3-28f96c98785d
	ID string `json:"id,omitempty"`

	// last name
	// Example: Smith
	LastName string `json:"lastName,omitempty"`

	// programmatic access
	// Example: false
	ProgrammaticAccess bool `json:"programmaticAccess,omitempty"`

	// updated
	// Example: 2022-05-04T18:31:12.889104898Z
	Updated string `json:"updated,omitempty"`

	// username
	// Example: john.smith@johnnysmithson.com
	Username string `json:"username,omitempty"`
}

User user

swagger:model User

func (*User) ContextValidate

func (m *User) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validate this user based on the context it is used

func (*User) MarshalBinary

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

MarshalBinary interface implementation

func (*User) UnmarshalBinary

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

UnmarshalBinary interface implementation

func (*User) Validate

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

Validate validates this user

type UserSlim

type UserSlim struct {

	// first name
	// Example: John
	FirstName string `json:"firstName,omitempty"`

	// id
	// Example: 54528335-739e-4de9-bdb3-28f96c98785d
	ID string `json:"id,omitempty"`

	// last name
	// Example: Smith
	LastName string `json:"lastName,omitempty"`

	// programmatic access
	// Example: false
	ProgrammaticAccess bool `json:"programmaticAccess,omitempty"`

	// username
	// Example: john.smith@johnnysmithson.com
	Username string `json:"username,omitempty"`
}

UserSlim user slim

swagger:model UserSlim

func (*UserSlim) ContextValidate

func (m *UserSlim) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validates this user slim based on context it is used

func (*UserSlim) MarshalBinary

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

MarshalBinary interface implementation

func (*UserSlim) UnmarshalBinary

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

UnmarshalBinary interface implementation

func (*UserSlim) Validate

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

Validate validates this user slim

type ValidationRule

type ValidationRule struct {

	// affected resource
	// Example: direct_debits
	AffectedResource string `json:"affectedResource,omitempty"`

	// allowed values
	// Example: ["value1","value2","value3"]
	AllowedValues []string `json:"allowedValues"`

	// required
	// Example: true
	Required bool `json:"required,omitempty"`
}

ValidationRule A validation rule applies rules to the affected resource.

swagger:model ValidationRule

func (*ValidationRule) ContextValidate

func (m *ValidationRule) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validates this validation rule based on context it is used

func (*ValidationRule) MarshalBinary

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

MarshalBinary interface implementation

func (*ValidationRule) UnmarshalBinary

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

UnmarshalBinary interface implementation

func (*ValidationRule) Validate

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

Validate validates this validation rule

type Webhook

type Webhook struct {

	// The time this resource was created.
	// Example: 2022-07-20T18:31:12.889104898Z
	Created string `json:"created,omitempty"`

	// An inclusive filter to specify which resources and events that you are interested in.
	Filter []*WebhookFilter `json:"filter"`

	// The unique identifier of this webhook.
	// Example: be7e04fe-3fa0-48f5-a993-2008409255f2
	ID string `json:"id,omitempty"`

	// An optional name for your webhook where you could describe its purpose.
	// Example: Payment updates
	Name string `json:"name,omitempty"`

	// Your organization ID.
	// Example: 605e26fc-4fce-495a-a92f-2c3592d7287e
	OrganizationID string `json:"organizationId,omitempty"`

	// The last time this resource was updated.
	// Example: 2022-05-20T18:31:12.889104898Z
	Updated string `json:"updated,omitempty"`

	// The URL to which webhooks will be sent via HTTP POST requests in JSON format. Must use https.
	// Example: https://example.com
	// Required: true
	URL *string `json:"url"`

	// Webhooks won't be sent if the configuration is not verified. Modifying the URL sets verified to false. You can contact [support@atlar.com](mailto:support@atlar.com) to get a webhook configuration verified.
	// Example: true
	Verified bool `json:"verified,omitempty"`
}

Webhook webhook

swagger:model Webhook

func (*Webhook) ContextValidate

func (m *Webhook) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validate this webhook based on the context it is used

func (*Webhook) MarshalBinary

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

MarshalBinary interface implementation

func (*Webhook) UnmarshalBinary

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

UnmarshalBinary interface implementation

func (*Webhook) Validate

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

Validate validates this webhook

type WebhookFilter

type WebhookFilter struct {

	// The API version to serialize entities as. If you are consuming events and do want to deserialize into `/v1/credit-transfers`, set `apiVersion: 1`
	// Example: 1
	// Required: true
	APIVersion *int64 `json:"apiVersion"`

	// A list of events for which to receive webhooks. See events for each resource in the [Webhooks and events](doc:api#webhooks-and-events) section.
	// If a list of events is not specified you will receive all events for the given resource. Note that new events may
	// be added to the Atlar API over time which implies you will also receiving such events as they are rolled out.
	// Example: ["SENT_TO_BANK","RECONCILED"]
	Events []string `json:"events"`

	// The API resource for which to receive webhooks. See available resources in the [Webhooks and events](doc:api#webhooks-and-events) section.
	// Example: direct_debits
	// Required: true
	Resource *string `json:"resource"`
}

WebhookFilter webhook filter

swagger:model WebhookFilter

func (*WebhookFilter) ContextValidate

func (m *WebhookFilter) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validates this webhook filter based on context it is used

func (*WebhookFilter) MarshalBinary

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

MarshalBinary interface implementation

func (*WebhookFilter) UnmarshalBinary

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

UnmarshalBinary interface implementation

func (*WebhookFilter) Validate

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

Validate validates this webhook filter

type WebhookPayload

type WebhookPayload struct {

	// The entity itself as it looked right after the event impacted it. This entity is of the same model as found on the regular API. I.e. if the resource is direct_debits, this entity will be of the same model as the DirectDebit model
	// Required: true
	Entity interface{} `json:"entity"`

	// The event that impacted the entity
	Event *Event `json:"event,omitempty"`

	// The impacted entity's resource name
	// Example: direct_debits
	// Required: true
	Resource *string `json:"resource"`
}

WebhookPayload webhook payload

swagger:model WebhookPayload

func (*WebhookPayload) ContextValidate

func (m *WebhookPayload) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validate this webhook payload based on the context it is used

func (*WebhookPayload) MarshalBinary

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

MarshalBinary interface implementation

func (*WebhookPayload) UnmarshalBinary

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

UnmarshalBinary interface implementation

func (*WebhookPayload) Validate

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

Validate validates this webhook payload

type WebhookSigningKey

type WebhookSigningKey struct {

	// The time this key was created.
	// Example: 2022-07-20T18:31:12.889104898Z
	Created string `json:"created,omitempty"`

	// The unique identifier of this webhook secret.
	// Example: be7e04fe-3fa0-48f5-a993-2008409255f2
	ID string `json:"id,omitempty"`

	// A key used to sign the webhook payload.
	// Example: agj+xWKk3gqkP+SsCsljkjbDth7bxguqVMRd4K3wm1I=
	SigningKey string `json:"signingKey,omitempty"`
}

WebhookSigningKey webhook signing key

swagger:model WebhookSigningKey

func (*WebhookSigningKey) ContextValidate

func (m *WebhookSigningKey) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validates this webhook signing key based on context it is used

func (*WebhookSigningKey) MarshalBinary

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

MarshalBinary interface implementation

func (*WebhookSigningKey) UnmarshalBinary

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

UnmarshalBinary interface implementation

func (*WebhookSigningKey) Validate

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

Validate validates this webhook signing key

Source Files

Jump to

Keyboard shortcuts

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