swiftref

type APIClient struct {
	AccountNumbersApi *AccountNumbersApiService

	BbansApi *BbansApiService

	BicsApi *BicsApiService

	CountryCodesApi *CountryCodesApiService

	CurrencyCodesApi *CurrencyCodesApiService

	IbanNationalIdsApi *IbanNationalIdsApiService

	IbansApi *IbansApiService

	LeisApi *LeisApiService

	NationalIdsApi *NationalIdsApiService
	// contains filtered or unexported fields
}

type APIKey struct {
	Key    string
	Prefix string
}

type APIResponse struct {
	*http.Response `json:"-"`
	Message        string `json:"message,omitempty"`
	// Operation is the name of the swagger operation.
	Operation string `json:"operation,omitempty"`
	// RequestURL is the request URL. This value is always available, even if the
	// embedded *http.Response is nil.
	RequestURL string `json:"url,omitempty"`
	// Method is the HTTP method used for the request.  This value is always
	// available, even if the embedded *http.Response is nil.
	Method string `json:"method,omitempty"`
	// Payload holds the contents of the response body (which may be nil or empty).
	// This is provided here as the raw response.Body() reader will have already
	// been drained.
	Payload []byte `json:"-"`
}

type AccountNumbersApiGetAccountNumberValidityV2Opts struct {
	CountryCode optional.String
	IsIban      optional.String
	Usage       optional.String
	NationalId  optional.String
	Bic         optional.String
	APIStatus   optional.String
}

type AccountNumbersApiService service

type Address struct {
	// An array of maximum 4 lines (strings) expressing the street address of the BIC, e.g. street name, house number, building name and floor, area
	AddressLines []string `json:"address_lines,omitempty"`
	// Numbered box in a post office, assigned to a person or organisation, where letters are kept until called for
	PostOfficeBox string `json:"post_office_box,omitempty"`
	// Name of a built-up area, with defined boundaries, and a local government
	TownName string `json:"town_name,omitempty"`
	// Identifies a subdivision of a country (for example, state, region, county)
	CountrySubdivision string `json:"country_subdivision,omitempty"`
	// Identifier consisting of a group of letters and/or numbers that is added to a postal address to assist the sorting of mail
	PostCode string `json:"post_code,omitempty"`
	// The country name in English of the institution/branch as indicated in the ISO 3166 list
	CountryName string `json:"country_name"`
	// The ISO 3166-1 alpha-2 code of the country of the institution/branch
	CountryCode string `json:"country_code"`
}

type Address2 struct {
	StreetAddress []string `json:"street_address,omitempty"`
	City          string   `json:"city,omitempty"`
	Region        string   `json:"region,omitempty"`
	PostalCode    string   `json:"postal_code,omitempty"`
	CountryName   string   `json:"country_name"`
}

type BasicAuth struct {
	UserName string `json:"userName,omitempty"`
	Password string `json:"password,omitempty"`
}

type BbansApiGetIbanFromBbanV2Opts struct {
	APIStatus optional.String
}

type BbansApiService service

type BicsApiGetBicDetailsV2Opts struct {
	APIStatus optional.String
}

type BicsApiGetBicValidityV2Opts struct {
	EffectiveDate optional.String
	APIStatus     optional.String
}

type BicsApiGetLeiFromBicV2Opts struct {
	APIStatus optional.String
}

type BicsApiGetNationalIdsFromBicV2Opts struct {
	APIStatus optional.String
}

type BicsApiGetSepaReachabilityFromBicV2Opts struct {
	APIStatus optional.String
}

type BicsApiGetSsisFromBicV2Opts struct {
	SsiCategory optional.String
	APIStatus   optional.String
}

type BicsApiService service

type Configuration struct {
	BasePath      string            `json:"basePath,omitempty"`
	Host          string            `json:"host,omitempty"`
	Scheme        string            `json:"scheme,omitempty"`
	DefaultHeader map[string]string `json:"defaultHeader,omitempty"`
	UserAgent     string            `json:"userAgent,omitempty"`
	HTTPClient    *http.Client
}

type ContactDetails struct {
	// Collection of information that identifies a phone number, as defined by telecom services
	PhoneNumber string `json:"phone_number,omitempty"`
	// Collection of information that identifies a FAX number, as defined by telecom services
	FaxNumber string `json:"fax_number,omitempty"`
	// Address for electronic mail (e-mail)
	EmailAddress string `json:"email_address,omitempty"`
	// Address for the Universal Resource Locator (URL), that is used over the www (HTTP) service
	WebAddress string `json:"web_address,omitempty"`
}

type CorrespondentBic struct {
	// Specifies the BIC
	Bic string `json:"bic"`
	// The account for a given BIC
	Account string `json:"account,omitempty"`
	// Indicates if it is a preferred correspondent, true (yes) or false (no)
	Preferred bool `json:"preferred,omitempty"`
}

type Country struct {
	// The ISO country name
	Name string `json:"name"`
	// The ISO 2-letters country code
	Iso2aCode string `json:"iso_2a_code"`
	// The ISO 3-letters country code
	Iso3aCode string `json:"iso_3a_code,omitempty"`
	// The ISO 3-digits country code
	Iso3nCode string `json:"iso_3n_code,omitempty"`
	// A list of currencies used by the country
	Currencies []CountryCurrencies `json:"currencies,omitempty"`
}

type CountryCodesApiGetCountryCodeDetailsV2Opts struct {
	APIStatus optional.String
}

type CountryCodesApiGetCountryCodeValidityV2Opts struct {
	APIStatus optional.String
}

type CountryCodesApiService service

type CountryCurrencies struct {
	// The ISO currency name
	Name string `json:"name"`
	// The ISO 3-letters currency code
	Iso3aCode string `json:"iso_3a_code"`
	// The ISO 3-digits currency code
	Iso3nCode string `json:"iso_3n_code,omitempty"`
}

type Currency struct {
	// The ISO currency name
	Name string `json:"name"`
	// The ISO 3-letters currency code
	Iso3aCode string `json:"iso_3a_code"`
	// The ISO 3-digits currency code
	Iso3nCode string `json:"iso_3n_code,omitempty"`
	// The number of fractional digits to use
	FractionalDigits int32 `json:"fractional_digits,omitempty"`
	// A list of countries where the currency is used
	Countries []CurrencyCountries `json:"countries,omitempty"`
}

type CurrencyCodesApiGetCurrencyCodeDetailsV2Opts struct {
	APIStatus optional.String
}

type CurrencyCodesApiGetCurrencyCodeValidityV2Opts struct {
	APIStatus optional.String
}

type CurrencyCodesApiService service

type CurrencyCountries struct {
	// The ISO country name
	Name string `json:"name"`
	// The ISO 2-letters country code
	Iso2aCode string `json:"iso_2a_code"`
	// The ISO 3-letters country code
	Iso3aCode string `json:"iso_3a_code,omitempty"`
	// The ISO 3-digits country code
	Iso3nCode string `json:"iso_3n_code,omitempty"`
}

type GenericSwaggerError struct {
	// contains filtered or unexported fields
}

type IbanNationalIdsApiGetBicFromIbanNationalIdV2Opts struct {
	APIStatus optional.String
}

type IbanNationalIdsApiService service

type IbansApiGetBicFromIbanV2Opts struct {
	APIStatus optional.String
}

type IbansApiGetIbanDetailsV2Opts struct {
	APIStatus optional.String
}

type IbansApiGetIbanValidityV2Opts struct {
	APIStatus optional.String
}

type IbansApiService service

type InlineResponse200 struct {
	Status *Status `json:"status,omitempty"`
	// The IBAN that was validated
	Iban string `json:"iban"`
	// The code IVAL if the IBAN is valid
	Validity string `json:"validity"`
}

type InlineResponse2001 struct {
	Status *Status `json:"status,omitempty"`
	// The BIC associated with the IBAN
	Bic string `json:"bic"`
}

type InlineResponse20010 struct {
	Status *Status `json:"status,omitempty"`
	// SEPA CSM through which the BIC is reachable for the supplied SEPA scheme
	PaymentChannels []SepaPaymentChannel `json:"payment_channels"`
	// Adherence BIC11 of the reachable BIC
	AdherenceBic string `json:"adherence_bic,omitempty"`
}

type InlineResponse20011 struct {
	Status *Status `json:"status,omitempty"`
	Ssis   []Ssi   `json:"ssis"`
}

type InlineResponse20012 struct {
	Status      *Status                            `json:"status,omitempty"`
	NationalIds []NationalIdDetailsInLocalLanguage `json:"national_ids"`
}

type InlineResponse20013 struct {
	Status *Status `json:"status,omitempty"`
	// The National ID that was validated
	NationalId string `json:"national_id"`
	// The scheme under which the National ID is defined
	Scheme string `json:"scheme"`
	// Contains the code VNID (Valid National ID) if the National ID is valid in the provided scheme or country
	Validity string `json:"validity"`
}

type InlineResponse20014 struct {
	Status *Status `json:"status,omitempty"`
	// An array of the corresponding BICs
	Bics []string `json:"bics"`
}

type InlineResponse20015 struct {
	Status *Status `json:"status,omitempty"`
	// The country code that was validated
	CountryCode string `json:"country_code"`
	// The code VCOC if the country code is valid
	Validity string `json:"validity"`
}

type InlineResponse20016 struct {
	// The ISO country name
	Name string `json:"name"`
	// The ISO 2-letters country code
	Iso2aCode string `json:"iso_2a_code"`
	// The ISO 3-letters country code
	Iso3aCode string `json:"iso_3a_code,omitempty"`
	// The ISO 3-digits country code
	Iso3nCode string `json:"iso_3n_code,omitempty"`
	// A list of currencies used by the country
	Currencies []CountryCurrencies `json:"currencies,omitempty"`
	Status     *Status             `json:"status,omitempty"`
}

type InlineResponse20017 struct {
	Status *Status `json:"status,omitempty"`
	// The currency code that was validated
	CurrencyCode string `json:"currency_code"`
	// The code VCUC if the currency code is valid
	Validity string `json:"validity"`
}

type InlineResponse20018 struct {
	// The ISO currency name
	Name string `json:"name"`
	// The ISO 3-letters currency code
	Iso3aCode string `json:"iso_3a_code"`
	// The ISO 3-digits currency code
	Iso3nCode string `json:"iso_3n_code,omitempty"`
	// The number of fractional digits to use
	FractionalDigits int32 `json:"fractional_digits,omitempty"`
	// A list of countries where the currency is used
	Countries []CurrencyCountries `json:"countries,omitempty"`
	Status    *Status             `json:"status,omitempty"`
}

type InlineResponse20019 struct {
	Status *Status `json:"status,omitempty"`
	// The LEI that was validated
	Lei string `json:"lei"`
	// The code VLEI if the LEI is valid
	Validity string `json:"validity"`
}

type InlineResponse2002 struct {
	Status *Status `json:"status,omitempty"`
	// The IBAN that was validated
	Iban string `json:"iban"`
	// The ISO 3166-1 alpha-2 code of the country of the institution/branch.
	CountryCode string `json:"country_code"`
	// The checksum extracted from the IBAN
	Checksum string `json:"checksum"`
	// The BANK ID extracted from the IBAN. Its structure (bank ID only or bank ID + branch ID) is as defined by the IBAN BIC LENGTH in the IBANSTRUCTURE file.
	BankId string `json:"bank_id"`
	// Unique and unambiguous identification of a branch of a financial institution.
	BranchId string `json:"branch_id,omitempty"`
	// The remainder of the IBAN including the account number.
	AccountNumber string `json:"account_number"`
	// The length of the IBAN
	Length int32 `json:"length"`
}

type InlineResponse20020 struct {
	Lei                     string               `json:"lei"`
	LegalName               string               `json:"legal_name"`
	Address                 *Address2            `json:"address,omitempty"`
	HeadQuartersAddress     *Address2            `json:"head_quarters_address,omitempty"`
	LegalJurisdiction       string               `json:"legal_jurisdiction,omitempty"`
	LegalForm               string               `json:"legal_form,omitempty"`
	EntityLegalFormCode     string               `json:"entity_legal_form_code,omitempty"`
	EntityStatus            string               `json:"entity_status,omitempty"`
	InitialRegistrationDate string               `json:"initial_registration_date,omitempty"`
	LastUpdateDate          string               `json:"last_update_date,omitempty"`
	RegistrationStatus      string               `json:"registration_status,omitempty"`
	Associated              *LeiAssociated       `json:"associated,omitempty"`
	EntityExpiration        *LeiEntityExpiration `json:"entity_expiration,omitempty"`
	Successor               *LeiSuccessor        `json:"successor,omitempty"`
	Status                  *Status              `json:"status,omitempty"`
}

type InlineResponse20021 struct {
	Status *Status `json:"status,omitempty"`
	// The account number that was validated
	AccountNumber string `json:"account_number"`
	// The code AVAL if the account number is valid
	Validity string `json:"validity"`
}

type InlineResponse2003 struct {
	Status *ShortStatus `json:"status,omitempty"`
	// The BIC associated with the IBAN national ID
	Bic string `json:"bic"`
}

type InlineResponse2004 struct {
	Status *Status `json:"status,omitempty"`
	// The corresponding IBAN
	Iban string `json:"iban"`
}

type InlineResponse2005 struct {
	Status *Status `json:"status,omitempty"`
	// The BIC of the institution on which more information is requested
	Bic string `json:"bic"`
	// Name by which a party is known and which is usually used to identify that party
	InstitutionName string `json:"institution_name"`
	// A free text description of the branch as provided by the financial institution to which it belongs; this is currently provided for entries with a BIC when the financial institution concerned wants to provide this extra information
	BranchInformation string          `json:"branch_information,omitempty"`
	Address           *Address        `json:"address"`
	ContactDetails    *ContactDetails `json:"contact_details,omitempty"`
	// Status of the entity in the office hierarchy
	OfficeType string `json:"office_type,omitempty"`
	// A list of 3-character codes and names of SWIFT FIN service codes (also called value added service codes)
	SwiftServices     []SwiftService     `json:"swift_services"`
	SwiftConnectivity *SwiftConnectivity `json:"swift_connectivity"`
}

type InlineResponse2006 struct {
	Status *Status `json:"status,omitempty"`
	// The BIC that was validated
	Bic string `json:"bic"`
	// The code VBIC if the BIC is valid
	Validity string `json:"validity"`
	// A date in YYYY-MM-DD format to indicate explicitly on which date the BIC is confirmed to be valid; the timezone is always UTC, hence the \"Z\" suffix will always be present, in compliance with ISO 8601 / RFC 3339
	EffectiveDate string `json:"effective_date"`
}

type InlineResponse2007 struct {
	Status *Status `json:"status,omitempty"`
	// The corresponding LEI for a given BIC
	Lei string `json:"lei"`
}

type InlineResponse2008 struct {
	Status *Status `json:"status,omitempty"`
	// The corresponding BIC for a given LEI
	Bic string `json:"bic"`
}

type InlineResponse2009 struct {
	Status      *Status      `json:"status,omitempty"`
	NationalIds []NationalId `json:"national_ids"`
}

type IntermediaryBic struct {
	// Specifies the BIC
	Bic string `json:"bic"`
	// The account for a given BIC
	Account string `json:"account,omitempty"`
}

type Lei struct {
	Lei                     string               `json:"lei"`
	LegalName               string               `json:"legal_name"`
	Address                 *Address2            `json:"address,omitempty"`
	HeadQuartersAddress     *Address2            `json:"head_quarters_address,omitempty"`
	LegalJurisdiction       string               `json:"legal_jurisdiction,omitempty"`
	LegalForm               string               `json:"legal_form,omitempty"`
	EntityLegalFormCode     string               `json:"entity_legal_form_code,omitempty"`
	EntityStatus            string               `json:"entity_status,omitempty"`
	InitialRegistrationDate string               `json:"initial_registration_date,omitempty"`
	LastUpdateDate          string               `json:"last_update_date,omitempty"`
	RegistrationStatus      string               `json:"registration_status,omitempty"`
	Associated              *LeiAssociated       `json:"associated,omitempty"`
	EntityExpiration        *LeiEntityExpiration `json:"entity_expiration,omitempty"`
	Successor               *LeiSuccessor        `json:"successor,omitempty"`
}

type LeiAssociated struct {
	EntityType string `json:"entity_type,omitempty"`
	Lei        string `json:"lei,omitempty"`
	EntityName string `json:"entity_name,omitempty"`
}

type LeiEntityExpiration struct {
	Date   string `json:"date,omitempty"`
	Reason string `json:"reason,omitempty"`
}

type LeiSuccessor struct {
	Lei  string `json:"lei,omitempty"`
	Name string `json:"name,omitempty"`
}

type LeisApiGetBicFromLeiV2Opts struct {
	APIStatus optional.String
}

type LeisApiGetLeiDetailsV2Opts struct {
	APIStatus optional.String
}

type LeisApiGetLeiValidityV2Opts struct {
	APIStatus optional.String
}

type LeisApiService service

type NationalId struct {
	// The National ID (a synonym for clearing code, routing code, sort code, bank and branch ID) of the institution or branch
	Id string `json:"id"`
	// The type of National ID; if absent, it is the main National ID (MA), otherwise it is Foreign National ID (FN) or Alternative National ID (AN)
	Type_ string `json:"type,omitempty"`
	// The scheme under which the National ID is defined
	Scheme string `json:"scheme"`
}

type NationalIdDetails struct {
	// National ID for which details were requested
	Id string `json:"id"`
	// The scheme under which the National ID is defined
	Scheme string `json:"scheme"`
	// Name by which a party is known and which is usually used to identify that party
	InstitutionName string `json:"institution_name"`
	// A free text description of the branch as provided by the financial institution to which it belongs; this is currently provided for entries with a BIC when the financial institution concerned wants to provide this extra information
	BranchInformation string          `json:"branch_information,omitempty"`
	Address           *Address        `json:"address,omitempty"`
	ContactDetails    *ContactDetails `json:"contact_details,omitempty"`
	// Status of the entity in the office hierarchy
	OfficeType string `json:"office_type,omitempty"`
}

type NationalIdDetailsInLocalLanguage struct {
	// National ID for which details were requested
	Id string `json:"id"`
	// The scheme under which the National ID is defined
	Scheme string `json:"scheme"`
	// Name by which a party is known and which is usually used to identify that party
	InstitutionName string `json:"institution_name"`
	// A free text description of the branch as provided by the financial institution to which it belongs; this is currently provided for entries with a BIC when the financial institution concerned wants to provide this extra information
	BranchInformation string          `json:"branch_information,omitempty"`
	Address           *Address        `json:"address,omitempty"`
	ContactDetails    *ContactDetails `json:"contact_details,omitempty"`
	// Status of the entity in the office hierarchy
	OfficeType string `json:"office_type,omitempty"`
	// ISO 639-2 code (three letters) of language
	LanguageIsoCode3 string `json:"language_iso_code_3,omitempty"`
	// ISO 15924 code (four letters) of language script
	LanguageScriptCode4 string `json:"language_script_code_4,omitempty"`
}

type NationalIdsApiGetBicsFromNationalIdV2Opts struct {
	CountryCode optional.String
	Scheme      optional.String
	APIStatus   optional.String
}

type NationalIdsApiGetNationalIdDetailsV2Opts struct {
	CountryCode       optional.String
	Scheme            optional.String
	APIStatus         optional.String
	OnlyLocalLanguage optional.Bool
}

type NationalIdsApiGetNationalIdValidityV2Opts struct {
	CountryCode optional.String
	Scheme      optional.String
	APIStatus   optional.String
}

type NationalIdsApiService service

type SepaPaymentChannel struct {
	// The id of the payment channel (SEPA-compliant CSM)
	Id string `json:"id"`
	// A payment channel has a member_type, the member_type has one of the codes DRCT, IDRC or UKWN
	MemberType string `json:"member_type"`
	// The BIC of the direct participant through which the indirectly reachable BIC can be reached; it may only be present if the payment channel's member is an indirect participant
	DirectParticipant string `json:"direct_participant,omitempty"`
}

type ShortStatus struct {
	// A repeat of the HTTP status code
	Http string `json:"http"`
	// An error code or status code, unique across all SWIFT APIs
	Code string `json:"code"`
	// Provided in case your application needs to display a short error message to a human end-user
	UserMessage string `json:"user_message,omitempty"`
	// A verbose description for a developer of the possible causes of the error and the possible fixes
	DeveloperMessage string `json:"developer_message,omitempty"`
	// A hyperlink to an explanation of the error for developers, possibly with further pointers to community input
	MoreInfo string `json:"more_info,omitempty"`
}

type Ssi struct {
	// The owner of the SSI Nostro Account
	OwnerBic string `json:"owner_bic"`
	// Name by which an institution is known and which is usually used to identify that institution
	InstitutionName string `json:"institution_name,omitempty"`
	// A free text description of the branch as provided by the financial institution to which it belongs; for the time being this will be provided only for entries with a BIC and only when the financial institution concerned wants to provide this extra information; the information is sourced from the BIC Directory
	BranchInformation string   `json:"branch_information,omitempty"`
	Address           *Address `json:"address,omitempty"`
	// The ISO 4217 currency code of the requested SSIs
	CurrencyCode string `json:"currency_code"`
	// Indicates whether there is a direct account relationship between the owner of the SSI and the correspondent; if false, then this means at least the first intermediary must be present
	Direct             bool              `json:"direct"`
	Correspondent      *CorrespondentBic `json:"correspondent"`
	FirstIntermediary  *IntermediaryBic  `json:"first_intermediary,omitempty"`
	SecondIntermediary *IntermediaryBic  `json:"second_intermediary,omitempty"`
}

type Status struct {
	// A repeat of the HTTP status code
	Http string `json:"http"`
	// An error code or status code, unique across all SWIFT APIs
	Code string `json:"code"`
	// Provided in case your application needs to display a short error message to a human end-user
	UserMessage string `json:"user_message"`
	// A verbose description for a developer of the possible causes of the error and the possible fixes
	DeveloperMessage string `json:"developer_message,omitempty"`
	// A hyperlink to an explanation of the error for developers, possibly with further pointers to community input
	MoreInfo string `json:"more_info,omitempty"`
}

type StatusWithReliability struct {
	Reliability int32 `json:"reliability,omitempty"`
}

type SwiftConnectivity struct {
	// True if connected to SWIFT FIN, false otherwise
	Fin bool `json:"fin"`
	// True if used in at least one service on SWIFTNet InterAct, false otherwise
	Interact bool `json:"interact"`
	// True if used in at least one service on SWIFTNet FileAct, false otherwise
	Fileact bool `json:"fileact"`
}

type SwiftService struct {
	// Code given by the service provider (SWIFT) to uniquely identify a service it offers
	Code string `json:"code"`
	// Name given by the service provider (SWIFT) to uniquely identify a service it offers
	Name string `json:"name"`
}

type WithShortStatus struct {
	Status *ShortStatus `json:"status,omitempty"`
}

type WithStatus struct {
	Status *Status `json:"status,omitempty"`
}

type WithStatusWithReliability struct {
	Status *StatusWithReliability `json:"status,omitempty"`
}