package
0.2.1
Repository: https://github.com/moov-io/iso20022.git
Documentation: pkg.go.dev

# README

Go API client for client

ISO 20022 is an ISO standard for electronic data interchange between financial institutions. It describes a metadata repository containing descriptions of messages and business processes, and a maintenance process for the repository content. The metadata is stored in UML models with a special ISO 20022 UML Profile. The metadata is transformed into the syntax of messages used in financial networks. The first syntax supported for messages was XML Schema. Package ISO20022 implements a message reader and writer written in Go decorated with a HTTP API for creating, parsing, and validating meta data messages. Package ISO20022 supported xml and json format for message

InputOutput
JSONJSON
XMLXML

Overview

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

  • API version: 0.0.1
  • Package version: 1.0.0
  • Build package: org.openapitools.codegen.languages.GoClientCodegen

Installation

Install the following dependencies:

go get github.com/stretchr/testify/assert
go get golang.org/x/oauth2
go get golang.org/x/net/context
go get github.com/antihax/optional

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

import "./client"

Documentation for API Endpoints

All URIs are relative to https://local.moov.io:8208

ClassMethodHTTP requestDescription
Iso20022MessageApiConvertPost /convertConvert iso20022 message
Iso20022MessageApiHealthGet /healthhealth iso8583 service
Iso20022MessageApiPrintPost /printPrint iso20022 message with specific format
Iso20022MessageApiValidatorPost /validatorValidate iso20022 message

Documentation For Models

Documentation For Authorization

GatewayAuth

  • Type: HTTP basic authentication

Example

auth := context.WithValue(context.Background(), sw.ContextBasicAuth, sw.BasicAuth{
    UserName: "username",
    Password: "password",
})
r, err := client.Service.Operation(auth, args)

Author

# Functions

CacheExpires helper function to determine remaining time before repeating a request.
NewAPIClient creates a new API client.
NewAPIResponse returns a new APIResonse object.
NewAPIResponseWithError returns a new APIResponse object with the provided error message.
NewConfiguration returns a new Configuration object.

# Variables

ContextAccessToken takes a string oauth2 access token as authentication for the request.
ContextAPIKey takes an APIKey as authentication for the request.
ContextBasicAuth takes BasicAuth as authentication for the request.
ContextOAuth2 takes an oauth2.TokenSource as authentication for the request.

# Structs

APIClient manages communication with the ISO20022 API API v0.0.1 In most cases there should be only one, shared, APIClient.
APIKey provides API key based authentication to a request passed via context using ContextAPIKey.
APIResponse stores the API response returned by the server.
BasicAuth provides basic http authentication to a request passed via context using ContextBasicAuth.
Configuration stores the configuration of the API client.
ConvertOpts Optional parameters for the method 'Convert'.
Error struct for Error.
GenericOpenAPIError Provides access to the body, error and model on returned errors.
Iso20022Document https://www.iso20022.org/iso-20022-message-definitions?business-domain=1.
PrintOpts Optional parameters for the method 'Print'.
ServerConfiguration stores the information about a server.
ServerVariable stores the information about a server variable.
Success struct for Success.
ValidatorOpts Optional parameters for the method 'Validator'.

# Type aliases

Iso20022MessageApiService Iso20022MessageApi service.