Documentation ¶
Index ¶
Constants ¶
This section is empty.
Variables ¶
var ( // OBExternalAccountIdentification4Codes - valid SchemeName as per the specification. OBExternalAccountIdentification4Codes = [5]OBExternalAccountIdentification4Code{ "UK.OBIE.BBAN", "UK.OBIE.IBAN", "UK.OBIE.PAN", "UK.OBIE.Paym", "UK.OBIE.SortCodeAccountNumber", } )
Functions ¶
This section is empty.
Types ¶
type ExportRequest ¶
type ExportRequest struct { Implementer string `json:"implementer"` // Implementer/Brand Name AuthorisedBy string `json:"authorised_by"` // Authorised by JobTitle string `json:"job_title"` // Job Title HasAgreed bool `json:"has_agreed"` // I agree AddDigitalSignature bool `json:"add_digital_signature"` // Sign this report }
ExportRequest - Request to `/api/export`.
func (ExportRequest) Validate ¶
func (e ExportRequest) Validate() error
type ExportResults ¶
type ExportResults struct { ExportRequest ExportRequest `json:"export_request"` HasPassed bool `json:"has_passed"` Results map[results.ResultKey][]results.TestCase `json:"results"` Tokens []events.AcquiredAccessToken `json:"tokens"` DiscoveryModel discovery.Model `json:"discovery_model"` }
ExportResults - Contains `ExportRequest` and results of test run.
type ImportRequest ¶
type ImportRequest struct {
Report string `json:"report" form:"report"` // The exported report ZIP archive.
}
ImportRequest - Request to `/api/import/review` or `/api/import/rerun` POST. TODO(mbana): Needs more work.
func (ImportRequest) Validate ¶
func (r ImportRequest) Validate() error
Validate - used by github.com/go-ozzo/ozzo-validation to validate struct.
type ImportRerunResponse ¶
type ImportRerunResponse struct { }
ImportRerunResponse - Response to `/api/import/rerun` POST.
type ImportReviewResponse ¶
type ImportReviewResponse struct { }
ImportReviewResponse - Response to `/api/import/review` POST.
type OBCashAccount5 ¶
type OBCashAccount5 = Payment
Just an an alternate spelling to match the Account and Transaction API Specification.
type OBExternalAccountIdentification4Code ¶
type OBExternalAccountIdentification4Code = interface{}
Needs to be a interface{} slice, see the official test for an example https://github.com/go-ozzo/ozzo-validation/blob/master/in_test.go
type Payment ¶
type Payment struct { // Name of the identification scheme, in a coded form as published in an external list SchemeName string `json:"scheme_name" form:"scheme_name"` // Beneficiary account identification. Identification string `json:"identification" form:"identification"` // Name of the account, as assigned by the account servicing institution. // Usage: The account name is the name or names of the account owner(s) represented at an account level. The account name is not the product name or the nickname of the account. Name string `json:"name" form:"name"` }
Payment - Provides the details to identify the beneficiary account. This is referred to `OBCashAccount5` (line 9488) in the specification linked to below.
Structure was deduced from this specification: https://raw.githubusercontent.com/OpenBankingUK/read-write-api-specs/v3.1.0/dist/account-info-swagger.json
Example value:
{ "SchemeName": "UK.OBIE.SortCodeAccountNumber", "Identification": "20202010981789", "Name": "Dr Foo" }
func (Payment) Validate ¶
Validate - used by https://github.com/go-ozzo/ozzo-validation to validate struct.