prevalidation

package

v0.3.1 Latest Latest Go to latest Published: Jun 14, 2023 License: MIT Imports: 23 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Repository

github.com/alifcapital/swift

Links

Open Source Insights

README ¶

Go API client for swagger

New version of the Bank Account Verification Service (the BAV), BAV v2, for Users and Data Providers. Additionally to BAV v1, depending on the jurisdiction where the account is held and the market practices in use, BAV v2 brings in the validation of the account type and if the creditor name partially matches the account holder name. v2.1.1Release Notes * Addition of Beneficiary Account Verification * Beneficiary Account Verification has been updated to version 2, which includes features to better support domestic systems, future support of ISO20022 addresses and support for systems that may provide answers based on past transactions. * Schema Organisation8 updated to OrganisationIdentification8

Overview

This API client was generated by the swagger-codegen project. By using the swagger-spec from a remote server, you can easily generate an API client.

API version: 2.1.1
Package version: 1.0.0
Build package: io.swagger.codegen.v3.generators.go.GoClientCodegen For more information, please visit https://developer.swift.com

Installation

Put the package under your project folder and add the following in import:

import "./swagger"

Documentation for API Endpoints

All URIs are relative to https://api-test.swiftnet.sipn.swift.com/swift-preval-pilot/v2

Class	Method	HTTP request	Description
PaymentPreValidationApi	GetAccountFormatValidationStatus	Post /payment/account-format	Validates the account format.
PaymentPreValidationApi	GetCategoryPurposeValidationStatus	Post /payment/category-purpose	Validates the category purpose.
PaymentPreValidationApi	GetFinancialInstitutionIdentityValidationStatus	Post /payment/financial-institution-identity	Validates a financial institution identifier.
PaymentPreValidationApi	GetPaymentPurposeCodeValidationStatus	Post /payment/purpose-code	Validates the purpose code.
PaymentPreValidationApi	GetPaymentPurposeValidationStatus	Post /payment/payment-purpose	Validates the payment purpose.
PaymentPreValidationApi	VerifyAccount	Post /accounts/verification	Verify that a beneficiary account could be able to receive incoming funds.

Documentation For Models

Documentation For Authorization

oauthBearerToken

oauthClientCredentials

Type: OAuth
Flow: application
Authorization URL:
Scopes:

Example

auth := context.WithValue(context.Background(), sw.ContextAccessToken, "ACCESSTOKENSTRING")
r, err := client.Service.Operation(auth, args)

Or via OAuth2 module to automatically refresh tokens and perform user authentication.

import "golang.org/x/oauth2"

/* Perform OAuth2 round trip request and obtain a token */

tokenSource := oauth2cfg.TokenSource(createContext(httpClient), &token)
auth := context.WithValue(oauth2.NoContext, sw.ContextOAuth2, tokenSource)
r, err := client.Service.Operation(auth, args)

Author

developer-support@swift.com

Documentation ¶

Overview ¶

* Payment Pre-validation API * * New version of the Bank Account Verification Service (the BAV), BAV v2, for Users and Data Providers. Additionally to BAV v1, depending on the jurisdiction where the account is held and the market practices in use, BAV v2 brings in the validation of the account type and if the creditor name partially matches the account holder name. **v2.1.1Release Notes** * Addition of Beneficiary Account Verification * Beneficiary Account Verification has been updated to version 2, which includes features to better support domestic systems, future support of ISO20022 addresses and support for systems that may provide answers based on past transactions. * Schema Organisation8 updated to OrganisationIdentification8 * * API version: 2.1.1 * Contact: developer-support@swift.com * Generated by: Swagger Codegen (https://github.com/swagger-api/swagger-codegen.git)

Index ¶

Variables
func CacheExpires(r *http.Response) time.Time
type APIClient
- func NewAPIClient(cfg *Configuration) *APIClient
- func (c *APIClient) ChangeBasePath(path string)
type APIKey
type APIResponse
- func NewAPIResponse(r *http.Response) *APIResponse
- func NewAPIResponseWithError(errorMessage string) *APIResponse
type AccountFormatValidation1
type AccountFormatValidationCheck1
type AccountFormatValidationCheck1Code
type AccountFormatValidationReason1Code
type AccountFormatValidationStatus1
type AccountFormatValidationStatus1Code
type AccountIdentification4Choice
type AccountSchemeName1Choice
type AccountType2Code
type AccountValidationCheckContext1Code
type AccountValidationResponse1Code
type AccountValidationResponse2Code
type AccountValidationResponse3Code
type AccountValidationResponse4Code
type AccountValidationSource1Code
type AccountVerificationRequest
type AccountVerificationResponse1
type AddressType2Code
type AddressType3Choice
type BasicAuth
type BranchAndFinancialInstitutionIdentification8
type BranchData3
type CategoryPaymentValidationReason1Code
type CategoryPurposeValidation1
type CategoryPurposeValidationStatus1
type CategoryPurposeValidationStatus1Code
type ClearingSystemIdentification2Choice
type ClearingSystemMemberIdentification2
type Configuration
- func NewConfiguration() *Configuration
- func (c *Configuration) AddDefaultHeader(key string, value string)
type Contact10
type ErrorMessage
type FinancialInstitutionIdentification20
type FinancialInstitutionIdentification24
type FinancialInstitutionIdentityValidation1
type FinancialInstitutionIdentityValidationReason1Code
type FinancialInstitutionIdentityValidationStatus1
type FinancialInstitutionIdentityValidationStatus1Code
type GenericAccountIdentification1
type GenericCodeIdentification1
type GenericConnectivityChoice
type GenericIdentification30
type GenericOrganisationIdentification1
type GenericSwaggerError
- func (e GenericSwaggerError) Body() []byte
- func (e GenericSwaggerError) Error() string
- func (e GenericSwaggerError) Model() interface{}
type OneOfAccountIdentification4Choice
type OneOfAccountSchemeName1Choice
type OneOfAddressType3Choice
type OneOfClearingSystemIdentification2Choice
type OneOfOrganisationIdentificationSchemeName1Choice
type OrganisationIdentification8
type OrganisationIdentificationSchemeName1Choice
type PaymentPreValidationApiGetAccountFormatValidationStatusOpts
type PaymentPreValidationApiGetCategoryPurposeValidationStatusOpts
type PaymentPreValidationApiGetFinancialInstitutionIdentityValidationStatusOpts
type PaymentPreValidationApiGetPaymentPurposeCodeValidationStatusOpts
type PaymentPreValidationApiGetPaymentPurposeValidationStatusOpts
type PaymentPreValidationApiService
- func (a *PaymentPreValidationApiService) GetAccountFormatValidationStatus(ctx context.Context, ...) (AccountFormatValidationStatus1, *http.Response, error)
- func (a *PaymentPreValidationApiService) GetCategoryPurposeValidationStatus(ctx context.Context, ...) (CategoryPurposeValidationStatus1, *http.Response, error)
- func (a *PaymentPreValidationApiService) GetFinancialInstitutionIdentityValidationStatus(ctx context.Context, ...) (FinancialInstitutionIdentityValidationStatus1, *http.Response, error)
- func (a *PaymentPreValidationApiService) GetPaymentPurposeCodeValidationStatus(ctx context.Context, ...) (PaymentPurposeCodeValidationStatus1, *http.Response, error)
- func (a *PaymentPreValidationApiService) GetPaymentPurposeValidationStatus(ctx context.Context, ...) (PaymentPurposeValidationStatus1, *http.Response, error)
- func (a *PaymentPreValidationApiService) VerifyAccount(ctx context.Context, xBic string, ...) (AccountVerificationResponse1, *http.Response, error)
type PaymentPreValidationApiVerifyAccountOpts
type PaymentPurposeCodeValidation1
type PaymentPurposeCodeValidationReason1Code
type PaymentPurposeCodeValidationStatus1
type PaymentPurposeCodeValidationStatus1Code
type PaymentPurposeValidation1
type PaymentPurposeValidationCheck1
type PaymentPurposeValidationCheckCode
type PaymentPurposeValidationReason1Code
type PaymentPurposeValidationStatus1
type PaymentPurposeValidationStatus1Code
type PaymentValidationInputParameter1
type PaymentValidationSeverity1
type PostalAddress24
type ValidationCheckResponse2

Constants ¶

This section is empty.

Variables ¶

View Source

var (
	// ContextOAuth2 takes a oauth2.TokenSource as authentication for the request.
	ContextOAuth2 = contextKey("token")

	// ContextBasicAuth takes BasicAuth as authentication for the request.
	ContextBasicAuth = contextKey("basic")

	// ContextAccessToken takes a string oauth2 access token as authentication for the request.
	ContextAccessToken = contextKey("accesstoken")

	// ContextAPIKey takes an APIKey as authentication for the request
	ContextAPIKey = contextKey("apikey")
)

Functions ¶

func CacheExpires ¶

func CacheExpires(r *http.Response) time.Time

CacheExpires helper function to determine remaining time before repeating a request.

Types ¶

type APIClient ¶

type APIClient struct {
	PaymentPreValidationApi *PaymentPreValidationApiService
	// contains filtered or unexported fields
}

APIClient manages communication with the Payment Pre-validation API API v2.1.1 In most cases there should be only one, shared, APIClient.

func NewAPIClient ¶

func NewAPIClient(cfg *Configuration) *APIClient

NewAPIClient creates a new API client. Requires a userAgent string describing your application. optionally a custom http.Client to allow for advanced features such as caching.

func (*APIClient) ChangeBasePath ¶

func (c *APIClient) ChangeBasePath(path string)

Change base path to allow switching to mocks

type APIKey ¶

type APIKey struct {
	Key    string
	Prefix string
}

APIKey provides API key based authentication to a request passed via context using ContextAPIKey

type APIResponse ¶

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

func NewAPIResponse ¶

func NewAPIResponse(r *http.Response) *APIResponse

func NewAPIResponseWithError ¶

func NewAPIResponseWithError(errorMessage string) *APIResponse

type AccountFormatValidation1 ¶

type AccountFormatValidation1 struct {
	AccountIdentification              string `json:"account_identification"`
	CountryCode                        string `json:"country_code,omitempty"`
	FinancialInstitutionIdentification string `json:"financial_institution_identification,omitempty"`
}

This represents the details of Account Format Validation service request.

type AccountFormatValidationCheck1 ¶

type AccountFormatValidationCheck1 struct {
	Code   *AccountFormatValidationCheck1Code   `json:"code"`
	Status *AccountFormatValidationStatus1Code  `json:"status"`
	Reason []AccountFormatValidationReason1Code `json:"reason"`
}

Details the outcome of each individual account format validation check.

type AccountFormatValidationCheck1Code ¶

type AccountFormatValidationCheck1Code string

AccountFormatValidationCheck1Code : The list of unique identifiers for the individual account format validation checks. *`BBFI_bban_and_financial_institution_check`-The unique identifier of the individual account format validation check that determines if the format of the instructed account is the BBAN format used by the instructed financial institution. *`DOCO_domestic_bank_specific_account_and_country_check`-The unique identifier of the individual account format validation check that determines if the format of the instructed account matches the domestic, bank specific format rules identified in the instructed country. *`DOFI_domestic_bank_specific_account_and_financial_institution_check`-The unique identifier of the individual account format validation check that determines if the format of the instructed account matches the domestic, bank specific format used by the instructed financial institution, in its country. \\r\\nThe country of the financial institution can only be determined when the instructed financial institution is identified by BIC 8 or BIC 11, otherwise this individual account format validation check can not be performed. *`IBCO_iban_and_country_check`-The unique identifier of the individual account format validation check that determines if the format of the instructed account is the IBAN format used in the instructed country. *`IBFI_iban_and_financial_institution_check`-The unique identifier of the individual account format validation check that determines if the format of the instructed account is the IBAN format used by the instructed financial institution. *`IBAN_iban_check`-The unique identifier of the individual account format validation check that determines if the format of the instructed account is an IBAN format. *`DOCF_domestic_bank_specific_account_and_country_and_financial_institution_check`-The unique identifier of the individual account format validation check that determines if the format of the instructed account matches the domestic, bank specific format used by the instructed financial institution, in the instructed country. \\r\\nThis individual account format validation check can be performed irrespective of the nature of finanical institution identifier, if this is a BIC 8, BIC 11 or Clearing System Member Identifier. *`BBCO_bban_and_country_check`-The unique identifier of the individual account format validation check that determines if the format of the instructed account is the BBAN format used in the instructed country.

const (
	BBFI_BBAN_AND_FINANCIAL_INSTITUTION_CHECK_AccountFormatValidationCheck1Code                                       AccountFormatValidationCheck1Code = "BBFI_bban_and_financial_institution_check"
	DOCO_DOMESTIC_BANK_SPECIFIC_ACCOUNT_AND_COUNTRY_CHECK_AccountFormatValidationCheck1Code                           AccountFormatValidationCheck1Code = "DOCO_domestic_bank_specific_account_and_country_check"
	DOFI_DOMESTIC_BANK_SPECIFIC_ACCOUNT_AND_FINANCIAL_INSTITUTION_CHECK_AccountFormatValidationCheck1Code             AccountFormatValidationCheck1Code = "DOFI_domestic_bank_specific_account_and_financial_institution_check"
	IBCO_IBAN_AND_COUNTRY_CHECK_AccountFormatValidationCheck1Code                                                     AccountFormatValidationCheck1Code = "IBCO_iban_and_country_check"
	IBFI_IBAN_AND_FINANCIAL_INSTITUTION_CHECK_AccountFormatValidationCheck1Code                                       AccountFormatValidationCheck1Code = "IBFI_iban_and_financial_institution_check"
	IBAN_IBAN_CHECK_AccountFormatValidationCheck1Code                                                                 AccountFormatValidationCheck1Code = "IBAN_iban_check"
	DOCF_DOMESTIC_BANK_SPECIFIC_ACCOUNT_AND_COUNTRY_AND_FINANCIAL_INSTITUTION_CHECK_AccountFormatValidationCheck1Code AccountFormatValidationCheck1Code = "DOCF_domestic_bank_specific_account_and_country_and_financial_institution_check"
	BBCO_BBAN_AND_COUNTRY_CHECK_AccountFormatValidationCheck1Code                                                     AccountFormatValidationCheck1Code = "BBCO_bban_and_country_check"
)

List of AccountFormatValidationCheck1Code

type AccountFormatValidationReason1Code ¶

type AccountFormatValidationReason1Code string

AccountFormatValidationReason1Code : The list of unique identifiers which describe the reasons for Account Format validation status. *`VIBN_valid_iban`-The instructed account identifier subject to account format validation has a valid IBAN format for the instructed payment context. *`VDOM_valid_domestic_bank_specific`-The instructed account identifier subject to account format validation has a valid domestic, bank specific format (national domestic standard or bank specific standard) for the instructed payment context. *`VBBN_valid_bban`-The instructed account identifier subject to account format validation has a valid Basic Bank Account Number (BBAN) format for the instructed payment context. *`MCTY_missing_country_code`-Country code is missing from the payment context in order for the validation of the instructed payment information to be performed. *`IIBN_invalid_iban`-The instructed account identifier subject to account format validation does not have a valid IBAN format for the instructed payment context. *`IDOM_invalid_domestic_bank_specific`-The instructed account identifier subject to account format validation does not have a valid domestic, bank specific format (nor national domestic standard nor bank specific standard) for the instructed payment context. *`IBBN_invalid_bban`-The instructed account identifier subject to account format validation does not have a valid Basic Bank Account Number (BBAN) format for the instructed payment context. *`IFIN_inconsistent_financial_institution_identification`-The instructed financial institution identifier does not match the financial institution that owns the account that is the subject to the account format validation. *`INCT_inconsistent_country`-The instructed country code does not match the country of the payment information that is subject to validation. *`CFIN_consistent_financial_institution_identification`-The instructed financial institution matches the financial institution that uses the account format of the instructed account. *`CCTY_consistent_country`-The instructed country code matches the country of the payment information that is subject to validation. *`AINP_account_data_collection_in_progress`-SWIFT account format data coverage index indicates that the account data collection process is in progres ( below 90% level of completion) *`ICCH_check_not_applied`-The individual payment validation check has no been applied for the instructed context. Other individual payment validation checks are more relevant and will be applied instead. *`UCSM_unrecognized_clearing_system_member_identification`-The instructed financial institution identifier subject to financial institution identity validation has not been found in the SWIFT directory for the instructed payment context. *`IBIC_invalid_bic`-The instructed financial institution identifier subject to financial institution identity validation is not a valid BIC for the instructed payment context. *`ICTY_invalid_country`-Instructed country code is not a valid country code on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code) *`MFIN_missing_financial_institution_identifier`-Financial Institution Identifier is missing from the payment context in order for the validation of the instructed payment information to be performed.

const (
	VIBN_VALID_IBAN_AccountFormatValidationReason1Code                                         AccountFormatValidationReason1Code = "VIBN_valid_iban"
	VDOM_VALID_DOMESTIC_BANK_SPECIFIC_AccountFormatValidationReason1Code                       AccountFormatValidationReason1Code = "VDOM_valid_domestic_bank_specific"
	VBBN_VALID_BBAN_AccountFormatValidationReason1Code                                         AccountFormatValidationReason1Code = "VBBN_valid_bban"
	MCTY_MISSING_COUNTRY_CODE_AccountFormatValidationReason1Code                               AccountFormatValidationReason1Code = "MCTY_missing_country_code"
	IIBN_INVALID_IBAN_AccountFormatValidationReason1Code                                       AccountFormatValidationReason1Code = "IIBN_invalid_iban"
	IDOM_INVALID_DOMESTIC_BANK_SPECIFIC_AccountFormatValidationReason1Code                     AccountFormatValidationReason1Code = "IDOM_invalid_domestic_bank_specific"
	IBBN_INVALID_BBAN_AccountFormatValidationReason1Code                                       AccountFormatValidationReason1Code = "IBBN_invalid_bban"
	IFIN_INCONSISTENT_FINANCIAL_INSTITUTION_IDENTIFICATION_AccountFormatValidationReason1Code  AccountFormatValidationReason1Code = "IFIN_inconsistent_financial_institution_identification"
	INCT_INCONSISTENT_COUNTRY_AccountFormatValidationReason1Code                               AccountFormatValidationReason1Code = "INCT_inconsistent_country"
	CFIN_CONSISTENT_FINANCIAL_INSTITUTION_IDENTIFICATION_AccountFormatValidationReason1Code    AccountFormatValidationReason1Code = "CFIN_consistent_financial_institution_identification"
	CCTY_CONSISTENT_COUNTRY_AccountFormatValidationReason1Code                                 AccountFormatValidationReason1Code = "CCTY_consistent_country"
	AINP_ACCOUNT_DATA_COLLECTION_IN_PROGRESS_AccountFormatValidationReason1Code                AccountFormatValidationReason1Code = "AINP_account_data_collection_in_progress"
	ICCH_CHECK_NOT_APPLIED_AccountFormatValidationReason1Code                                  AccountFormatValidationReason1Code = "ICCH_check_not_applied"
	UCSM_UNRECOGNIZED_CLEARING_SYSTEM_MEMBER_IDENTIFICATION_AccountFormatValidationReason1Code AccountFormatValidationReason1Code = "UCSM_unrecognized_clearing_system_member_identification"
	IBIC_INVALID_BIC_AccountFormatValidationReason1Code                                        AccountFormatValidationReason1Code = "IBIC_invalid_bic"
	ICTY_INVALID_COUNTRY_AccountFormatValidationReason1Code                                    AccountFormatValidationReason1Code = "ICTY_invalid_country"
	MFIN_MISSING_FINANCIAL_INSTITUTION_IDENTIFIER_AccountFormatValidationReason1Code           AccountFormatValidationReason1Code = "MFIN_missing_financial_institution_identifier"
)

List of AccountFormatValidationReason1Code

type AccountFormatValidationStatus1 ¶

type AccountFormatValidationStatus1 struct {
	AccountIdentification              *AccountIdentification4Choice         `json:"account_identification,omitempty"`
	CountryCode                        string                                `json:"country_code,omitempty"`
	FinancialInstitutionIdentification *FinancialInstitutionIdentification24 `json:"financial_institution_identification,omitempty"`
	Status                             *AccountFormatValidationStatus1Code   `json:"status"`
	Reason                             []AccountFormatValidationReason1Code  `json:"reason"`
	ValidationCheck                    []AccountFormatValidationCheck1       `json:"validation_check"`
}

This represents the response details that the Account Format validation service will provide to the service consumer.

type AccountFormatValidationStatus1Code ¶

type AccountFormatValidationStatus1Code string

AccountFormatValidationStatus1Code : The list of unique status identifiers for the Account Format Validation service. *`CVAL_valid_with_comments`-The payment information instructed for validation is valid but the instructed payment context can be further improved. *`NAVL_not_available`-The validation of the instructed payment information is not available in the instructed payment context, typically due to payment data collection process being in progress and insufficient data coverage. *`IVAL_invalid`-The payment information instructed for validation it is not valid in the instructed payment context. *`CNPR_could_not_perform`-The validation of the instructed payment information could not be performed in the instructed payment context typically due to missing payment context information. *`FVAL_valid`-The payment information instructed for validation it is valid in the instructed payment context. *`NOAP_not_applicable`-The validation of the instructed payment information has not been applied because didn't make sense for the given context.

const (
	CVAL_VALID_WITH_COMMENTS_AccountFormatValidationStatus1Code AccountFormatValidationStatus1Code = "CVAL_valid_with_comments"
	NAVL_NOT_AVAILABLE_AccountFormatValidationStatus1Code       AccountFormatValidationStatus1Code = "NAVL_not_available"
	IVAL_INVALID_AccountFormatValidationStatus1Code             AccountFormatValidationStatus1Code = "IVAL_invalid"
	CNPR_COULD_NOT_PERFORM_AccountFormatValidationStatus1Code   AccountFormatValidationStatus1Code = "CNPR_could_not_perform"
	FVAL_VALID_AccountFormatValidationStatus1Code               AccountFormatValidationStatus1Code = "FVAL_valid"
	NOAP_NOT_APPLICABLE_AccountFormatValidationStatus1Code      AccountFormatValidationStatus1Code = "NOAP_not_applicable"
)

List of AccountFormatValidationStatus1Code

type AccountIdentification4Choice ¶

type AccountIdentification4Choice struct {
	Iban  string                         `json:"iban,omitempty"`
	Other *GenericAccountIdentification1 `json:"other,omitempty"`
}

Specifies the unique identification of an account as assigned by the account servicer.

type AccountSchemeName1Choice ¶

type AccountSchemeName1Choice struct {
	Code        string `json:"code,omitempty"`
	Proprietary string `json:"proprietary,omitempty"`
}

Sets of elements to identify a name of the identification scheme.

type AccountType2Code ¶

type AccountType2Code string

AccountType2Code : *`PRIV`-This account is registered for private usage *`BUSI`-This account is registered for business usage.

const (
	PRIV_AccountType2Code AccountType2Code = "PRIV"
	BUSI_AccountType2Code AccountType2Code = "BUSI"
)

List of AccountType2Code

type AccountValidationCheckContext1Code ¶

type AccountValidationCheckContext1Code string

AccountValidationCheckContext1Code : *`BENR`-Request is in the scope of a beneficiary registration validation. *`PAYM`-Request is in the scope of the payment initiation. *`RFPP`-Request is in the scope of a request for a payment initiation.

const (
	BENR_AccountValidationCheckContext1Code AccountValidationCheckContext1Code = "BENR"
	PAYM_AccountValidationCheckContext1Code AccountValidationCheckContext1Code = "PAYM"
	RFPP_AccountValidationCheckContext1Code AccountValidationCheckContext1Code = "RFPP"
)

List of AccountValidationCheckContext1Code

type AccountValidationResponse1Code ¶

type AccountValidationResponse1Code string

AccountValidationResponse1Code : *`MTCH`-Matched validation check. *`NMTC`-Unmatched validation check. *`NOAP`-Validation check is not applicable. *`NOTC`-Validation check has not been carried out.

const (
	MTCH_AccountValidationResponse1Code AccountValidationResponse1Code = "MTCH"
	NMTC_AccountValidationResponse1Code AccountValidationResponse1Code = "NMTC"
	NOAP_AccountValidationResponse1Code AccountValidationResponse1Code = "NOAP"
	NOTC_AccountValidationResponse1Code AccountValidationResponse1Code = "NOTC"
)

List of AccountValidationResponse1Code

type AccountValidationResponse2Code ¶

type AccountValidationResponse2Code string

AccountValidationResponse2Code : *`MTCH`-Matched creditor account. *`NMTC`-No match for creditor account.

const (
	MTCH_AccountValidationResponse2Code AccountValidationResponse2Code = "MTCH"
	NMTC_AccountValidationResponse2Code AccountValidationResponse2Code = "NMTC"
)

List of AccountValidationResponse2Code

type AccountValidationResponse3Code ¶

type AccountValidationResponse3Code string

AccountValidationResponse3Code : *`FAIL`-The account identification provided was not successfully validated to an account that can receive funds. *`INCO`-The account identification provided was successfully validated to an account that can receive funds, however, some additional account checks will be performed at transaction time. *`PASS`-The account identification was successfully validated to an account that can receive funds. *`WARN`-The account identification was not successfully validated to an account that can receive funds, however, the responder lacks some information to provide a definite answer.

const (
	FAIL_AccountValidationResponse3Code AccountValidationResponse3Code = "FAIL"
	INCO_AccountValidationResponse3Code AccountValidationResponse3Code = "INCO"
	PASS_AccountValidationResponse3Code AccountValidationResponse3Code = "PASS"
	WARN_AccountValidationResponse3Code AccountValidationResponse3Code = "WARN"
)

List of AccountValidationResponse3Code

type AccountValidationResponse4Code ¶

type AccountValidationResponse4Code string

AccountValidationResponse4Code : *`MTCH`-Matched validation check. *`MBAM`-The beneficiary bank has determined that the provided creditor name closely resembles the account holder name. However, it is not an exact match. The beneficiary bank can choose to disclose the actual account holder name for the payment sender to verify or update its records. *`NMTC`-Unmatched validation check. *`NOAP`-Validation check is not applicable. *`NOTC`-Validation check has not been carried out.

const (
	MTCH_AccountValidationResponse4Code AccountValidationResponse4Code = "MTCH"
	MBAM_AccountValidationResponse4Code AccountValidationResponse4Code = "MBAM"
	NMTC_AccountValidationResponse4Code AccountValidationResponse4Code = "NMTC"
	NOAP_AccountValidationResponse4Code AccountValidationResponse4Code = "NOAP"
	NOTC_AccountValidationResponse4Code AccountValidationResponse4Code = "NOTC"
)

List of AccountValidationResponse4Code

type AccountValidationSource1Code ¶

type AccountValidationSource1Code string

AccountValidationSource1Code : * `ACSV`-The responder is the financial institution servicing this account, basing its decision on its account holding system. *`HIST`-The responder is SWIFT, basing its decision on SWIFT past transations (successful or failed) made to this account. *`OBSP`-The responder is a third-party system to which the account servicer delegated implementation of the API, basing its decision on data fed by the account servicer. The data feed frequency can vary from one implementation to another.

const (
	ACSV_AccountValidationSource1Code AccountValidationSource1Code = "ACSV"
	HIST_AccountValidationSource1Code AccountValidationSource1Code = "HIST"
	OBSP_AccountValidationSource1Code AccountValidationSource1Code = "OBSP"
)

List of AccountValidationSource1Code

type AccountVerificationRequest ¶

type AccountVerificationRequest struct {
	CorrelationIdentifier              string                                `json:"correlation_identifier,omitempty"`
	Context                            *AccountValidationCheckContext1Code   `json:"context"`
	Uetr                               string                                `json:"uetr,omitempty"`
	CreditorAccount                    string                                `json:"creditor_account"`
	CreditorName                       string                                `json:"creditor_name"`
	CreditorAddress                    *PostalAddress24                      `json:"creditor_address,omitempty"`
	CreditorOrganisationIdentification *OrganisationIdentification8          `json:"creditor_organisation_identification,omitempty"`
	CreditorAgent                      *FinancialInstitutionIdentification20 `json:"creditor_agent,omitempty"`
	CreditorAgentBranchIdentification  string                                `json:"creditor_agent_branch_identification,omitempty"`
}

Beneficiary account verification request.

type AccountVerificationResponse1 ¶

type AccountVerificationResponse1 struct {
	CorrelationIdentifier string                    `json:"correlation_identifier,omitempty"`
	Response              *ValidationCheckResponse2 `json:"response"`
}

Get Account Details Response

type AddressType2Code ¶

type AddressType2Code string

AddressType2Code : Specifies the type of address. *`ADDR`-Address is the complete postal address. *`PBOX`-Address is a postal office (PO) box. *`HOME`-Address is the home address. *`BIZZ`-Address is the business address. *`MLTO`-Address is the address to which mail is sent. *`DLVY`-Address is the address to which delivery is to take place.

const (
	ADDR_AddressType2Code AddressType2Code = "ADDR"
	PBOX_AddressType2Code AddressType2Code = "PBOX"
	HOME_AddressType2Code AddressType2Code = "HOME"
	BIZZ_AddressType2Code AddressType2Code = "BIZZ"
	MLTO_AddressType2Code AddressType2Code = "MLTO"
	DLVY_AddressType2Code AddressType2Code = "DLVY"
)

List of AddressType2Code

type AddressType3Choice ¶

type AddressType3Choice struct {
	Code        *AddressType2Code        `json:"code,omitempty"`
	Proprietary *GenericIdentification30 `json:"proprietary,omitempty"`
}

Choice of formats for the type of address.

type BasicAuth ¶

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

BasicAuth provides basic http authentication to a request passed via context using ContextBasicAuth

type BranchAndFinancialInstitutionIdentification8 ¶

type BranchAndFinancialInstitutionIdentification8 struct {
	FinancialInstitutionIdentification *FinancialInstitutionIdentification24 `json:"financial_institution_identification"`
	BranchIdentification               *BranchData3                          `json:"branch_identification,omitempty"`
	ContactData                        *Contact10                            `json:"contact_data,omitempty"`
	ConnectivityData                   *GenericConnectivityChoice            `json:"connectivity_data,omitempty"`
	OfficeType                         string                                `json:"office_type,omitempty"`
}

Unique and unambiguous identification of a financial institution or a branch of a financial institution.

type BranchData3 ¶

type BranchData3 struct {
	Identification string           `json:"identification,omitempty"`
	Lei            string           `json:"lei,omitempty"`
	Name           string           `json:"name,omitempty"`
	PostalAddress  *PostalAddress24 `json:"postal_address,omitempty"`
}

Information that locates and identifies a specific branch of a financial institution.

type CategoryPaymentValidationReason1Code ¶

type CategoryPaymentValidationReason1Code string

CategoryPaymentValidationReason1Code : The list of unique identifiers which describe the reasons for Category Purpose Code validation status. *`UPCP_unrecognized_category_purpose`-The instructed payment category purpose subject to validation could not be found in the payment category purpose data available in the SWIFT repository for the instructed payment context. *`VPCP_valid_category_purpose`-The instructed payment category purpose subject has been successfully validated for the instructed payment context. *`ICTY_invalid_country`-Instructed country code is not a valid country code on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code) *`CINP_no_category_purpose_data_available`-No category purpose data available in the SWFIFT repository for the instructed context. This may relate to the country specific requirements not mandating category purpose codes for the instructed context.

const (
	UPCP_UNRECOGNIZED_CATEGORY_PURPOSE_CategoryPaymentValidationReason1Code      CategoryPaymentValidationReason1Code = "UPCP_unrecognized_category_purpose"
	VPCP_VALID_CATEGORY_PURPOSE_CategoryPaymentValidationReason1Code             CategoryPaymentValidationReason1Code = "VPCP_valid_category_purpose"
	ICTY_INVALID_COUNTRY_CategoryPaymentValidationReason1Code                    CategoryPaymentValidationReason1Code = "ICTY_invalid_country"
	CINP_NO_CATEGORY_PURPOSE_DATA_AVAILABLE_CategoryPaymentValidationReason1Code CategoryPaymentValidationReason1Code = "CINP_no_category_purpose_data_available"
)

List of CategoryPaymentValidationReason1Code

type CategoryPurposeValidation1 ¶

type CategoryPurposeValidation1 struct {
	CategoryPurposeCode string `json:"category_purpose_code"`
	CountryCode         string `json:"country_code"`
}

This represents the details of Category Purpose Validation service request.

type CategoryPurposeValidationStatus1 ¶

type CategoryPurposeValidationStatus1 struct {
	Status              *CategoryPurposeValidationStatus1Code  `json:"status"`
	Reason              []CategoryPaymentValidationReason1Code `json:"reason"`
	CategoryPurposeCode *GenericCodeIdentification1            `json:"category_purpose_code,omitempty"`
	CountryCode         string                                 `json:"country_code,omitempty"`
}

This represents the response details that the Category Purpose Validation service will provide to the service consumer.

type CategoryPurposeValidationStatus1Code ¶

type CategoryPurposeValidationStatus1Code string

CategoryPurposeValidationStatus1Code : The list of unique identifiers which describe the status of the Category Purpose validation. *`FVAL_valid`-The payment information instructed for validation it is valid in the instructed payment context. *`UNRE_unrecognised`-The payment information instructed for validation has not been found in the SWIFT repository for the instructed payment context. *`NAVL_not_available`-The validation of the instructed payment information is not available in the instructed payment context, typically due to payment data collection process being in progress and insufficient data coverage. *`CNPR_could_not_perform`-The validation of the instructed payment information could not be performed in the instructed payment context typically due to missing payment context information.

const (
	FVAL_VALID_CategoryPurposeValidationStatus1Code             CategoryPurposeValidationStatus1Code = "FVAL_valid"
	UNRE_UNRECOGNISED_CategoryPurposeValidationStatus1Code      CategoryPurposeValidationStatus1Code = "UNRE_unrecognised"
	NAVL_NOT_AVAILABLE_CategoryPurposeValidationStatus1Code     CategoryPurposeValidationStatus1Code = "NAVL_not_available"
	CNPR_COULD_NOT_PERFORM_CategoryPurposeValidationStatus1Code CategoryPurposeValidationStatus1Code = "CNPR_could_not_perform"
)

List of CategoryPurposeValidationStatus1Code

type ClearingSystemIdentification2Choice ¶

type ClearingSystemIdentification2Choice struct {
	Code        string `json:"code,omitempty"`
	Proprietary string `json:"proprietary,omitempty"`
}

Choice of a clearing system identifier.

type ClearingSystemMemberIdentification2 ¶

type ClearingSystemMemberIdentification2 struct {
	ClearingSystemIdentification *ClearingSystemIdentification2Choice `json:"clearing_system_identification,omitempty"`
	MemberIdentification         string                               `json:"member_identification"`
}

Unique identification, as assigned by a clearing system, to unambiguously identify a member of the clearing system.

type Configuration ¶

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
}

func NewConfiguration ¶

func NewConfiguration() *Configuration

func (*Configuration) AddDefaultHeader ¶

func (c *Configuration) AddDefaultHeader(key string, value string)

type Contact10 ¶

type Contact10 struct {
	PhoneNumber  string `json:"phone_number,omitempty"`
	MobileNumber string `json:"mobile_number,omitempty"`
	FaxNumber    string `json:"fax_number,omitempty"`
	EmailAddress string `json:"email_address,omitempty"`
	Url          string `json:"url,omitempty"`
}

Specifies the details of a contact person.

type ErrorMessage ¶

type ErrorMessage struct {
	Severity    string `json:"severity"`
	Code        string `json:"code"`
	Text        string `json:"text"`
	UserMessage string `json:"user_message,omitempty"`
	MoreInfo    string `json:"more_info,omitempty"`
}

type FinancialInstitutionIdentification20 ¶

type FinancialInstitutionIdentification20 struct {
	Bicfi                              string                               `json:"bicfi,omitempty"`
	ClearingSystemMemberIdentification *ClearingSystemMemberIdentification2 `json:"clearing_system_member_identification,omitempty"`
}

Set of elements used to identify a financial institution.

type FinancialInstitutionIdentification24 ¶

type FinancialInstitutionIdentification24 struct {
	Bicfi                              string                               `json:"bicfi,omitempty"`
	ClearingSystemMemberIdentification *ClearingSystemMemberIdentification2 `json:"clearing_system_member_identification,omitempty"`
	Name                               string                               `json:"name,omitempty"`
	PostalAddress                      *PostalAddress24                     `json:"postal_address,omitempty"`
}

Specifies the details to identify a financial institution.

type FinancialInstitutionIdentityValidation1 ¶

type FinancialInstitutionIdentityValidation1 struct {
	FinancialInstitutionIdentification string `json:"financial_institution_identification"`
	CountryCode                        string `json:"country_code,omitempty"`
}

This represents the details of Account Format Validation service request.

type FinancialInstitutionIdentityValidationReason1Code ¶

type FinancialInstitutionIdentityValidationReason1Code string

FinancialInstitutionIdentityValidationReason1Code : The list of unique identifiers which describe the reasons for Financial Institution Identity validation status. *`VBIC_valid_bic`-The instructed financial institution identifier subject to financial institution identity validation is a valid BIC for the instructed payment context. *`IBIC_invalid_bic`-The instructed financial institution identifier subject to financial institution identity validation is not a valid BIC for the instructed payment context. *`INCT_inconsistent_country`-The instructed country code does not match the country of the payment information that is subject to validation. *`CCTY_consistent_country`-The instructed country code matches the country of the payment information that is subject to validation. *`VCSM_valid_clearing_system_member_identification`-The instructed financial institution identifier subject to financial institution identity validation is a valid clearing system member identifier for the instructed payment context. *`UCSM_unrecognized_clearing_system_member_identification`-The instructed financial institution identifier subject to financial institution identity validation has not been found in the SWIFT directory for the instructed payment context. *`ICTY_invalid_country`-Instructed country code is not a valid country code on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code) *`MCTY_missing_country_code`-Country code is missing from the payment context in order for the validation of the instructed payment information to be performed.

const (
	VBIC_VALID_BIC_FinancialInstitutionIdentityValidationReason1Code                                          FinancialInstitutionIdentityValidationReason1Code = "VBIC_valid_bic"
	IBIC_INVALID_BIC_FinancialInstitutionIdentityValidationReason1Code                                        FinancialInstitutionIdentityValidationReason1Code = "IBIC_invalid_bic"
	INCT_INCONSISTENT_COUNTRY_FinancialInstitutionIdentityValidationReason1Code                               FinancialInstitutionIdentityValidationReason1Code = "INCT_inconsistent_country"
	CCTY_CONSISTENT_COUNTRY_FinancialInstitutionIdentityValidationReason1Code                                 FinancialInstitutionIdentityValidationReason1Code = "CCTY_consistent_country"
	VCSM_VALID_CLEARING_SYSTEM_MEMBER_IDENTIFICATION_FinancialInstitutionIdentityValidationReason1Code        FinancialInstitutionIdentityValidationReason1Code = "VCSM_valid_clearing_system_member_identification"
	UCSM_UNRECOGNIZED_CLEARING_SYSTEM_MEMBER_IDENTIFICATION_FinancialInstitutionIdentityValidationReason1Code FinancialInstitutionIdentityValidationReason1Code = "UCSM_unrecognized_clearing_system_member_identification"
	ICTY_INVALID_COUNTRY_FinancialInstitutionIdentityValidationReason1Code                                    FinancialInstitutionIdentityValidationReason1Code = "ICTY_invalid_country"
	MCTY_MISSING_COUNTRY_CODE_FinancialInstitutionIdentityValidationReason1Code                               FinancialInstitutionIdentityValidationReason1Code = "MCTY_missing_country_code"
)

List of FinancialInstitutionIdentityValidationReason1Code

type FinancialInstitutionIdentityValidationStatus1 ¶

type FinancialInstitutionIdentityValidationStatus1 struct {
	CountryCode                        string                                              `json:"country_code,omitempty"`
	FinancialInstitutionIdentification *BranchAndFinancialInstitutionIdentification8       `json:"financial_institution_identification,omitempty"`
	Status                             *FinancialInstitutionIdentityValidationStatus1Code  `json:"status"`
	Reason                             []FinancialInstitutionIdentityValidationReason1Code `json:"reason"`
}

This represents the response details that the Financial Institution Identity validation service will provide to the service consumer.

type FinancialInstitutionIdentityValidationStatus1Code ¶

type FinancialInstitutionIdentityValidationStatus1Code string

FinancialInstitutionIdentityValidationStatus1Code : The list of unique identifiers which describe the status of the Financial Institution Identity validation. *`NAVL_not_available`-The validation of the instructed payment information is not available in the instructed payment context, typically due to payment data collection process being in progress and insufficient data coverage. *`FVAL_valid`-The payment information instructed for validation it is valid in the instructed payment context. *`CVAL_valid_with_comments`-The payment information instructed for validation is valid but the instructed payment context can be further improved. *`IVAL_invalid`-The payment information instructed for validation it is not valid in the instructed payment context. *`CNPR_could_not_perform`-The validation of the instructed payment information could not be performed in the instructed payment context typically due to missing payment context information. *`UNRE_unrecognised`-The payment information instructed for validation has not been found in the SWIFT repository for the instructed payment context.

const (
	NAVL_NOT_AVAILABLE_FinancialInstitutionIdentityValidationStatus1Code       FinancialInstitutionIdentityValidationStatus1Code = "NAVL_not_available"
	FVAL_VALID_FinancialInstitutionIdentityValidationStatus1Code               FinancialInstitutionIdentityValidationStatus1Code = "FVAL_valid"
	CVAL_VALID_WITH_COMMENTS_FinancialInstitutionIdentityValidationStatus1Code FinancialInstitutionIdentityValidationStatus1Code = "CVAL_valid_with_comments"
	IVAL_INVALID_FinancialInstitutionIdentityValidationStatus1Code             FinancialInstitutionIdentityValidationStatus1Code = "IVAL_invalid"
	CNPR_COULD_NOT_PERFORM_FinancialInstitutionIdentityValidationStatus1Code   FinancialInstitutionIdentityValidationStatus1Code = "CNPR_could_not_perform"
	UNRE_UNRECOGNISED_FinancialInstitutionIdentityValidationStatus1Code        FinancialInstitutionIdentityValidationStatus1Code = "UNRE_unrecognised"
)

List of FinancialInstitutionIdentityValidationStatus1Code

type GenericAccountIdentification1 ¶

type GenericAccountIdentification1 struct {
	Identification string                    `json:"identification"`
	SchemeName     *AccountSchemeName1Choice `json:"scheme_name,omitempty"`
	Issuer         string                    `json:"issuer,omitempty"`
}

Information related to a generic account identification.

type GenericCodeIdentification1 ¶

type GenericCodeIdentification1 struct {
	Id                       string `json:"id"`
	DescriptionEnglish       string `json:"description_english,omitempty"`
	NameEnglish              string `json:"name_english"`
	NameLocalLanguage        string `json:"name_local_language,omitempty"`
	DescriptionLocalLanguage string `json:"description_local_language,omitempty"`
}

Information for the identification of a code use in the payment validation.

type GenericConnectivityChoice ¶

type GenericConnectivityChoice struct {
	Fin      bool `json:"fin"`
	Interact bool `json:"interact"`
	FileAct  bool `json:"file_act"`
}

Information for the identification of a SWIFT connectivity

type GenericIdentification30 ¶

type GenericIdentification30 struct {
	Identification string `json:"identification"`
	Issuer         string `json:"issuer"`
	SchemeName     string `json:"scheme_name,omitempty"`
}

Information related to an identification, for example, party identification or account identification.

type GenericOrganisationIdentification1 ¶

type GenericOrganisationIdentification1 struct {
	Identification string                                       `json:"identification"`
	SchemeName     *OrganisationIdentificationSchemeName1Choice `json:"scheme_name,omitempty"`
	Issuer         string                                       `json:"issuer,omitempty"`
}

Information related to an identification of an organisation.

type GenericSwaggerError ¶

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

GenericSwaggerError Provides access to the body, error and model on returned errors.

func (GenericSwaggerError) Body ¶

func (e GenericSwaggerError) Body() []byte

Body returns the raw bytes of the response

func (GenericSwaggerError) Error ¶

func (e GenericSwaggerError) Error() string

Error returns non-empty string if there was an error.

func (GenericSwaggerError) Model ¶

func (e GenericSwaggerError) Model() interface{}

Model returns the unpacked model of the error

type OneOfAccountIdentification4Choice ¶

type OneOfAccountIdentification4Choice struct {
}

type OneOfAccountSchemeName1Choice ¶

type OneOfAccountSchemeName1Choice struct {
}

type OneOfAddressType3Choice ¶

type OneOfAddressType3Choice struct {
}

type OneOfClearingSystemIdentification2Choice ¶

type OneOfClearingSystemIdentification2Choice struct {
}

type OneOfOrganisationIdentificationSchemeName1Choice ¶

type OneOfOrganisationIdentificationSchemeName1Choice struct {
}

type OrganisationIdentification8 ¶

type OrganisationIdentification8 struct {
	AnyBic string                               `json:"any_bic,omitempty"`
	Other  []GenericOrganisationIdentification1 `json:"other,omitempty"`
}

Unique and unambiguous way to identify an organisation.

type OrganisationIdentificationSchemeName1Choice ¶

type OrganisationIdentificationSchemeName1Choice struct {
	Code        string `json:"code,omitempty"`
	Proprietary string `json:"proprietary,omitempty"`
}

Sets of elements to identify a name of the organisation identification scheme.

type PaymentPreValidationApiGetAccountFormatValidationStatusOpts ¶

type PaymentPreValidationApiGetAccountFormatValidationStatusOpts struct {
	Body optional.Interface
}

type PaymentPreValidationApiGetCategoryPurposeValidationStatusOpts ¶

type PaymentPreValidationApiGetCategoryPurposeValidationStatusOpts struct {
	Body optional.Interface
}

type PaymentPreValidationApiGetFinancialInstitutionIdentityValidationStatusOpts ¶

type PaymentPreValidationApiGetFinancialInstitutionIdentityValidationStatusOpts struct {
	Body optional.Interface
}

type PaymentPreValidationApiGetPaymentPurposeCodeValidationStatusOpts ¶

type PaymentPreValidationApiGetPaymentPurposeCodeValidationStatusOpts struct {
	Body optional.Interface
}

type PaymentPreValidationApiGetPaymentPurposeValidationStatusOpts ¶

type PaymentPreValidationApiGetPaymentPurposeValidationStatusOpts struct {
	Body optional.Interface
}

type PaymentPreValidationApiService ¶

type PaymentPreValidationApiService service

func (*PaymentPreValidationApiService) GetAccountFormatValidationStatus ¶

func (a *PaymentPreValidationApiService) GetAccountFormatValidationStatus(ctx context.Context, localVarOptionals *PaymentPreValidationApiGetAccountFormatValidationStatusOpts) (AccountFormatValidationStatus1, *http.Response, error)

func (*PaymentPreValidationApiService) GetCategoryPurposeValidationStatus ¶

func (a *PaymentPreValidationApiService) GetCategoryPurposeValidationStatus(ctx context.Context, localVarOptionals *PaymentPreValidationApiGetCategoryPurposeValidationStatusOpts) (CategoryPurposeValidationStatus1, *http.Response, error)

func (*PaymentPreValidationApiService) GetFinancialInstitutionIdentityValidationStatus ¶

func (a *PaymentPreValidationApiService) GetFinancialInstitutionIdentityValidationStatus(ctx context.Context, localVarOptionals *PaymentPreValidationApiGetFinancialInstitutionIdentityValidationStatusOpts) (FinancialInstitutionIdentityValidationStatus1, *http.Response, error)

func (*PaymentPreValidationApiService) GetPaymentPurposeCodeValidationStatus ¶

func (a *PaymentPreValidationApiService) GetPaymentPurposeCodeValidationStatus(ctx context.Context, localVarOptionals *PaymentPreValidationApiGetPaymentPurposeCodeValidationStatusOpts) (PaymentPurposeCodeValidationStatus1, *http.Response, error)

func (*PaymentPreValidationApiService) GetPaymentPurposeValidationStatus ¶

func (a *PaymentPreValidationApiService) GetPaymentPurposeValidationStatus(ctx context.Context, localVarOptionals *PaymentPreValidationApiGetPaymentPurposeValidationStatusOpts) (PaymentPurposeValidationStatus1, *http.Response, error)

func (*PaymentPreValidationApiService) VerifyAccount ¶

func (a *PaymentPreValidationApiService) VerifyAccount(ctx context.Context, xBic string, localVarOptionals *PaymentPreValidationApiVerifyAccountOpts) (AccountVerificationResponse1, *http.Response, error)

type PaymentPreValidationApiVerifyAccountOpts ¶

type PaymentPreValidationApiVerifyAccountOpts struct {
	Body             optional.Interface
	XRequestID       optional.Interface
	XRequestDateTime optional.Time
}

type PaymentPurposeCodeValidation1 ¶

type PaymentPurposeCodeValidation1 struct {
	PurposeCode string `json:"purpose_code"`
	CountryCode string `json:"country_code"`
}

This represents the details of Payment Purpose Code Validation service request.

type PaymentPurposeCodeValidationReason1Code ¶

type PaymentPurposeCodeValidationReason1Code string

PaymentPurposeCodeValidationReason1Code : The list of unique identifiers which describe the reasons for Payment Purpose Code validation status. *`UPPC_unrecognized_purpose_code`-The instructed payment purpose code subject to validation could not be found in the purpose code data available in the SWIFT repository for the instructed payment context. *`VPPC_valid_purpose_code`-The instructed payment purpose code has been successfully validated against the purpose code list(s) available in the SWIFT repository for the instructed payment context. *`ICTY_invalid_country`-Instructed country code is not a valid country code on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code) *`PINP_no_purpose_code_data_available`-No purpose code data available in the SWFIFT repository for the instructed context. This may relate to the country specific requirements not mandating purpose codes for the instructed context.

const (
	UPPC_UNRECOGNIZED_PURPOSE_CODE_PaymentPurposeCodeValidationReason1Code      PaymentPurposeCodeValidationReason1Code = "UPPC_unrecognized_purpose_code"
	VPPC_VALID_PURPOSE_CODE_PaymentPurposeCodeValidationReason1Code             PaymentPurposeCodeValidationReason1Code = "VPPC_valid_purpose_code"
	ICTY_INVALID_COUNTRY_PaymentPurposeCodeValidationReason1Code                PaymentPurposeCodeValidationReason1Code = "ICTY_invalid_country"
	PINP_NO_PURPOSE_CODE_DATA_AVAILABLE_PaymentPurposeCodeValidationReason1Code PaymentPurposeCodeValidationReason1Code = "PINP_no_purpose_code_data_available"
)

List of PaymentPurposeCodeValidationReason1Code

type PaymentPurposeCodeValidationStatus1 ¶

type PaymentPurposeCodeValidationStatus1 struct {
	Status      *PaymentPurposeCodeValidationStatus1Code  `json:"status"`
	Reason      []PaymentPurposeCodeValidationReason1Code `json:"reason"`
	PurposeCode *GenericCodeIdentification1               `json:"purpose_code,omitempty"`
	CountryCode string                                    `json:"country_code,omitempty"`
}

This represents the response details that the Payment Purpose Code validation service will provide to the service consumer.

type PaymentPurposeCodeValidationStatus1Code ¶

type PaymentPurposeCodeValidationStatus1Code string

PaymentPurposeCodeValidationStatus1Code : The list of unique status identifiers for the Payment Purpose Code Validation service. *`FVAL_valid`-The payment information instructed for validation it is valid in the instructed payment context. *`UNRE_unrecognised`-The payment information instructed for validation has not been found in the SWIFT repository for the instructed payment context. *`CNPR_could_not_perform`-The validation of the instructed payment information could not be performed in the instructed payment context typically due to missing payment context information. *`NAVL_not_available`-The validation of the instructed payment information is not available in the instructed payment context, typically due to payment data collection process being in progress and insufficient data coverage.

const (
	FVAL_VALID_PaymentPurposeCodeValidationStatus1Code             PaymentPurposeCodeValidationStatus1Code = "FVAL_valid"
	UNRE_UNRECOGNISED_PaymentPurposeCodeValidationStatus1Code      PaymentPurposeCodeValidationStatus1Code = "UNRE_unrecognised"
	CNPR_COULD_NOT_PERFORM_PaymentPurposeCodeValidationStatus1Code PaymentPurposeCodeValidationStatus1Code = "CNPR_could_not_perform"
	NAVL_NOT_AVAILABLE_PaymentPurposeCodeValidationStatus1Code     PaymentPurposeCodeValidationStatus1Code = "NAVL_not_available"
)

List of PaymentPurposeCodeValidationStatus1Code

type PaymentPurposeValidation1 ¶

type PaymentPurposeValidation1 struct {
	PurposeCode                  string `json:"purpose_code,omitempty"`
	CountryCode                  string `json:"country_code"`
	PurposeDescription           string `json:"purpose_description,omitempty"`
	ClearingSystemIdentification string `json:"clearing_system_identification,omitempty"`
	CurrencyCode                 string `json:"currency_code,omitempty"`
}

This represents the details of Payment Purpose Validation service request.

type PaymentPurposeValidationCheck1 ¶

type PaymentPurposeValidationCheck1 struct {
	Code                        *PaymentPurposeValidationCheckCode    `json:"code"`
	Description                 string                                `json:"description,omitempty"`
	Status                      *PaymentPurposeValidationStatus1Code  `json:"status"`
	Reason                      []PaymentPurposeValidationReason1Code `json:"reason"`
	Severity                    *PaymentValidationSeverity1           `json:"severity"`
	ValidatedPaymentInformation []PaymentValidationInputParameter1    `json:"validated_payment_information,omitempty"`
}

Details the outcome of each individual payment purpose validation check.

type PaymentPurposeValidationCheckCode ¶

type PaymentPurposeValidationCheckCode string

PaymentPurposeValidationCheckCode : The list of unique identifiers for the individual payment purpose validation checks. *`PCCT_purpose_and_country`-The unique identifier of the individual payment purpose validation check that validates the instructed payment purpose information against the payment purpose requirements available in the SWIFT repository for the instructed creditor country. *`PCCC_purpose_and_country_and_currency`-The unique identifier of the individual payment purpose validation check that validates the instructed payment purpose information against the payment purpose requirements available in the SWIFT repository for the instructed creditor country and creditor account currency. *`PCCP_purpose_and_country_and_currency_and_clearing_system`-The unique identifier of the individual payment purpose validation check that validates the instructed payment purpose information against the payment purpose requirements available in the SWIFT repository for the instructed creditor country, creditor account currency and local clearing system. *`PCCS_purpose_and_country_and_clearing_system`-The unique identifier of the individual payment purpose validation check that validates the instructed payment purpose information against the payment purpose requirements available in the SWIFT repository for the instructed creditor country and the instructed clearing system.

const (
	PCCT_PURPOSE_AND_COUNTRY_PaymentPurposeValidationCheckCode                                  PaymentPurposeValidationCheckCode = "PCCT_purpose_and_country"
	PCCC_PURPOSE_AND_COUNTRY_AND_CURRENCY_PaymentPurposeValidationCheckCode                     PaymentPurposeValidationCheckCode = "PCCC_purpose_and_country_and_currency"
	PCCP_PURPOSE_AND_COUNTRY_AND_CURRENCY_AND_CLEARING_SYSTEM_PaymentPurposeValidationCheckCode PaymentPurposeValidationCheckCode = "PCCP_purpose_and_country_and_currency_and_clearing_system"
	PCCS_PURPOSE_AND_COUNTRY_AND_CLEARING_SYSTEM_PaymentPurposeValidationCheckCode              PaymentPurposeValidationCheckCode = "PCCS_purpose_and_country_and_clearing_system"
)

List of PaymentPurposeValidationCheckCode

type PaymentPurposeValidationReason1Code ¶

type PaymentPurposeValidationReason1Code string

PaymentPurposeValidationReason1Code : The list of unique identifiers which describe the reasons for Payment Purpose validation status. *`PINP_no_purpose_code_data_available`-No purpose code data available in the SWFIFT repository for the instructed context. This may relate to the country specific requirements not mandating purpose codes for the instructed context. *`VPPD_valid_purpose_description`-The instructed payment purpose description has been successfully validated according to the specific requirements available in the SWIFT repository for the instructed context. *`MPPD_missing_purpose_description`-There are specific rules for the provided context that require the presence of the payment purpose description which is missing from the payment purpose validaton request . *`PCME_purpose_code_description_max_length_exceeded`-Instructed payment purpose code description has exceeded the mandated maximum length registered in the SWIFT repository for the given context. *`UPPC_unrecognized_purpose_code`-The instructed payment purpose code subject to validation could not be found in the purpose code data available in the SWIFT repository for the instructed payment context. *`VPPC_valid_purpose_code`-The instructed payment purpose code has been successfully validated against the purpose code list(s) available in the SWIFT repository for the instructed payment context. *`ICTY_invalid_country`-Instructed country code is not a valid country code on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code) *`UCSI_unrecognized_clearing_system_identification`-Instructed clearing system identifier has not been found in the SWIFT directory for the instructed payment context. *`MPPC_missing_payment_purpose_code`-Payment Purpose code has not been instructed for the payment validation to be performed. *`ICCY_invalid_currency_code`-Instructed currency code is not a valid ISO currency code. *`MCSI_missing_clearing_system_identifier`-Clearing system identifier is missing from the payment context in order for the validation of the instructed payment information to be performed. *`MCCC_missing_currency_code`-Currency code is missing from the payment context in order for the validation of the instructed payment information to be performed. *`ICCH_check_not_applied`-The individual payment validation check has no been applied for the instructed context. Other individual payment validation checks are more relevant and will be applied instead.

const (
	PINP_NO_PURPOSE_CODE_DATA_AVAILABLE_PaymentPurposeValidationReason1Code               PaymentPurposeValidationReason1Code = "PINP_no_purpose_code_data_available"
	VPPD_VALID_PURPOSE_DESCRIPTION_PaymentPurposeValidationReason1Code                    PaymentPurposeValidationReason1Code = "VPPD_valid_purpose_description"
	MPPD_MISSING_PURPOSE_DESCRIPTION_PaymentPurposeValidationReason1Code                  PaymentPurposeValidationReason1Code = "MPPD_missing_purpose_description"
	PCME_PURPOSE_CODE_DESCRIPTION_MAX_LENGTH_EXCEEDED_PaymentPurposeValidationReason1Code PaymentPurposeValidationReason1Code = "PCME_purpose_code_description_max_length_exceeded"
	UPPC_UNRECOGNIZED_PURPOSE_CODE_PaymentPurposeValidationReason1Code                    PaymentPurposeValidationReason1Code = "UPPC_unrecognized_purpose_code"
	VPPC_VALID_PURPOSE_CODE_PaymentPurposeValidationReason1Code                           PaymentPurposeValidationReason1Code = "VPPC_valid_purpose_code"
	ICTY_INVALID_COUNTRY_PaymentPurposeValidationReason1Code                              PaymentPurposeValidationReason1Code = "ICTY_invalid_country"
	UCSI_UNRECOGNIZED_CLEARING_SYSTEM_IDENTIFICATION_PaymentPurposeValidationReason1Code  PaymentPurposeValidationReason1Code = "UCSI_unrecognized_clearing_system_identification"
	MPPC_MISSING_PAYMENT_PURPOSE_CODE_PaymentPurposeValidationReason1Code                 PaymentPurposeValidationReason1Code = "MPPC_missing_payment_purpose_code"
	ICCY_INVALID_CURRENCY_CODE_PaymentPurposeValidationReason1Code                        PaymentPurposeValidationReason1Code = "ICCY_invalid_currency_code"
	MCSI_MISSING_CLEARING_SYSTEM_IDENTIFIER_PaymentPurposeValidationReason1Code           PaymentPurposeValidationReason1Code = "MCSI_missing_clearing_system_identifier"
	MCCC_MISSING_CURRENCY_CODE_PaymentPurposeValidationReason1Code                        PaymentPurposeValidationReason1Code = "MCCC_missing_currency_code"
	ICCH_CHECK_NOT_APPLIED_PaymentPurposeValidationReason1Code                            PaymentPurposeValidationReason1Code = "ICCH_check_not_applied"
)

List of PaymentPurposeValidationReason1Code

type PaymentPurposeValidationStatus1 ¶

type PaymentPurposeValidationStatus1 struct {
	Status                       *PaymentPurposeValidationStatus1Code  `json:"status"`
	Reason                       []PaymentPurposeValidationReason1Code `json:"reason"`
	ValidationCheck              []PaymentPurposeValidationCheck1      `json:"validation_check,omitempty"`
	AvailablePurposeCode         []GenericCodeIdentification1          `json:"available_purpose_code,omitempty"`
	PurposeCode                  *GenericCodeIdentification1           `json:"purpose_code,omitempty"`
	CountryCode                  string                                `json:"country_code,omitempty"`
	PurposeDescription           string                                `json:"purpose_description,omitempty"`
	ClearingSystemIdentification *ClearingSystemIdentification2Choice  `json:"clearing_system_identification,omitempty"`
	CurrencyCode                 string                                `json:"currency_code,omitempty"`
}

This represents the response details that the Payment Purpose validation service will provide to the service consumer.

type PaymentPurposeValidationStatus1Code ¶

type PaymentPurposeValidationStatus1Code string

PaymentPurposeValidationStatus1Code : The list of unique status identifiers for the Payment Purpose Validation service. *`IVAL_invalid`-The payment information instructed for validation it is not valid in the instructed payment context. *`FVAL_valid`-The payment information instructed for validation it is valid in the instructed payment context. *`UNRE_unrecognised`-The payment information instructed for validation has not been found in the SWIFT repository for the instructed payment context. *`CVAL_valid_with_comments`-The payment information instructed for validation is valid but the instructed payment context can be further improved. *`NAVL_not_available`-The validation of the instructed payment information is not available in the instructed payment context, typically due to payment data collection process being in progress and insufficient data coverage. *`CNPR_could_not_perform`-The validation of the instructed payment information could not be performed in the instructed payment context typically due to missing payment context information. *`NOAP_not_ applicable`-The validation of the instructed payment information has not been applied because didn't make sense for the given context.

const (
	IVAL_INVALID_PaymentPurposeValidationStatus1Code             PaymentPurposeValidationStatus1Code = "IVAL_invalid"
	FVAL_VALID_PaymentPurposeValidationStatus1Code               PaymentPurposeValidationStatus1Code = "FVAL_valid"
	UNRE_UNRECOGNISED_PaymentPurposeValidationStatus1Code        PaymentPurposeValidationStatus1Code = "UNRE_unrecognised"
	CVAL_VALID_WITH_COMMENTS_PaymentPurposeValidationStatus1Code PaymentPurposeValidationStatus1Code = "CVAL_valid_with_comments"
	NAVL_NOT_AVAILABLE_PaymentPurposeValidationStatus1Code       PaymentPurposeValidationStatus1Code = "NAVL_not_available"
	CNPR_COULD_NOT_PERFORM_PaymentPurposeValidationStatus1Code   PaymentPurposeValidationStatus1Code = "CNPR_could_not_perform"
	NOAP_NOT_APPLICABLE_PaymentPurposeValidationStatus1Code      PaymentPurposeValidationStatus1Code = "NOAP_not_applicable"
)

List of PaymentPurposeValidationStatus1Code

type PaymentValidationInputParameter1 ¶

type PaymentValidationInputParameter1 string

PaymentValidationInputParameter1 : The list of unique identifiers which describe the request parameters for Payment Validation service suite. *`PPCO_purpose_code`-Payment purpose code subject to the instructed Payment Validation service. *`PDCO_purpose_description`-Payment purpose description subject to the instructed Payment Validation service.

const (
	PPCO_PURPOSE_CODE_PaymentValidationInputParameter1        PaymentValidationInputParameter1 = "PPCO_purpose_code"
	PDCO_PURPOSE_DESCRIPTION_PaymentValidationInputParameter1 PaymentValidationInputParameter1 = "PDCO_purpose_description"
)

List of PaymentValidationInputParameter1

type PaymentValidationSeverity1 ¶

type PaymentValidationSeverity1 string

PaymentValidationSeverity1 : Severity of the payment validation between error, warning and informative *`ERRO_error`-Payment validation status indicates an error *`INFO_info`-Payment validation status is informative *`WARN_warning`-Payment validation status represents a warning

const (
	ERRO_ERROR_PaymentValidationSeverity1   PaymentValidationSeverity1 = "ERRO_error"
	INFO_INFO_PaymentValidationSeverity1    PaymentValidationSeverity1 = "INFO_info"
	WARN_WARNING_PaymentValidationSeverity1 PaymentValidationSeverity1 = "WARN_warning"
)

List of PaymentValidationSeverity1

type PostalAddress24 ¶

type PostalAddress24 struct {
	AddressType        *AddressType3Choice `json:"address_type,omitempty"`
	Department         string              `json:"department,omitempty"`
	SubDepartment      string              `json:"sub_department,omitempty"`
	StreetName         string              `json:"street_name,omitempty"`
	BuildingNumber     string              `json:"building_number,omitempty"`
	BuildingName       string              `json:"building_name,omitempty"`
	Floor              string              `json:"floor,omitempty"`
	PostBox            string              `json:"post_box,omitempty"`
	Room               string              `json:"room,omitempty"`
	PostCode           string              `json:"post_code,omitempty"`
	TownName           string              `json:"town_name,omitempty"`
	TownLocationName   string              `json:"town_location_name,omitempty"`
	DistrictName       string              `json:"district_name,omitempty"`
	CountrySubDivision string              `json:"country_sub_division,omitempty"`
	Country            string              `json:"country,omitempty"`
	AddressLine        []string            `json:"address_line,omitempty"`
}

Information that locates and identifies a specific address, as defined by postal services.

type ValidationCheckResponse2 ¶

type ValidationCheckResponse2 struct {
	AccountValidationStatus                 *AccountValidationResponse3Code `json:"account_validation_status"`
	CreditorAccountMatch                    *AccountValidationResponse2Code `json:"creditor_account_match"`
	CreditorNameMatch                       *AccountValidationResponse4Code `json:"creditor_name_match"`
	CreditorAddressMatch                    *AccountValidationResponse1Code `json:"creditor_address_match"`
	CreditorOrganisationIdentificationMatch *AccountValidationResponse1Code `json:"creditor_organisation_identification_match"`
	CreditorAccount                         string                          `json:"creditor_account,omitempty"`
	CreditorAccountType                     *AccountType2Code               `json:"creditor_account_type,omitempty"`
	CreditorName                            string                          `json:"creditor_name,omitempty"`
	CreditorAddress                         *PostalAddress24                `json:"creditor_address,omitempty"`
	ValidationSource                        *AccountValidationSource1Code   `json:"validation_source,omitempty"`
}

This represents the response details that the Creditor Account validation service will provide to the service consumer with regards to the creditor account validation performed by the creditor account.

Source Files ¶

View all Source files

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