admin

README

Go API client for admin

PayGate is a RESTful API enabling first-party Automated Clearing House (ACH) transfers to be created without a deep understanding of a full NACHA file specification. First-party transfers initiate at an Originating Depository Financial Institution (ODFI) and are sent off to other Financial Institutions.

Refer to the client endpoints for customr facing operations.

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: v1
• Package version: 1.0.0
• Build package: org.openapitools.codegen.languages.GoClientCodegen For more information, please visit https://github.com/moov-io/paygate

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 "./admin"

Documentation for API Endpoints

All URIs are relative to http://localhost:9092

Class	Method	HTTP request	Description
AdminApi	GetLivenessProbes	Get /live	Get Liveness Probes
AdminApi	GetVersion	Get /version	Get Version
TransfersApi	TriggerCutoffProcessing	Put /trigger-cutoff	Initiate cutoff processing
TransfersApi	UpdateTransferStatus	Put /transfers/{transferId}/status	Update Transfer status

Documentation For Models

• Error
• LivenessProbes
• TransferStatus
• UpdateTransferStatus

Documentation For Authorization

Endpoints do not require authorization.

Author

Documentation

Index

• Variables
• func CacheExpires(r *http.Response) time.Time
• type APIClient
  • func NewAPIClient(cfg *Configuration) *APIClient
  • func (c *APIClient) ChangeBasePath(path string)
  • func (c *APIClient) GetConfig() *Configuration
• type APIKey
• type APIResponse
  • func NewAPIResponse(r *http.Response) *APIResponse
  • func NewAPIResponseWithError(errorMessage string) *APIResponse
• type AdminApiService
  • func (a *AdminApiService) GetLivenessProbes(ctx _context.Context) (LivenessProbes, *_nethttp.Response, error)
  • func (a *AdminApiService) GetVersion(ctx _context.Context) (string, *_nethttp.Response, error)
• type BasicAuth
• type Configuration
  • func NewConfiguration() *Configuration
  • func (c *Configuration) AddDefaultHeader(key string, value string)
  • func (c *Configuration) ServerUrl(index int, variables map[string]string) (string, error)
• type Error
• type GenericOpenAPIError
  • func (e GenericOpenAPIError) Body() []byte
  • func (e GenericOpenAPIError) Error() string
  • func (e GenericOpenAPIError) Model() interface{}
• type LivenessProbes
• type ServerConfiguration
• type ServerVariable
• type TransferStatus
• type TransfersApiService
  • func (a *TransfersApiService) TriggerCutoffProcessing(ctx _context.Context) (*_nethttp.Response, error)
  • func (a *TransfersApiService) UpdateTransferStatus(ctx _context.Context, transferId string, xOrganization string, ...) (*_nethttp.Response, error)
• type UpdateTransferStatus
• type UpdateTransferStatusOpts

Variables

var (
	// ContextOAuth2 takes an 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 {
	AdminApi *AdminApiService

	TransfersApi *TransfersApiService
	// contains filtered or unexported fields
}

APIClient manages communication with the Paygate Admin API API vv1 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)

ChangeBasePath changes base path to allow switching to mocks

func (*APIClient) GetConfig

func (c *APIClient) GetConfig() *Configuration

Allow modification of underlying config for alternate implementations and testing Caution: modifying the configuration while live can cause data races and potentially unwanted behavior

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

APIResponse stores the API response returned by the server.

func NewAPIResponse

func NewAPIResponse(r *http.Response) *APIResponse

NewAPIResponse returns a new APIResonse object.

func NewAPIResponseWithError

func NewAPIResponseWithError(errorMessage string) *APIResponse

NewAPIResponseWithError returns a new APIResponse object with the provided error message.

type AdminApiService

type AdminApiService service

AdminApiService AdminApi service

func (*AdminApiService) GetLivenessProbes

func (a *AdminApiService) GetLivenessProbes(ctx _context.Context) (LivenessProbes, *_nethttp.Response, error)

GetLivenessProbes Get Liveness Probes Get the status of each depdendency

• @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().

@return LivenessProbes

func (*AdminApiService) GetVersion

func (a *AdminApiService) GetVersion(ctx _context.Context) (string, *_nethttp.Response, error)

GetVersion Get Version Show the current version of PayGate

• @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().

@return string

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 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"`
	Debug         bool              `json:"debug,omitempty"`
	Servers       []ServerConfiguration
	HTTPClient    *http.Client
}

Configuration stores the configuration of the API client

func NewConfiguration

func NewConfiguration() *Configuration

NewConfiguration returns a new Configuration object

func (*Configuration) AddDefaultHeader

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

AddDefaultHeader adds a new HTTP header to the default header in the request

func (*Configuration) ServerUrl

func (c *Configuration) ServerUrl(index int, variables map[string]string) (string, error)

ServerUrl returns URL based on server settings

type Error

type Error struct {
	// An error message describing the problem intended for humans.
	Error string `json:"error"`
}

Error struct for Error

type GenericOpenAPIError

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

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

func (GenericOpenAPIError) Body

func (e GenericOpenAPIError) Body() []byte

Body returns the raw bytes of the response

func (GenericOpenAPIError) Error

func (e GenericOpenAPIError) Error() string

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

func (GenericOpenAPIError) Model

func (e GenericOpenAPIError) Model() interface{}

Model returns the unpacked model of the error

type LivenessProbes

type LivenessProbes struct {
	// Either an error from checking Customers or good as a string.
	Customers string `json:"customers,omitempty"`
}

LivenessProbes struct for LivenessProbes

type ServerConfiguration

type ServerConfiguration struct {
	Url         string
	Description string
	Variables   map[string]ServerVariable
}

ServerConfiguration stores the information about a server

type ServerVariable

type ServerVariable struct {
	Description  string
	DefaultValue string
	EnumValues   []string
}

ServerVariable stores the information about a server variable

type TransferStatus

type TransferStatus string

TransferStatus Defines the state of the Transfer

const (
	CANCELED   TransferStatus = "canceled"
	FAILED     TransferStatus = "failed"
	REVIEWABLE TransferStatus = "reviewable"
	PENDING    TransferStatus = "pending"
	PROCESSED  TransferStatus = "processed"
)

List of TransferStatus

type TransfersApiService

type TransfersApiService service

TransfersApiService TransfersApi service

func (*TransfersApiService) TriggerCutoffProcessing

func (a *TransfersApiService) TriggerCutoffProcessing(ctx _context.Context) (*_nethttp.Response, error)

TriggerCutoffProcessing Initiate cutoff processing Starts processing like it's a cutoff window approaching. This involves merging transfers into files, upload attempts, along with inbound file download processing.

• @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().

func (*TransfersApiService) UpdateTransferStatus

func (a *TransfersApiService) UpdateTransferStatus(ctx _context.Context, transferId string, xOrganization string, updateTransferStatus UpdateTransferStatus, localVarOptionals *UpdateTransferStatusOpts) (*_nethttp.Response, error)

UpdateTransferStatus Update Transfer status Updates a Transfer status for a transferID. PENDING transfers may be updated to: CANCELED or REVIEWABLE. REVIEWABLE transfers may be updated to: CANCELED or PENDING.

• @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
• @param transferId transferID that identifies the Transfer
• @param xOrganization Value used to separate and identify models
• @param updateTransferStatus
• @param optional nil or *UpdateTransferStatusOpts - Optional Parameters:
• @param "XRequestID" (optional.String) - Optional requestID allows application developer to trace requests through the systems logs

type UpdateTransferStatus

type UpdateTransferStatus struct {
	Status TransferStatus `json:"status,omitempty"`
}

UpdateTransferStatus struct for UpdateTransferStatus

type UpdateTransferStatusOpts

type UpdateTransferStatusOpts struct {
	XRequestID optional.String
}

UpdateTransferStatusOpts Optional parameters for the method 'UpdateTransferStatus'