# 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
Documentation For Authorization
Endpoints do not require authorization.
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.
# Constants
List of TransferStatus.
List of TransferStatus.
List of TransferStatus.
List of TransferStatus.
List of TransferStatus.
# 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 Paygate Admin API API vv1 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.
Error struct for Error.
GenericOpenAPIError Provides access to the body, error and model on returned errors.
LivenessProbes struct for LivenessProbes.
ServerConfiguration stores the information about a server.
ServerVariable stores the information about a server variable.
UpdateTransferStatus struct for UpdateTransferStatus.
UpdateTransferStatusOpts Optional parameters for the method 'UpdateTransferStatus'.
# Type aliases
AdminApiService AdminApi service.
TransfersApiService TransfersApi service.
TransferStatus Defines the state of the Transfer.