# 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
Class | Method | HTTP request | Description |
---|---|---|---|
ConfigurationApi | GetTransferConfiguration | Get /configuration/transfers | Get Configuration |
ConfigurationApi | UpdateTransferConfiguration | Put /configuration/transfers | Update Configuration |
MonitorApi | Ping | Get /ping | Ping PayGate |
TransfersApi | AddTransfer | Post /transfers | Create Transfer |
TransfersApi | DeleteTransferByID | Delete /transfers/{transferID} | Delete Transfer |
TransfersApi | GetTransferByID | Get /transfers/{transferID} | Get Transfer |
TransfersApi | GetTransfers | Get /transfers | List Transfers |
ValidationApi | GetAccountMicroDeposits | Get /accounts/{accountID}/micro-deposits | Get micro-deposits for a specified accountID |
ValidationApi | GetMicroDeposits | Get /micro-deposits/{microDepositID} | Get micro-deposit information |
ValidationApi | InitiateMicroDeposits | Post /micro-deposits | Initiate micro-deposits |
Documentation For Models
- Amount
- CreateMicroDeposits
- CreateTransfer
- Destination
- Error
- MicroDeposits
- OrganizationConfiguration
- ReturnCode
- Source
- Transfer
- TransferStatus
Documentation For Authorization
Endpoints do not require authorization.