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

# README

Go API client for client

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.

An organization is a value used to isolate models from each other. This can be set to a "user ID" from your authentication service or any value your system has to identify.

There are also admin endpoints for back-office 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 "./client"

Documentation for API Endpoints

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

ClassMethodHTTP requestDescription
ConfigurationApiGetTransferConfigurationGet /configuration/transfersGet Configuration
ConfigurationApiUpdateTransferConfigurationPut /configuration/transfersUpdate Configuration
MonitorApiPingGet /pingPing PayGate
TransfersApiAddTransferPost /transfersCreate Transfer
TransfersApiDeleteTransferByIDDelete /transfers/{transferID}Delete Transfer
TransfersApiGetTransferByIDGet /transfers/{transferID}Get Transfer
TransfersApiGetTransfersGet /transfersList Transfers
ValidationApiGetAccountMicroDepositsGet /accounts/{accountID}/micro-depositsGet micro-deposits for a specified accountID
ValidationApiGetMicroDepositsGet /micro-deposits/{microDepositID}Get micro-deposit information
ValidationApiInitiateMicroDepositsPost /micro-depositsInitiate micro-deposits

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

AddTransferOpts Optional parameters for the method 'AddTransfer'.
Amount struct for Amount.
APIClient manages communication with the Paygate 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.
CreateMicroDeposits struct for CreateMicroDeposits.
CreateTransfer These fields are used to initiate a Transfer between two Customer objects and their Accounts.
DeleteTransferByIDOpts Optional parameters for the method 'DeleteTransferByID'.
Destination Customer that is receiving a Transfer.
Error struct for Error.
GenericOpenAPIError Provides access to the body, error and model on returned errors.
GetTransferByIDOpts Optional parameters for the method 'GetTransferByID'.
GetTransferConfigurationOpts Optional parameters for the method 'GetTransferConfiguration'.
GetTransfersOpts Optional parameters for the method 'GetTransfers'.
MicroDeposits struct for MicroDeposits.
OrganizationConfiguration struct for OrganizationConfiguration.
ReturnCode struct for ReturnCode.
ServerConfiguration stores the information about a server.
ServerVariable stores the information about a server variable.
Source Customer that initiates a Transfer.
Transfer struct for Transfer.
UpdateTransferConfigurationOpts Optional parameters for the method 'UpdateTransferConfiguration'.

# Type aliases

ConfigurationApiService ConfigurationApi service.
MonitorApiService MonitorApi service.
TransfersApiService TransfersApi service.
TransferStatus Defines the state of the Transfer.
ValidationApiService ValidationApi service.