openapi

package
v0.1.0 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Apr 18, 2019 License: Apache-2.0 Imports: 21 Imported by: 1

README

Go API client for openapi

Note: We're currently in pre-release of our API. We expect breaking changes before launching v1 so please join our slack organization (request an invite) or mailing list for more updates and notices. The Moov API is organized around REST. Our API has predictable, resource-oriented URLs, and uses HTTP response codes to indicate API errors. We use built-in HTTP features, like HTTP authentication and HTTP verbs, which are understood by off-the-shelf HTTP clients. We support cross-origin resource sharing, allowing you to interact securely with our API from client-side web applications (never expose your secret API key in any public website's client-side code). JSON is returned by all API responses, including errors, although you can generate client code via OpenAPI code generation or the OpenAPI editor to convert responses to appropriate language-specific objects. The Moov API offers two methods of authentication, Cookie and OAuth2 access tokens. The cookie auth is designed for web browsers while the OAuth2 authentication is designed for automated access of our API. When an API requires a token generated using OAuth (2-legged), no end user is involved. You generate the token by passing your client credentials (Client Id and Client Secret) in a simple call to Create access token (/oauth2/token). The operation returns a token that is valid for a few hours and can be renewed; when it expires, you just repeat the call and get a new token. Making additional token requests will keep generating tokens. There are no hard or soft limits. Cookie auth is setup by provided (/users/login) a valid email and password combination. A Set-Cookie header is returned on success, which can be used in later calls. Cookie auth is required to generate OAuth2 client credentials. The following order of API operations is suggested to start developing against the Moov API: 1. Create a Moov API user with a unique email address 1. Login with user/password credentials 1. Create an OAuth2 client and Generate an OAuth access token 1. Using the OAuth credentials create: - Originator and Originator Depository (requires micro deposit setup) - Receiver and Receiver Depository (requires micro deposit setup) 1. Submit the Transfer After signup clients can submit ACH files (either in JSON or plaintext) for validation and tabulation. The Moov API offers many services: - Automated Clearing House (ACH) origination and file management - Transfers and ACH Receiver management. - X9 / Image Cash Ledger (ICL) specification support (image uplaod) ACH is implemented a RESTful API enabling ACH transactions to be submitted and received without a deep understanding of a full NACHA file specification. An Originator can initiate a Transfer as either a push (credit) or pull (debit) to a Receiver. Originators and Receivers must have a valid Depository account for a Transfer. A Transfer is initiated by an Originator to a Receiver with an amount and flow of funds. Originator -> Gateway -> Receiver - OriginatorDepository - ReceiverDepository - Type (Push or Pull) - Amount (USD 12.43) - Status (Pending) If you find a security related problem please contact us at security@moov.io.

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.

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

Documentation for API Endpoints

All URIs are relative to https://api.moov.io

Class Method HTTP request Description
DepositoriesApi AddDepository Post /v1/ach/depositories Create a new depository account for the authenticated user
DepositoriesApi ConfirmMicroDeposits Post /v1/ach/depositories/{depositoryId}/micro-deposits/confirm Confirm micro deposit amounts after they have been posted to the depository account
DepositoriesApi DeleteDepository Delete /v1/ach/depositories/{depositoryId} Permanently deletes a depository and associated transfers. It cannot be undone. Immediately cancels any active Transfers for the depository.
DepositoriesApi GetDepositories Get /v1/ach/depositories A list of all Depository objects for the authentication context.
DepositoriesApi GetDepositoryByID Get /v1/ach/depositories/{depositoryId} Get a Depository object for the supplied ID
DepositoriesApi InitiateMicroDeposits Post /v1/ach/depositories/{depositoryId}/micro-deposits Initiates micro deposits to be sent to the Depository institution for account validation
DepositoriesApi UpdateDepository Patch /v1/ach/depositories/{depositoryId} Updates the specified Depository by setting the values of the parameters passed. Any parameters not provided will be left unchanged.
EventsApi GetEventByID Get /v1/ach/events/{eventId} Get a Event by ID
EventsApi GetEvents Get /v1/ach/events Gets a list of Events
FEDApi SearchFEDACH Get /v1/fed/ach/search Search FEDACH names and metadata
FEDApi SearchFEDWIRE Get /v1/fed/wire/search Search FEDWIRE names and metadata
FilesApi AddBatchToFile Post /v1/ach/files/{file_id}/batches Add Batch to File
FilesApi CreateFile Post /v1/ach/files/create Create a new File object
FilesApi DeleteACHFile Delete /v1/ach/files/{file_id} Permanently deletes a File and associated Batches. It cannot be undone.
FilesApi DeleteFileBatch Delete /v1/ach/files/{file_id}/batches/{batch_id} Delete a Batch from a File
FilesApi GetFileBatch Get /v1/ach/files/{file_id}/batches/{batch_id} Get a specific Batch on a FIle
FilesApi GetFileBatches Get /v1/ach/files/{file_id}/batches Get the batches on a File.
FilesApi GetFileByID Get /v1/ach/files/{file_id} Retrieves the details of an existing File. You need only supply the unique File identifier that was returned upon creation.
FilesApi GetFileContents Get /v1/ach/files/{file_id}/contents Assembles the existing file (batches and controls) records, computes sequence numbers and totals. Returns plaintext file.
FilesApi GetFiles Get /v1/ach/files Gets a list of Files
FilesApi UpdateFile Post /v1/ach/files/{file_id} Updates the specified File Header by setting the values of the parameters passed. Any parameters not provided will be left unchanged.
FilesApi ValidateFile Get /v1/ach/files/{file_id}/validate Validates the existing file. You need only supply the unique File identifier that was returned upon creation.
GLApi CreateAccount Post /v1/gl/customers/{customer_id}/accounts Create a new account for a Customer
GLApi CreateCustomer Post /v1/gl/customers Create a new customer
GLApi GetAccountsByCustomerID Get /v1/gl/customers/{customer_id}/accounts Retrieves a list of accounts associated with the customer ID.
GLApi GetGLCustomer Get /v1/gl/customers/{customer_id} Retrieves a Customer object associated with the customer ID.
GLApi SearchAccounts Get /v1/gl/accounts/search Search for account which matches all query parameters
GatewaysApi AddGateway Post /v1/ach/gateways Create a new Gateway object
GatewaysApi GetGateways Get /v1/ach/gateways Gets a list of Gatways
MonitorApi PingACH Get /v1/ach/ping Check that the moov-io/ach service is running
MonitorApi PingAuth Get /v1/auth/ping Check that the moov-io/auth service is running
MonitorApi PingFED Get /v1/fed/ping Check that the moov-io/fed service is running
MonitorApi PingGL Get /v1/gl/ping Check that the moov-io/gl service is running
MonitorApi PingOFAC Get /v1/ofac/ping Check that the moov-io/ofac service is running
MonitorApi PingPaygate Get /v1/paygate/ping Check that the moov-io/paygate service is running
OAuth2Api CheckOAuthClientCredentials Get /v1/oauth2/authorize Verify OAuth2 Bearer token
OAuth2Api CreateOAuth2Client Post /v1/oauth2/client Create OAuth2 client credentials
OAuth2Api CreateOAuth2Token Post /v1/oauth2/token Generate OAuth2 access token
OAuth2Api GetClientsForUserId Get /v1/oauth2/clients List OAuth2 clients for the authenticated user
OFACApi AddCustomerNameWatch Post /v1/ofac/customers/watch Add customer watch by name
OFACApi AddCustomerWatch Post /v1/ofac/customers/{customerId}/watch Add OFAC watch on a Customer
OFACApi GetCustomer Get /v1/ofac/customers/{customerId} Get information about a customer, addresses, alternate names, and their SDN metadata.
OFACApi GetLatestDownloads Get /v1/ofac/downloads Return list of recent downloads of OFAC data
OFACApi GetSDN Get /v1/ofac/sdn/{sdnId} Specially designated national
OFACApi GetSDNAddresses Get /v1/ofac/sdn/{sdnId}/addresses Get addresses for a given SDN
OFACApi GetSDNAltNames Get /v1/ofac/sdn/{sdnId}/alts Get alternate names for a given SDN
OFACApi RemoveCustomerNameWatch Delete /v1/ofac/customers/watch/{watchId} Remove a Customer name watch
OFACApi RemoveCustomerWatch Delete /v1/ofac/customers/{customerId}/watch/{watchId} Remove customer watch
OFACApi SearchSDNs Get /v1/ofac/search Search SDN names and metadata
OFACApi UpdateCustomerStatus Put /v1/ofac/customers/{customerId} Update a Customer's sanction status to always block or always allow transactions.
OriginatorsApi AddOriginator Post /v1/ach/originators Create a new Originator object
OriginatorsApi DeleteOriginator Delete /v1/ach/originators/{originatorId} Permanently deletes an Originator and associated Receivers, Depositories, and Transfers. It cannot be undone. Also immediately cancels any active Transfers for the Originator.
OriginatorsApi GetOriginatorByID Get /v1/ach/originators/{originatorId} Retrieves the details of an existing Originator. You need only supply the unique Originator identifier that was returned upon receiver creation.
OriginatorsApi GetOriginators Get /v1/ach/originators Gets a list of Originators
OriginatorsApi UpdateOriginator Patch /v1/ach/originators/{originatorId} Updates the specified Originator by setting the values of the parameters passed. Any parameters not provided will be left unchanged.
ReceiversApi AddReceivers Post /v1/ach/receivers Create a new Receiver object
ReceiversApi DeleteReceiver Delete /v1/ach/receivers/{receiverId} Permanently deletes a receiver and associated depositories and transfers. It cannot be undone. Immediately cancels any active Transfers for the receiver.
ReceiversApi GetDepositoriesByID Get /v1/ach/receivers/{receiverId}/depositories/{depositoryId} Get a Depository accounts for a Receiver based on it's ID
ReceiversApi GetDepositoriesByReceiverID Get /v1/ach/receivers/{receiverId}/depositories Get a list of Depository accounts for a Receiver
ReceiversApi GetReceiverByID Get /v1/ach/receivers/{receiverId} Get a Receiver by ID
ReceiversApi GetReceivers Get /v1/ach/receivers Gets a list of Receivers
ReceiversApi UpdateReceiver Patch /v1/ach/receivers/{receiverId} Updates the specified Receiver by setting the values of the parameters passed. Any parameters not provided will be left unchanged.
TransfersApi AddTransfer Post /v1/ach/transfers Create a new transfer between an Originator and a Receiver. Transfers cannot be modified. Instead delete the old and create a new transfer.
TransfersApi AddTransfers Post /v1/ach/transfers/batch Create a new list of transfer, validate, build, and process. Transfers cannot be modified.
TransfersApi DeleteTransferByID Delete /v1/ach/transfers/{transferId} It is possible to recall (delete) a transfer before it has been released from the financial institution.
TransfersApi GetTransferByID Get /v1/ach/transfers/{transferId} Get a Transfer object for the supplied ID
TransfersApi GetTransferEventsByID Get /v1/ach/transfers/{transferId}/events Get all Events associated with the Transfer object's for the supplied ID
TransfersApi GetTransferFiles Post /v1/ach/transfers/{transferId}/files Get the ACH files to be used in this transfer.
TransfersApi GetTransferNachaCode Post /v1/ach/transfers/{transferId}/failed Get the NACHA return code and description
TransfersApi GetTransfers Get /v1/ach/transfers A list of all Transfer objects
UserApi CheckUserLogin Get /v1/users/login Check if a cookie is valid and authentic for a user.
UserApi CreateUser Post /v1/users/create Create a new user using an email address not seen before.
UserApi UpdateUserProfile Patch /v1/users/{user_id} Update a User's profile information
UserApi UserLogin Post /v1/users/login Attempt to login with an email and password
UserApi UserLogout Delete /v1/users/login Invalidat a user's cookie(s).

Documentation For Models

Documentation For Authorization

bearerAuth

  • Type: OAuth
  • Flow: application
  • Authorization URL:
  • Scopes: N/A

Example

auth := context.WithValue(context.Background(), sw.ContextAccessToken, "ACCESSTOKENSTRING")
r, err := client.Service.Operation(auth, args)

Or via OAuth2 module to automatically refresh tokens and perform user authentication.

import "golang.org/x/oauth2"

/* Perform OAuth2 round trip request and obtain a token */

tokenSource := oauth2cfg.TokenSource(createContext(httpClient), &token)
auth := context.WithValue(oauth2.NoContext, sw.ContextOAuth2, tokenSource)
r, err := client.Service.Operation(auth, args)

cookieAuth

  • Type: API key

Example

auth := context.WithValue(context.Background(), sw.ContextAPIKey, sw.APIKey{
    Key: "APIKEY",
    Prefix: "Bearer", // Omit if not necessary.
})
r, err := client.Service.Operation(auth, args)

Author

security@moov.io

Documentation

Index

Constants

This section is empty.

Variables

View Source 
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 {
	DepositoriesApi *DepositoriesApiService

	EventsApi *EventsApiService

	FEDApi *FEDApiService

	FilesApi *FilesApiService

	GLApi *GLApiService

	GatewaysApi *GatewaysApiService

	MonitorApi *MonitorApiService

	OAuth2Api *OAuth2ApiService

	OFACApi *OFACApiService

	OriginatorsApi *OriginatorsApiService

	ReceiversApi *ReceiversApiService

	TransfersApi *TransfersApiService

	UserApi *UserApiService
	// contains filtered or unexported fields
}

APIClient manages communication with the Moov 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)

Change base path to allow switching to mocks

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

func NewAPIResponse 

func NewAPIResponse(r *http.Response) *APIResponse

func NewAPIResponseWithError 

func NewAPIResponseWithError(errorMessage string) *APIResponse

type Account 

type Account struct {
	// The unique identifier for an account
	AccountId string `json:"accountId,omitempty"`
	// The unique identifier for the customer who owns the account
	CustomerId string `json:"customerId,omitempty"`
	// Caller defined label for this account.
	Name string `json:"name,omitempty"`
	// A unique Account number at the bank.
	AccountNumber string `json:"accountNumber,omitempty"`
	// Last four digits of an account number
	AccountNumberMasked string `json:"accountNumberMasked,omitempty"`
	// Routing Transit Number is a nine-digit number assigned by the ABA
	RoutingNumber string `json:"routingNumber,omitempty"`
	// Status of the account being created.
	Status string `json:"status,omitempty"`
	// Product type of the account
	Type      string    `json:"type,omitempty"`
	CreatedAt time.Time `json:"createdAt,omitempty"`
	ClosedAt  time.Time `json:"closedAt,omitempty"`
	// Last time the object was modified except balances
	LastModified time.Time `json:"lastModified,omitempty"`
	// Total balance of account in USD cents.
	Balance int32 `json:"balance,omitempty"`
	// Balance available in USD cents to be drawn
	BalanceAvailable int32 `json:"balanceAvailable,omitempty"`
	// Balance of pending transactions in USD cents
	BalancePending int32 `json:"balancePending,omitempty"`
}

type AchDictionary 

type AchDictionary struct {
	ACHParticipants []AchParticipant `json:"ACHParticipants,omitempty"`
}

Search results containing ACHDictionary of Participants

type AchLocation 

type AchLocation struct {
	// Street Address
	Address string `json:"address,omitempty"`
	// City
	City string `json:"city,omitempty"`
	// State
	State string `json:"state,omitempty"`
	// Postal Code
	PostalCode string `json:"postalCode,omitempty"`
	// Postal Code Extension
	PostalExtension string `json:"postalExtension,omitempty"`
}

ACHLocation is the FEDACH delivery address

type AchParticipant 

type AchParticipant struct {
	// The institution's routing number
	RoutingNumber string `json:"routingNumber,omitempty"`
	// Main/Head Office or Branch  * `O` - Main * `B` - Branch
	OfficeCode string `json:"officeCode,omitempty"`
	// Servicing Fed's main office routing number
	ServicingFRBNumber string `json:"servicingFRBNumber,omitempty"`
	// The code indicating the ABA number to be used to route or send ACH items to the RDFI  * `0` - Institution is a Federal Reserve Bank * `1` - Send items to customer routing number * `2` - Send items to customer using new routing number field
	RecordTypeCode string `json:"recordTypeCode,omitempty"`
	// Date of last revision  * YYYYMMDD * Blank
	Revised string `json:"revised,omitempty"`
	// Financial Institution's new routing number resulting from a merger or renumber
	NewRoutingNumber string `json:"newRoutingNumber,omitempty"`
	// Financial Institution Name
	CustomerName string `json:"customerName,omitempty"`
	// FEDACH delivery address
	AchLocation []AchLocation `json:"achLocation,omitempty"`
	// The Financial Institution's phone number
	PhoneNumber string `json:"phoneNumber,omitempty"`
	// Code is based on the customers receiver code  * `1` - Receives Gov/Comm
	StatusCode string `json:"statusCode,omitempty"`
	// Code is current view  * `1` - Current view
	ViewCode string `json:"viewCode,omitempty"`
}

ACHParticipant holds a FedACH dir routing record as defined by Fed ACH Format. https://www.frbservices.org/EPaymentsDirectory/achFormat.html

type AddBatchToFileOpts 

type AddBatchToFileOpts struct {
	XRequestId      optional.String
	XIdempotencyKey optional.String
}

type AddCustomerNameWatchOpts 

type AddCustomerNameWatchOpts struct {
	XRequestId optional.String
}

type AddCustomerWatchOpts 

type AddCustomerWatchOpts struct {
	XRequestId optional.String
}

type AddDepositoryOpts 

type AddDepositoryOpts struct {
	XIdempotencyKey optional.String
	XRequestId      optional.String
}

type AddGatewayOpts 

type AddGatewayOpts struct {
	XIdempotencyKey optional.String
	XRequestId      optional.String
}

type AddOriginatorOpts 

type AddOriginatorOpts struct {
	XRequestId      optional.String
	XIdempotencyKey optional.String
}

type AddReceiversOpts 

type AddReceiversOpts struct {
	XIdempotencyKey optional.String
	XRequestId      optional.String
}

type AddTransferOpts 

type AddTransferOpts struct {
	XIdempotencyKey optional.String
	XRequestId      optional.String
}

type AddTransfersOpts 

type AddTransfersOpts struct {
	XIdempotencyKey optional.String
	XRequestId      optional.String
}

type Addendum 

type Addendum struct {
	// TODO
	TypeCode string `json:"typeCode"`
}

type Address 

type Address struct {
	EntityID                    string  `json:"entityID,omitempty"`
	AddressID                   string  `json:"addressID,omitempty"`
	Address                     string  `json:"address,omitempty"`
	CityStateProvincePostalCode string  `json:"cityStateProvincePostalCode,omitempty"`
	Country                     string  `json:"country,omitempty"`
	Match                       float32 `json:"match,omitempty"`
}

Physical address from OFAC list

type Address2 

type Address2 struct {
	Type string `json:"type,omitempty"`
	// First line of the address
	Address1 string `json:"address1,omitempty"`
	// Second line of the address
	Address2 string `json:"address2,omitempty"`
	City     string `json:"city,omitempty"`
	// two charcer code of US state
	State      string `json:"state,omitempty"`
	PostalCode string `json:"postalCode,omitempty"`
	Country    string `json:"country,omitempty"`
	// Address has been validated for customer
	Validated bool `json:"validated,omitempty"`
	// Address is currently being used for customer
	Active bool `json:"active,omitempty"`
}

type Alt 

type Alt struct {
	EntityID         string  `json:"entityID,omitempty"`
	AlternateID      string  `json:"alternateID,omitempty"`
	AlternateType    string  `json:"alternateType,omitempty"`
	AlternateName    string  `json:"alternateName,omitempty"`
	AlternateRemarks string  `json:"alternateRemarks,omitempty"`
	Match            float32 `json:"match,omitempty"`
}

Alternate name from OFAC list

type Amounts 

type Amounts struct {
	Amounts []string `json:"amounts"`
}

A JSON array of currency amounts

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 Batch 

type Batch struct {
	BatchHeader  BatchHeader   `json:"batchHeader,omitempty"`
	EntryDetails []EntryDetail `json:"entryDetails,omitempty"`
	BatchControl BatchControl  `json:"batchControl,omitempty"`
}

type BatchControl 

type BatchControl struct {
	// Batch ID
	Id string `json:"id,omitempty"`
	// Same as ServiceClassCode in BatchHeaderRecord
	ServiceClassCode int32 `json:"serviceClassCode,omitempty"`
	// EntryAddendaCount is a tally of each Entry Detail Record and each Addenda Record processed, within either the batch or file as appropriate.
	EntryAddendaount int32 `json:"entryAddendaÇount,omitempty"`
	// Validate the Receiving DFI Identification in each Entry Detail Record is hashed to provide a check against inadvertent alteration of data contents due to hardware failure or program error. In this context the Entry Hash is the sum of the corresponding fields in the Entry Detail Records on the file.
	EntryHash int32 `json:"entryHash,omitempty"`
	// Contains accumulated Entry debit totals within the batch.
	TotalDebit int32 `json:"totalDebit,omitempty"`
	// Contains accumulated Entry credit totals within the batch.
	TotalCredit int32 `json:"totalCredit,omitempty"`
	// Alphanumeric code used to identify an Originator The Company Identification Field must be included on all prenotification records and on each entry initiated pursuant to such prenotification. The Company ID may begin with the ANSI one-digit Identification Code Designator (ICD), followed by the identification number The ANSI Identification Numbers and related Identification Code IRS Employer Identification Number (EIN) \"1\" Data Universal Numbering Systems (DUNS) \"3\" User Assigned Number \"9\"
	CompanyIdentification string `json:"companyIdentification,omitempty"`
	// MAC is an eight character code derived from a special key used in conjunction with the DES algorithm. The purpose of the MAC is to validate the authenticity of ACH entries. The DES algorithm and key message standards must be in accordance with standards adopted by the American National Standards Institute. The remaining eleven characters of this field are blank.
	MessageAuthentication string `json:"messageAuthentication,omitempty"`
	// The routing number is used to identify the DFI originating entries within a given branch.
	ODFIIdentification string `json:"ODFIIdentification,omitempty"`
	// BatchNumber is assigned in ascending sequence to each batch by the ODFI or its Sending Point in a given file of entries. Since the batch number in the Batch Header Record and the Batch Control Record is the same, the ascending sequence number should be assigned by batch and not by record.
	BatchNumber string `json:"batchNumber,omitempty"`
}

type BatchHeader 

type BatchHeader struct {
	// Batch Header ID
	Id string `json:"id,omitempty"`
	// Service Class Code - ACH Credits Only 220 and ACH Debits Only 225
	ServiceClassCode int32 `json:"serviceClassCode"`
	// Company originating the entries in the batch
	CompanyName string `json:"companyName"`
	// The 9 digit FEIN number (proceeded by a predetermined alpha or numeric character) of the entity in the company name field
	CompanyDiscretionaryData string `json:"companyDiscretionaryData,omitempty"`
	// Identifies the payment type (product) found within an ACH batch-using a 3-character code.
	StandardEntryClassCode string `json:"standardEntryClassCode,omitempty"`
	// A description of the entries contained in the batch. The Originator establishes the value of this field to provide a description of the purpose of the entry to be displayed back to the receive For example, \"GAS BILL,\" \"REG. SALARY,\" \"INS. PREM,\", \"SOC. SEC.,\" \"DTC,\" \"TRADE PAY,\" \"PURCHASE,\" etc. This field must contain the word \"REVERSAL\" (left justified) when the batch contains reversing entries. This field must contain the word \"RECLAIM\" (left justified) when the batch contains reclamation entries. This field must contain the word \"NONSETTLED\" (left justified) when the batch contains entries which could not settle.
	CompanyEntryDescription string `json:"companyEntryDescription,omitempty"`
	// The Originator establishes this field as the date it would like to see displayed to the receiver for descriptive purposes. This field is never used to control timing of any computer or manual operation. It is solely for descriptive purposes. The RDFI should not assume any specific format.
	CompanyDescriptiveDate string `json:"companyDescriptiveDate,omitempty"`
	// Date on which the entries are to settle. Format YYMMDD (Y=Year, M=Month, D=Day)
	EffectiveEntryDate string `json:"effectiveEntryDate,omitempty"`
	// ODFI initiating the Entry. 0 ADV File prepared by an ACH Operator. 1 This code identifies the Originator as a depository financial institution. 2 This code identifies the Originator as a Federal Government entity or agency.
	OriginatorStatusCode int32 `json:"originatorStatusCode,omitempty"`
	// First 8 digits of the originating DFI transit routing number
	ODFIIdentification string `json:"ODFIIdentification"`
	// BatchNumber is assigned in ascending sequence to each batch by the ODFI or its Sending Point in a given file of entries. Since the batch number in the Batch Header Record and the Batch Control Record is the same, the ascending sequence number should be assigned by batch and not by record.
	BatchNumber string `json:"batchNumber,omitempty"`
}

type CheckOAuthClientCredentialsOpts 

type CheckOAuthClientCredentialsOpts struct {
	XRequestId optional.String
}

type CheckUserLoginOpts 

type CheckUserLoginOpts struct {
	XRequestId optional.String
}

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"`
	HTTPClient    *http.Client
}

func NewConfiguration 

func NewConfiguration() *Configuration

func (*Configuration) AddDefaultHeader 

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

type ConfirmMicroDepositsOpts 

type ConfirmMicroDepositsOpts struct {
	XIdempotencyKey optional.String
	XRequestId      optional.String
}

type CreateAccount 

type CreateAccount struct {
	// Caller defined label for this account.
	Name string `json:"name"`
	// Product type of the account
	Type string `json:"type"`
}

type CreateAccountOpts 

type CreateAccountOpts struct {
	XRequestId optional.String
}

type CreateAddress 

type CreateAddress struct {
	Type string `json:"type"`
	// First line of the address
	Address1 string `json:"address1"`
	// Second line of the address
	Address2 string `json:"address2"`
	City     string `json:"city"`
	// two charcer code of US state
	State      string `json:"state"`
	PostalCode string `json:"postalCode"`
	Country    string `json:"country"`
}

type CreateCustomer 

type CreateCustomer struct {
	// Given Name or First Name
	FirstName string `json:"firstName,omitempty"`
	// Surname or Last Name
	LastName string `json:"lastName,omitempty"`
	// Primary email address of customer name@domain.com
	Email     string          `json:"email,omitempty"`
	Phones    []CreatePhone   `json:"phones,omitempty"`
	Addresses []CreateAddress `json:"addresses,omitempty"`
}

type CreateCustomerOpts 

type CreateCustomerOpts struct {
	XRequestId optional.String
}

type CreateDepository 

type CreateDepository struct {
	// Legal name of the financial institution.
	BankName string `json:"bankName"`
	// Legal holder name on the account
	Holder string `json:"holder"`
	// Defines the type of entity of the account holder as an *individual* or *company*
	HolderType string `json:"holderType"`
	// Defines the account as *checking* or *savings*
	Type string `json:"type"`
	// The ABA routing transit number for the depository account.
	RoutingNumber string `json:"routingNumber"`
	// The account number for the depository account
	AccountNumber string `json:"accountNumber"`
	// Additional meta data to be used for display only
	Metadata string `json:"metadata,omitempty"`
}

type CreateFile 

type CreateFile struct {
	// File ID
	Id          string      `json:"id,omitempty"`
	FileHeader  FileHeader  `json:"fileHeader"`
	Batches     []Batch     `json:"batches,omitempty"`
	IATBatches  []IatBatch  `json:"IATBatches,omitempty"`
	FileControl FileControl `json:"fileControl,omitempty"`
}

type CreateFileOpts 

type CreateFileOpts struct {
	XRequestId      optional.String
	XIdempotencyKey optional.String
}

type CreateGateway 

type CreateGateway struct {
	// Routing Number - four digit Federal Reserve Routing Symbol and the four digit ABA Institution Identifier
	Origin string `json:"origin"`
	// Legal name associated with the origin routing number.
	OriginName string `json:"originName"`
	// Routing Number - four digit Federal Reserve Routing Symbol and the four digit ABA Institution Identifier
	Destination string `json:"destination"`
	// Legal name associated with the destination routing number
	DestinationName string `json:"destinationName"`
}

type CreateOAuth2ClientOpts 

type CreateOAuth2ClientOpts struct {
	XRequestId      optional.String
	XIdempotencyKey optional.String
}

type CreateOAuth2TokenOpts 

type CreateOAuth2TokenOpts struct {
	XRequestId      optional.String
	XIdempotencyKey optional.String
	GrantType       optional.String
	ClientId        optional.String
	ClientSecret    optional.String
}

type CreateOriginator 

type CreateOriginator struct {
	// The depository account to be used by default per transfer. ID must be a valid Originator Depository account
	DefaultDepository string `json:"defaultDepository"`
	// An identification number by which the receiver is known to the originator.
	Identification string `json:"identification"`
	// Additional meta data to be used for display only
	Metadata string `json:"metadata,omitempty"`
}

type CreatePhone 

type CreatePhone struct {
	// phone number
	Number string `json:"number"`
	Type   string `json:"type"`
}

type CreateReceiver 

type CreateReceiver struct {
	// The receivers email address
	Email string `json:"email"`
	// The depository account to be used by default per transfer. ID must be a valid Receiver Depository account
	DefaultDepository string `json:"defaultDepository"`
	// Additional meta data to be used for display only
	Metadata string `json:"metadata,omitempty"`
}

type CreateTransfer 

type CreateTransfer struct {
	// Type of transaction being actioned against the receiving institution. Expected values are pull (debits) or push (credits).
	TransferType string `json:"transferType,omitempty"`
	// Amount of money. USD - United States.
	Amount string `json:"amount"`
	// ID of the Originator account initiating the transfer.
	Originator string `json:"originator"`
	// ID of the Originator Depository to be be used to override the default depository.
	OriginatorDepository string `json:"originatorDepository,omitempty"`
	// ID of the Receiver account the transfer was sent to.
	Receiver string `json:"receiver"`
	// ID of the Receiver Depository to be used to override the default depository
	ReceiverDepository string `json:"receiverDepository,omitempty"`
	// Brief description of the transaction, that may appear on the receiving entity’s financial statement
	Description string `json:"description"`
	// Standard Entry Class code will be generated based on Receiver type for CCD and PPD
	StandardEntryClassCode string `json:"standardEntryClassCode,omitempty"`
	// When set to true this indicates the transfer should be processed the same day if possible.
	SameDay   bool      `json:"sameDay,omitempty"`
	WEBDetail WebDetail `json:"WEBDetail,omitempty"`
	IATDetail IatDetail `json:"IATDetail,omitempty"`
}

type CreateUser 

type CreateUser struct {
	// Email address associated to the User
	Email string `json:"email"`
	// Password associated to User
	Password string `json:"password"`
	// Legal first name
	FirstName string `json:"firstName"`
	// Legal last name
	LastName string `json:"lastName"`
	// Phone number associated to user. Dots, hyphens and spaces are trimmed. +1 is the assumed country code.
	Phone string `json:"phone"`
	// Company URL associated to user
	CompanyUrl string `json:"companyUrl,omitempty"`
}

type CreateUserOpts 

type CreateUserOpts struct {
	XRequestId      optional.String
	XIdempotencyKey optional.String
}

type Customer 

type Customer struct {
	// The unique identifier for the customer who owns the account
	CustomerId string `json:"customerId,omitempty"`
	// Given Name or First Name
	FirstName string `json:"firstName,omitempty"`
	// Middle Name
	MiddleName string `json:"middleName,omitempty"`
	// Surname or Last Name
	LastName string `json:"lastName,omitempty"`
	// Name Customer is preferred to be called
	NickName string `json:"nickName,omitempty"`
	// Customers name suffix. \"Jr\", \"PH.D.\"
	Suffix string `json:"suffix,omitempty"`
	// Legal date of birth
	BirthDate time.Time `json:"birthDate,omitempty"`
	Gender    string    `json:"gender,omitempty"`
	// Used for localization of documents
	Culture string `json:"culture,omitempty"`
	// State of the customer
	Status string `json:"status,omitempty"`
	// Primary email address of customer name@domain.com
	Email     string     `json:"email,omitempty"`
	Phones    []Phone    `json:"phones,omitempty"`
	Addresses []Address2 `json:"addresses,omitempty"`
	CreatedAt time.Time  `json:"createdAt,omitempty"`
	// Last time the object was modified
	LastModified time.Time `json:"lastModified,omitempty"`
}

type DeleteACHFileOpts 

type DeleteACHFileOpts struct {
	XRequestId optional.String
}

type DeleteDepositoryOpts 

type DeleteDepositoryOpts struct {
	XRequestId optional.String
}

type DeleteFileBatchOpts 

type DeleteFileBatchOpts struct {
	XRequestId optional.String
}

type DeleteOriginatorOpts 

type DeleteOriginatorOpts struct {
	XRequestId optional.String
}

type DeleteReceiverOpts 

type DeleteReceiverOpts struct {
	Authorization optional.String
	XRequestId    optional.String
}

type DeleteTransferByIDOpts 

type DeleteTransferByIDOpts struct {
	XRequestId optional.String
}

type DepositoriesApiService 

type DepositoriesApiService service

func (*DepositoriesApiService) AddDepository 

func (a *DepositoriesApiService) AddDepository(ctx context.Context, createDepository CreateDepository, localVarOptionals *AddDepositoryOpts) (Depository, *http.Response, error)

func (*DepositoriesApiService) ConfirmMicroDeposits 

func (a *DepositoriesApiService) ConfirmMicroDeposits(ctx context.Context, depositoryId string, amounts Amounts, localVarOptionals *ConfirmMicroDepositsOpts) (*http.Response, error)

func (*DepositoriesApiService) DeleteDepository 

func (a *DepositoriesApiService) DeleteDepository(ctx context.Context, depositoryId string, localVarOptionals *DeleteDepositoryOpts) (*http.Response, error)

func (*DepositoriesApiService) GetDepositories 

func (a *DepositoriesApiService) GetDepositories(ctx context.Context, localVarOptionals *GetDepositoriesOpts) ([]Depository, *http.Response, error)

func (*DepositoriesApiService) GetDepositoryByID 

func (a *DepositoriesApiService) GetDepositoryByID(ctx context.Context, depositoryId string, localVarOptionals *GetDepositoryByIDOpts) (Depository, *http.Response, error)

func (*DepositoriesApiService) InitiateMicroDeposits 

func (a *DepositoriesApiService) InitiateMicroDeposits(ctx context.Context, depositoryId string, localVarOptionals *InitiateMicroDepositsOpts) (*http.Response, error)

func (*DepositoriesApiService) UpdateDepository 

func (a *DepositoriesApiService) UpdateDepository(ctx context.Context, depositoryId string, createDepository CreateDepository, localVarOptionals *UpdateDepositoryOpts) (Depository, *http.Response, error)

type Depository 

type Depository struct {
	// Depository ID
	Id string `json:"id,omitempty"`
	// Legal name of the financial institution.
	BankName string `json:"bankName,omitempty"`
	// Legal holder name on the account
	Holder string `json:"holder"`
	// Defines the type of entity of the account holder as an *individual* or *company*
	HolderType string `json:"holderType"`
	// Defines the account as *checking* or *savings*
	Type string `json:"type"`
	// The ABA routing transit number for the depository account.
	RoutingNumber string `json:"routingNumber"`
	// The account number for the depository account
	AccountNumber string `json:"accountNumber"`
	// Defines the status of the Depository account
	Status string `json:"status,omitempty"`
	// Additional meta data to be used for display only
	Metadata string    `json:"metadata,omitempty"`
	Created  time.Time `json:"created,omitempty"`
	Updated  time.Time `json:"updated,omitempty"`
}

type Download 

type Download struct {
	SDNs      int32     `json:"SDNs,omitempty"`
	AltNames  int32     `json:"altNames,omitempty"`
	Addresses int32     `json:"addresses,omitempty"`
	Timestamp time.Time `json:"timestamp,omitempty"`
}

Metadata and stats about downloaded OFAC data

type EntryDetail 

type EntryDetail struct {
	// Entry Detail ID
	Id string `json:"id"`
	// transactionCode if the receivers account is: Credit (deposit) to checking account 22 Prenote for credit to checking account 23 Debit (withdrawal) to checking account 27 Prenote for debit to checking account 28 Credit to savings account 32 Prenote for credit to savings account 33 Debit to savings account 37 Prenote for debit to savings account 38
	TransactionCode int32 `json:"transactionCode"`
	// RDFI's routing number without the last digit.
	RDFIIdentification string `json:"RDFIIdentification"`
	// Last digit in RDFI routing number.
	CheckDigit string `json:"checkDigit"`
	// The receiver's bank account number you are crediting/debiting. It important to note that this is an alphanumeric field, so its space padded, no zero padded
	DFIAccountNumber string `json:"DFIAccountNumber"`
	// Number of cents you are debiting/crediting this account
	Amount int32 `json:"amount"`
	// Internal identification (alphanumeric) that you use to uniquely identify this Entry Detail Record
	IdentificationNumber string `json:"identificationNumber,omitempty"`
	// The name of the receiver, usually the name on the bank account
	IndividualName string `json:"individualName"`
	// DiscretionaryData allows ODFIs to include codes, of significance only to them, to enable specialized handling of the entry. There will be no standardized interpretation for the value of this field. It can either be a single two-character code, or two distinct one-character codes, according to the needs of the ODFI and/or Originator involved. This field must be returned intact for any returned entry. WEB uses the Discretionary Data Field as the Payment Type Code
	DiscretionaryData string `json:"discretionaryData,omitempty"`
	// AddendaRecordIndicator indicates the existence of an Addenda Record. A value of \"1\" indicates that one ore more addenda records follow, and \"0\" means no such record is present.
	AddendaRecordIndicator int32 `json:"addendaRecordIndicator,omitempty"`
	// TraceNumber assigned by the ODFI in ascending sequence, is included in each Entry Detail Record, Corporate Entry Detail Record, and addenda Record. Trace Numbers uniquely identify each entry within a batch in an ACH input file. In association with the Batch Number, transmission (File Creation) Date, and File ID Modifier, the Trace Number uniquely identifies an entry within a given file. For addenda Records, the Trace Number will be identical to the Trace Number in the associated Entry Detail Record, since the Trace Number is associated with an entry or item rather than a physical record.
	TraceNumber int32 `json:"traceNumber,omitempty"`
	// List of Addenda for the Entry Detail
	Addendum []Addendum `json:"addendum,omitempty"`
	// Category defines if the entry is a Forward, Return, or NOC
	Category string `json:"category,omitempty"`
}

type Error 

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

type Error2 

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

type Event 

type Event struct {
	// ID to uniquely identify a event
	Id string `json:"id,omitempty"`
	// Type of event
	Topic string `json:"topic,omitempty"`
	// A human readable description of the topic
	Message string `json:"message,omitempty"`
	Type    string `json:"type,omitempty"`
	// ID of the resource type the event was generated on behalf of.
	Resource string    `json:"resource,omitempty"`
	Created  time.Time `json:"created,omitempty"`
}

type EventsApiService 

type EventsApiService service

func (*EventsApiService) GetEventByID 

func (a *EventsApiService) GetEventByID(ctx context.Context, eventId string, localVarOptionals *GetEventByIDOpts) (Event, *http.Response, error)

func (*EventsApiService) GetEvents 

func (a *EventsApiService) GetEvents(ctx context.Context, localVarOptionals *GetEventsOpts) ([]Event, *http.Response, error)

type FEDApiService 

type FEDApiService service

func (*FEDApiService) SearchFEDACH 

func (a *FEDApiService) SearchFEDACH(ctx context.Context, localVarOptionals *SearchFEDACHOpts) (AchDictionary, *http.Response, error)

func (*FEDApiService) SearchFEDWIRE 

func (a *FEDApiService) SearchFEDWIRE(ctx context.Context, localVarOptionals *SearchFEDWIREOpts) (WireDictionary, *http.Response, error)

type File 

type File struct {
	// File ID
	Id          string      `json:"id,omitempty"`
	FileHeader  FileHeader  `json:"fileHeader,omitempty"`
	Batches     []Batch     `json:"batches,omitempty"`
	IATBatches  []IatBatch  `json:"IATBatches,omitempty"`
	FileControl FileControl `json:"fileControl,omitempty"`
}

type FileControl 

type FileControl struct {
	// Moov API File ID
	Id string `json:"id,omitempty"`
	// Count of Batches in the File
	BatchCount int32 `json:"batchCount,omitempty"`
	// BlockCount total number of records in the file (include all headers and trailer) divided by 10 (This number must be evenly divisible by 10. If not, additional records consisting of all 9’s are added to the file after the initial ‘9’ record to fill out the block 10.)
	BlockCount int32 `json:"blockCount,omitempty"`
	// Total detail and addenda records in the file
	EntryAddendaCount int32 `json:"entryAddendaCount,omitempty"`
	// EntryHash calculated in the same manner as the batch has total but includes total from entire file
	EntryHash int32 `json:"entryHash,omitempty"`
	// Accumulated Batch debit totals within the file.
	TotalDebit int32 `json:"totalDebit,omitempty"`
	// Accumulated Batch credit totals within the file.
	TotalCredit int32 `json:"totalCredit,omitempty"`
}

type FileHeader 

type FileHeader struct {
	// contains the Routing Number of the ACH Operator or sending point that is sending the file.
	ImmediateOrigin string `json:"immediateOrigin"`
	// The name of the ACH operator or sending point that is sending the file.
	ImmediateOriginName string `json:"immediateOriginName"`
	// contains the Routing Number of the ACH Operator or receiving point to which the file is being sent
	ImmediateDestination string `json:"immediateDestination"`
	// The name of the ACH or receiving point for which that file is destined.
	ImmediateDestinationName string `json:"immediateDestinationName"`
	// The File Creation Date is the date when the file was prepared by an ODFI. (Format HHMM - H=Hour, M=Minute)
	FileCreationTime string `json:"fileCreationTime,omitempty"`
	// The File Creation Time is the time when the file was prepared by an ODFI. (Format YYMMDD - Y=Year, M=Month, D=Day)
	FileCreationDate string `json:"fileCreationDate,omitempty"`
	// Incremented value for each file for RDFI's.
	FileIDModifier string `json:"fileIDModifier,omitempty"`
}

type FilesApiService 

type FilesApiService service

func (*FilesApiService) AddBatchToFile 

func (a *FilesApiService) AddBatchToFile(ctx context.Context, fileId string, batch Batch, localVarOptionals *AddBatchToFileOpts) (*http.Response, error)

func (*FilesApiService) CreateFile 

func (a *FilesApiService) CreateFile(ctx context.Context, createFile CreateFile, localVarOptionals *CreateFileOpts) (File, *http.Response, error)

func (*FilesApiService) DeleteACHFile 

func (a *FilesApiService) DeleteACHFile(ctx context.Context, fileId string, localVarOptionals *DeleteACHFileOpts) (*http.Response, error)

func (*FilesApiService) DeleteFileBatch 

func (a *FilesApiService) DeleteFileBatch(ctx context.Context, fileId string, batchId string, localVarOptionals *DeleteFileBatchOpts) (*http.Response, error)

func (*FilesApiService) GetFileBatch 

func (a *FilesApiService) GetFileBatch(ctx context.Context, fileId string, batchId string, localVarOptionals *GetFileBatchOpts) (Batch, *http.Response, error)

func (*FilesApiService) GetFileBatches 

func (a *FilesApiService) GetFileBatches(ctx context.Context, fileId string, localVarOptionals *GetFileBatchesOpts) ([]Batch, *http.Response, error)

func (*FilesApiService) GetFileByID 

func (a *FilesApiService) GetFileByID(ctx context.Context, fileId string, localVarOptionals *GetFileByIDOpts) (File, *http.Response, error)

func (*FilesApiService) GetFileContents 

func (a *FilesApiService) GetFileContents(ctx context.Context, fileId string, localVarOptionals *GetFileContentsOpts) (string, *http.Response, error)

func (*FilesApiService) GetFiles 

func (a *FilesApiService) GetFiles(ctx context.Context, localVarOptionals *GetFilesOpts) ([]File, *http.Response, error)

func (*FilesApiService) UpdateFile 

func (a *FilesApiService) UpdateFile(ctx context.Context, fileId string, createFile CreateFile, localVarOptionals *UpdateFileOpts) (File, *http.Response, error)

func (*FilesApiService) ValidateFile 

func (a *FilesApiService) ValidateFile(ctx context.Context, fileId string, localVarOptionals *ValidateFileOpts) (File, *http.Response, error)

type GLApiService 

type GLApiService service

func (*GLApiService) CreateAccount 

func (a *GLApiService) CreateAccount(ctx context.Context, customerId string, xUserId string, createAccount CreateAccount, localVarOptionals *CreateAccountOpts) (Account, *http.Response, error)

func (*GLApiService) CreateCustomer 

func (a *GLApiService) CreateCustomer(ctx context.Context, xUserId string, localVarOptionals *CreateCustomerOpts) (CreateCustomer, *http.Response, error)

func (*GLApiService) GetAccountsByCustomerID 

func (a *GLApiService) GetAccountsByCustomerID(ctx context.Context, customerId string, xUserId string, localVarOptionals *GetAccountsByCustomerIDOpts) ([]Account, *http.Response, error)

func (*GLApiService) GetGLCustomer 

func (a *GLApiService) GetGLCustomer(ctx context.Context, customerId string, xUserId string, localVarOptionals *GetGLCustomerOpts) (Customer, *http.Response, error)

func (*GLApiService) SearchAccounts 

func (a *GLApiService) SearchAccounts(ctx context.Context, number string, routingNumber string, type_ string, xUserId string, localVarOptionals *SearchAccountsOpts) (Account, *http.Response, error)

type Gateway 

type Gateway struct {
	// ID to uniquely identify a gateway
	Id string `json:"id"`
	// Routing Number - four digit Federal Reserve Routing Symbol and the four digit ABA Institution Identifier
	Origin string `json:"origin"`
	// Legal name associated with the origin routing number.
	OriginName string `json:"originName"`
	// Routing Number - four digit Federal Reserve Routing Symbol and the four digit ABA Institution Identifier
	Destination string `json:"destination"`
	// Legal name associated with the destination routing number
	DestinationName string    `json:"destinationName"`
	Created         time.Time `json:"created,omitempty"`
}

type GatewaysApiService 

type GatewaysApiService service

func (*GatewaysApiService) AddGateway 

func (a *GatewaysApiService) AddGateway(ctx context.Context, createGateway CreateGateway, localVarOptionals *AddGatewayOpts) (Gateway, *http.Response, error)

func (*GatewaysApiService) GetGateways 

func (a *GatewaysApiService) GetGateways(ctx context.Context, localVarOptionals *GetGatewaysOpts) ([]Gateway, *http.Response, 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 GetAccountsByCustomerIDOpts 

type GetAccountsByCustomerIDOpts struct {
	XRequestId optional.String
}

type GetClientsForUserIdOpts 

type GetClientsForUserIdOpts struct {
	XRequestId      optional.String
	XIdempotencyKey optional.String
}

type GetCustomerOpts 

type GetCustomerOpts struct {
	XRequestId optional.String
}

type GetDepositoriesByIDOpts 

type GetDepositoriesByIDOpts struct {
	Offset     optional.Int32
	Limit      optional.Int32
	XRequestId optional.String
}

type GetDepositoriesByReceiverIDOpts 

type GetDepositoriesByReceiverIDOpts struct {
	Offset     optional.Int32
	Limit      optional.Int32
	XRequestId optional.String
}

type GetDepositoriesOpts 

type GetDepositoriesOpts struct {
	Offset     optional.Int32
	Limit      optional.Int32
	XRequestId optional.String
}

type GetDepositoryByIDOpts 

type GetDepositoryByIDOpts struct {
	Offset     optional.Int32
	Limit      optional.Int32
	XRequestId optional.String
}

type GetEventByIDOpts 

type GetEventByIDOpts struct {
	Offset     optional.Int32
	Limit      optional.Int32
	XRequestId optional.String
}

type GetEventsOpts 

type GetEventsOpts struct {
	Offset     optional.Int32
	Limit      optional.Int32
	StartDate  optional.Time
	EndDate    optional.Time
	XRequestId optional.String
}

type GetFileBatchOpts 

type GetFileBatchOpts struct {
	XRequestId optional.String
}

type GetFileBatchesOpts 

type GetFileBatchesOpts struct {
	XRequestId optional.String
}

type GetFileByIDOpts 

type GetFileByIDOpts struct {
	XRequestId optional.String
}

type GetFileContentsOpts 

type GetFileContentsOpts struct {
	XRequestId optional.String
}

type GetFilesOpts 

type GetFilesOpts struct {
	XRequestId optional.String
}

type GetGLCustomerOpts 

type GetGLCustomerOpts struct {
	XRequestId optional.String
}

type GetGatewaysOpts 

type GetGatewaysOpts struct {
	XRequestId optional.String
}

type GetLatestDownloadsOpts 

type GetLatestDownloadsOpts struct {
	Limit optional.Int32
}

type GetOriginatorByIDOpts 

type GetOriginatorByIDOpts struct {
	XRequestId optional.String
	Offset     optional.Int32
	Limit      optional.Int32
}

type GetOriginatorsOpts 

type GetOriginatorsOpts struct {
	XRequestId optional.String
	Offset     optional.Int32
	Limit      optional.Int32
}

type GetReceiverByIDOpts 

type GetReceiverByIDOpts struct {
	Offset     optional.Int32
	Limit      optional.Int32
	XRequestId optional.String
}

type GetReceiversOpts 

type GetReceiversOpts struct {
	Offset     optional.Int32
	Limit      optional.Int32
	XRequestId optional.String
}

type GetSDNAddressesOpts 

type GetSDNAddressesOpts struct {
	XRequestId optional.String
}

type GetSDNAltNamesOpts 

type GetSDNAltNamesOpts struct {
	XRequestId optional.String
}

type GetSDNOpts 

type GetSDNOpts struct {
	XRequestId optional.String
}

type GetTransferByIDOpts 

type GetTransferByIDOpts struct {
	Offset     optional.Int32
	Limit      optional.Int32
	XRequestId optional.String
}

type GetTransferEventsByIDOpts 

type GetTransferEventsByIDOpts struct {
	Offset     optional.Int32
	Limit      optional.Int32
	XRequestId optional.String
}

type GetTransferFilesOpts 

type GetTransferFilesOpts struct {
	XRequestId      optional.String
	XIdempotencyKey optional.String
}

type GetTransferNachaCodeOpts 

type GetTransferNachaCodeOpts struct {
	XRequestId      optional.String
	XIdempotencyKey optional.String
}

type GetTransfersOpts 

type GetTransfersOpts struct {
	Offset     optional.Int32
	Limit      optional.Int32
	StartDate  optional.Time
	EndDate    optional.Time
	XRequestId optional.String
}

type IatBatch 

type IatBatch struct {
	// Client defined string used as a reference to this record.
	Id             string         `json:"id,omitempty"`
	IATBatchHeader IatBatchHeader `json:"IATBatchHeader,omitempty"`
}

type IatBatchHeader 

type IatBatchHeader struct {
	// ID is a client defined string used as a reference to this record.
	Id string `json:"id,omitempty"`
	// ServiceClassCode ACH Mixed Debits and Credits ‘200’ ACH Credits Only ‘220’ ACH Debits Only ‘225'
	ServiceClassCode int32 `json:"serviceClassCode,omitempty"`
	// Leave Blank. Only used for corrected IAT entries
	IATIndicator string `json:"IATIndicator,omitempty"`
	// Code indicating currency conversion. FV Fixed-to-Variable – Entry is originated in a fixed-value amount and is to be received in a variable amount resulting from the execution of the foreign exchange conversion. VF Variable-to-Fixed – Entry is originated in a variable-value amount based on a specific foreign exchange rate for conversion to a fixed-value amount in which the entry is to be received. FF Fixed-to-Fixed – Entry is originated in a fixed-value amount and is to be received in the same fixed-value amount in the same currency denomination. There is no foreign exchange conversion for entries transmitted using this code. For entries originated in a fixed value amount, the foreign Exchange Reference Field will be space filled.
	ForeignExchangeIndicator string `json:"foreignExchangeIndicator,omitempty"`
	// Code used to indicate the content of the Foreign Exchange Reference Field and is filled by the gateway operator. Valid entries are 1 - Foreign Exchange Rate; 2 - Foreign Exchange Reference Number; or 3 - Space Filled
	ForeignExchangeReferenceIndicator int32 `json:"foreignExchangeReferenceIndicator,omitempty"`
	// Contains either the foreign exchange rate used to execute the foreign exchange conversion of a cross-border entry or another reference to the foreign exchange transaction.
	ForeignExchangeReference string `json:"foreignExchangeReference,omitempty"`
	// Two-character code, as approved by the International Organization for Standardization (ISO), to identify the country in which the entry is to be received. For United States use US.
	ISODestinationCountryCode string `json:"ISODestinationCountryCode,omitempty"`
	// For U.S. entities: the number assigned will be your tax ID (often Social Security Number) For non-U.S. entities: the number assigned will be your DDA number, or the last 9 characters of your account number if it exceeds 9 characters
	OriginatorIdentification string `json:"originatorIdentification,omitempty"`
	// StandardEntryClassCode for consumer and non consumer international payments is IAT. Identifies the payment type (product) found within an ACH batch-using a 3-character code. The SEC Code pertains to all items within batch. Determines format of the detail records. Determines addenda records (required or optional PLUS one or up to 9,999 records). Determines rules to follow (return time frames). Some SEC codes require specific data in predetermined fields within the ACH record
	StandardEntryClassCode string `json:"standardEntryClassCode,omitempty"`
	// A description of the entries contained in the batch The Originator establishes the value of this field to provide a description of the purpose of the entry to be displayed back to the receive For example, \"GAS BILL,\" \"REG. SALARY,\" \"INS. PREM,\" \"SOC. SEC.,\" \"DTC,\" \"TRADE PAY,\" \"PURCHASE,\" etc. This field must contain the word \"REVERSAL\" (left justified) when the batch contains reversing entries. This field must contain the word \"RECLAIM\" (left justified) when the batch contains reclamation entries. This field must contain the word \"NONSETTLED\" (left justified) when the batch contains entries which could not settle.
	CompanyEntryDescription string `json:"companyEntryDescription,omitempty"`
	// Three-character code, as approved by the International Organization for Standardization (ISO), to identify the currency denomination in which the entry was first originated. If the source of funds is within the territorial jurisdiction of the U.S., enter 'USD', otherwise refer to International Organization for Standardization website for value: www.iso.org
	ISOOriginatingCurrencyCode string `json:"ISOOriginatingCurrencyCode,omitempty"`
	// ISODestinationCurrencyCode is the three-character code, as approved by the International Organization for Standardization (ISO), to identify the currency denomination in which the entry will ultimately be settled. If the final destination of funds is within the territorial jurisdiction of the U.S., enter “USD”, otherwise refer to International Organization for Standardization website for value: www.iso.org
	ISODestinationCurrencyCode string `json:"ISODestinationCurrencyCode,omitempty"`
	// EffectiveEntryDate the date on which the entries are to settle format YYMMDD (Y=Year, M=Month, D=Day)
	EffectiveEntryDate string `json:"effectiveEntryDate,omitempty"`
	// SettlementDate Leave blank, this field is inserted by the ACH operator settlementDate string OriginatorStatusCode refers to the ODFI initiating the Entry. 0 ADV File prepared by an ACH Operator. 1 This code identifies the Originator as a depository financial institution. 2 This code identifies the Originator as a Federal Government entity or agency.
	OriginatorStatusCode int32 `json:"originatorStatusCode,omitempty"`
	// ODFIIdentification First 8 digits of the originating DFI transit routing number for Inbound IAT Entries, this field contains the routing number of the U.S. Gateway Operator.  For Outbound IAT Entries, this field contains the standard routing number, as assigned by Accuity, that identifies the U.S. ODFI initiating the Entry. Format - TTTTAAAA
	ODFIIdentification string `json:"ODFIIdentification,omitempty"`
	// BatchNumber is assigned in ascending sequence to each batch by the ODFI or its Sending Point in a given file of entries. Since the batch number in the Batch Header Record and the Batch Control Record is the same, the ascending sequence number should be assigned by batch and not by record.
	BatchNumber int32 `json:"batchNumber,omitempty"`
}

type IatDetail 

type IatDetail struct {
	// Name of originating entity
	OriginatorName string `json:"originatorName,omitempty"`
	// Address of originating entity
	OriginatorAddress string `json:"originatorAddress,omitempty"`
	// City of originating entity
	OriginatorCity string `json:"originatorCity,omitempty"`
	// State of originating entity
	OriginatorState string `json:"originatorState,omitempty"`
	// Postal code of originating entity
	OriginatorPostalCode string `json:"originatorPostalCode,omitempty"`
	// ISO 3166 Country code of originating entity
	OriginatorCountryCode string `json:"originatorCountryCode,omitempty"`
	// Name of originating financial institution
	ODFIName string `json:"ODFIName,omitempty"`
	// ID qualifier number of originating FI
	ODFIIDNumberQualifier string `json:"ODFIIDNumberQualifier,omitempty"`
	// Identification of originating FI
	ODFIIdentification string `json:"ODFIIdentification,omitempty"`
	// ISO 4217 currency code of originating entity
	ODFIBranchCurrencyCode string `json:"ODFIBranchCurrencyCode,omitempty"`
	// Name of receiving entity
	ReceiverName string `json:"receiverName,omitempty"`
	// Address of originating entity
	ReceiverAddress string `json:"receiverAddress,omitempty"`
	// City of originating entity
	ReceiverCity string `json:"receiverCity,omitempty"`
	// State of originating entity
	ReceiverState string `json:"receiverState,omitempty"`
	// Postal code of originating entity
	ReceiverPostalCode string `json:"receiverPostalCode,omitempty"`
	// ISO 3166 country code of originating entity
	ReceiverCountryCode string `json:"receiverCountryCode,omitempty"`
	// Name of receiving financial institution
	RDFIName string `json:"RDFIName,omitempty"`
	// ID qualifier number of originating FI
	RDFIIDNumberQualifier string `json:"RDFIIDNumberQualifier,omitempty"`
	// Identification of receiving financial institution
	RDFIIdentification string `json:"RDFIIdentification,omitempty"`
	// ISO 4217 currency code of receiving entity
	RDFIBranchCurrencyCode string `json:"RDFIBranchCurrencyCode,omitempty"`
	// Name of foreign bank used in IAT transfer
	ForeignCorrespondentBankName string `json:"foreignCorrespondentBankName,omitempty"`
	// ID qualifier of foreign bank used
	ForeignCorrespondentBankIDNumberQualifier string `json:"foreignCorrespondentBankIDNumberQualifier,omitempty"`
	// ID number of foreign bank used
	ForeignCorrespondentBankIDNumber string `json:"foreignCorrespondentBankIDNumber,omitempty"`
	// ISO 3166 country code of foreign bank used
	ForeignCorrespondentBankBranchCountryCode string `json:"foreignCorrespondentBankBranchCountryCode,omitempty"`
}

type InitiateMicroDepositsOpts 

type InitiateMicroDepositsOpts struct {
	XIdempotencyKey optional.String
	XRequestId      optional.String
}

type Login 

type Login struct {
	// Email address associated to the User
	Email string `json:"email,omitempty"`
	// Password associated to User
	Password string `json:"password,omitempty"`
}

type MonitorApiService 

type MonitorApiService service

func (*MonitorApiService) PingACH 

func (a *MonitorApiService) PingACH(ctx context.Context, localVarOptionals *PingACHOpts) (*http.Response, error)

func (*MonitorApiService) PingAuth 

func (a *MonitorApiService) PingAuth(ctx context.Context, localVarOptionals *PingAuthOpts) (*http.Response, error)

func (*MonitorApiService) PingFED 

func (a *MonitorApiService) PingFED(ctx context.Context, localVarOptionals *PingFEDOpts) (*http.Response, error)

func (*MonitorApiService) PingGL 

func (a *MonitorApiService) PingGL(ctx context.Context, localVarOptionals *PingGLOpts) (*http.Response, error)

func (*MonitorApiService) PingOFAC 

func (a *MonitorApiService) PingOFAC(ctx context.Context, localVarOptionals *PingOFACOpts) (*http.Response, error)

func (*MonitorApiService) PingPaygate 

func (a *MonitorApiService) PingPaygate(ctx context.Context, localVarOptionals *PingPaygateOpts) (*http.Response, error)

type OAuth2ApiService 

type OAuth2ApiService service

func (*OAuth2ApiService) CheckOAuthClientCredentials 

func (a *OAuth2ApiService) CheckOAuthClientCredentials(ctx context.Context, authorization string, localVarOptionals *CheckOAuthClientCredentialsOpts) (*http.Response, error)

func (*OAuth2ApiService) CreateOAuth2Client 

func (a *OAuth2ApiService) CreateOAuth2Client(ctx context.Context, localVarOptionals *CreateOAuth2ClientOpts) ([]OAuth2Client, *http.Response, error)

func (*OAuth2ApiService) CreateOAuth2Token 

func (a *OAuth2ApiService) CreateOAuth2Token(ctx context.Context, localVarOptionals *CreateOAuth2TokenOpts) (OAuth2Token, *http.Response, error)

func (*OAuth2ApiService) GetClientsForUserId 

func (a *OAuth2ApiService) GetClientsForUserId(ctx context.Context, localVarOptionals *GetClientsForUserIdOpts) ([]OAuth2Client, *http.Response, error)

type OAuth2Client 

type OAuth2Client struct {
	// OAuth2 client ID
	ClientId string `json:"client_id,omitempty"`
	// OAuth2 client secret
	ClientSecret string `json:"client_secret,omitempty"`
	// HTTP domain for OAuth credentials
	Domain string `json:"domain,omitempty"`
}

type OAuth2Token 

type OAuth2Token struct {
	// OAuth2 Bearer access token
	AccessToken string `json:"access_token,omitempty"`
	// Hours until access_token expires
	ExpiresIn int32  `json:"expires_in,omitempty"`
	TokenType string `json:"token_type,omitempty"`
}

type OFACApiService 

type OFACApiService service

func (*OFACApiService) AddCustomerNameWatch 

func (a *OFACApiService) AddCustomerNameWatch(ctx context.Context, name string, watchRequest WatchRequest, localVarOptionals *AddCustomerNameWatchOpts) (Watch, *http.Response, error)

func (*OFACApiService) AddCustomerWatch 

func (a *OFACApiService) AddCustomerWatch(ctx context.Context, customerId string, watchRequest WatchRequest, localVarOptionals *AddCustomerWatchOpts) (Watch, *http.Response, error)

func (*OFACApiService) GetCustomer 

func (a *OFACApiService) GetCustomer(ctx context.Context, customerId string, localVarOptionals *GetCustomerOpts) (OfacCustomer, *http.Response, error)

func (*OFACApiService) GetLatestDownloads 

func (a *OFACApiService) GetLatestDownloads(ctx context.Context, localVarOptionals *GetLatestDownloadsOpts) ([]Download, *http.Response, error)

func (*OFACApiService) GetSDN 

func (a *OFACApiService) GetSDN(ctx context.Context, sdnId string, localVarOptionals *GetSDNOpts) (Sdn, *http.Response, error)

func (*OFACApiService) GetSDNAddresses 

func (a *OFACApiService) GetSDNAddresses(ctx context.Context, sdnId string, localVarOptionals *GetSDNAddressesOpts) ([]Address, *http.Response, error)

func (*OFACApiService) GetSDNAltNames 

func (a *OFACApiService) GetSDNAltNames(ctx context.Context, sdnId string, localVarOptionals *GetSDNAltNamesOpts) ([]Alt, *http.Response, error)

func (*OFACApiService) RemoveCustomerNameWatch 

func (a *OFACApiService) RemoveCustomerNameWatch(ctx context.Context, watchId string, name string, localVarOptionals *RemoveCustomerNameWatchOpts) (*http.Response, error)

func (*OFACApiService) RemoveCustomerWatch 

func (a *OFACApiService) RemoveCustomerWatch(ctx context.Context, customerId string, watchId string, localVarOptionals *RemoveCustomerWatchOpts) (*http.Response, error)

func (*OFACApiService) SearchSDNs 

func (a *OFACApiService) SearchSDNs(ctx context.Context, localVarOptionals *SearchSDNsOpts) (Search, *http.Response, error)

func (*OFACApiService) UpdateCustomerStatus 

func (a *OFACApiService) UpdateCustomerStatus(ctx context.Context, customerId string, updateCustomerStatus UpdateCustomerStatus, localVarOptionals *UpdateCustomerStatusOpts) (*http.Response, error)

type OfacCustomer 

type OfacCustomer struct {
	// OFAC Customer ID
	Id        string             `json:"id,omitempty"`
	Sdn       Sdn                `json:"sdn,omitempty"`
	Addresses []Address          `json:"addresses,omitempty"`
	Alts      []Alt              `json:"alts,omitempty"`
	Status    OfacCustomerStatus `json:"status,omitempty"`
}

OFAC Customer and metadata

type OfacCustomerStatus 

type OfacCustomerStatus struct {
	// User ID provided when updating status
	UserId string `json:"userId,omitempty"`
	// Optional note from updating status
	Note string `json:"note,omitempty"`
	// Manually applied status for OFAC Customer
	Status    string    `json:"status,omitempty"`
	CreatedAt time.Time `json:"createdAt,omitempty"`
}

Status properties of an OFAC Customer

type Originator 

type Originator struct {
	// Originator ID
	Id string `json:"id,omitempty"`
	// The depository account to be used by default per transfer. ID must be a valid Originator Depository account
	DefaultDepository string `json:"defaultDepository,omitempty"`
	// An identification number by which the receiver is known to the originator.
	Identification string `json:"identification,omitempty"`
	// Additional meta data to be used for display only
	Metadata string    `json:"metadata,omitempty"`
	Created  time.Time `json:"created,omitempty"`
	Updated  time.Time `json:"updated,omitempty"`
}

type OriginatorsApiService 

type OriginatorsApiService service

func (*OriginatorsApiService) AddOriginator 

func (a *OriginatorsApiService) AddOriginator(ctx context.Context, createOriginator CreateOriginator, localVarOptionals *AddOriginatorOpts) (Originator, *http.Response, error)

func (*OriginatorsApiService) DeleteOriginator 

func (a *OriginatorsApiService) DeleteOriginator(ctx context.Context, originatorId string, localVarOptionals *DeleteOriginatorOpts) (*http.Response, error)

func (*OriginatorsApiService) GetOriginatorByID 

func (a *OriginatorsApiService) GetOriginatorByID(ctx context.Context, originatorId string, localVarOptionals *GetOriginatorByIDOpts) (Originator, *http.Response, error)

func (*OriginatorsApiService) GetOriginators 

func (a *OriginatorsApiService) GetOriginators(ctx context.Context, localVarOptionals *GetOriginatorsOpts) ([]Originator, *http.Response, error)

func (*OriginatorsApiService) UpdateOriginator 

func (a *OriginatorsApiService) UpdateOriginator(ctx context.Context, originatorId string, createOriginator CreateOriginator, localVarOptionals *UpdateOriginatorOpts) (Originator, *http.Response, error)

type Phone 

type Phone struct {
	// phone number
	Number string `json:"number,omitempty"`
	// phone number has been validated to connect with customer
	Valid bool   `json:"valid,omitempty"`
	Type  string `json:"type,omitempty"`
}

type PingACHOpts 

type PingACHOpts struct {
	XRequestId optional.String
}

type PingAuthOpts 

type PingAuthOpts struct {
	XRequestId optional.String
}

type PingFEDOpts 

type PingFEDOpts struct {
	XRequestId optional.String
}

type PingGLOpts 

type PingGLOpts struct {
	XRequestId optional.String
}

type PingOFACOpts 

type PingOFACOpts struct {
	XRequestId optional.String
}

type PingPaygateOpts 

type PingPaygateOpts struct {
	XRequestId optional.String
}

type Receiver 

type Receiver struct {
	// Receiver ID
	Id string `json:"id,omitempty"`
	// The receivers email address
	Email string `json:"email,omitempty"`
	// The depository account to be used by default per transfer. ID must be a valid Receiver Depository account
	DefaultDepository string `json:"defaultDepository,omitempty"`
	// Defines the status of the Receiver
	Status string `json:"status,omitempty"`
	// Additional meta data to be used for display only
	Metadata string    `json:"metadata,omitempty"`
	Created  time.Time `json:"created,omitempty"`
	Updated  time.Time `json:"updated,omitempty"`
}

type ReceiversApiService 

type ReceiversApiService service

func (*ReceiversApiService) AddReceivers 

func (a *ReceiversApiService) AddReceivers(ctx context.Context, createReceiver CreateReceiver, localVarOptionals *AddReceiversOpts) (Receiver, *http.Response, error)

func (*ReceiversApiService) DeleteReceiver 

func (a *ReceiversApiService) DeleteReceiver(ctx context.Context, receiverId string, localVarOptionals *DeleteReceiverOpts) (*http.Response, error)

func (*ReceiversApiService) GetDepositoriesByID 

func (a *ReceiversApiService) GetDepositoriesByID(ctx context.Context, receiverId string, depositoryId string, localVarOptionals *GetDepositoriesByIDOpts) (Depository, *http.Response, error)

func (*ReceiversApiService) GetDepositoriesByReceiverID 

func (a *ReceiversApiService) GetDepositoriesByReceiverID(ctx context.Context, receiverId string, localVarOptionals *GetDepositoriesByReceiverIDOpts) ([]Depository, *http.Response, error)

func (*ReceiversApiService) GetReceiverByID 

func (a *ReceiversApiService) GetReceiverByID(ctx context.Context, receiverId string, localVarOptionals *GetReceiverByIDOpts) (Receiver, *http.Response, error)

func (*ReceiversApiService) GetReceivers 

func (a *ReceiversApiService) GetReceivers(ctx context.Context, localVarOptionals *GetReceiversOpts) ([]Receiver, *http.Response, error)

func (*ReceiversApiService) UpdateReceiver 

func (a *ReceiversApiService) UpdateReceiver(ctx context.Context, receiverId string, createReceiver CreateReceiver, localVarOptionals *UpdateReceiverOpts) (Receiver, *http.Response, error)

type RemoveCustomerNameWatchOpts 

type RemoveCustomerNameWatchOpts struct {
	XRequestId optional.String
}

type RemoveCustomerWatchOpts 

type RemoveCustomerWatchOpts struct {
	XRequestId optional.String
}

type Sdn 

type Sdn struct {
	EntityID string `json:"entityID,omitempty"`
	SdnName  string `json:"sdnName,omitempty"`
	// SDN's typically represent an individual (customer) or trust/company/organization. OFAC endpoints refer to customers or companies as different entities, but underlying both is the same SDN metadata.
	SdnType string `json:"sdnType,omitempty"`
	Program string `json:"program,omitempty"`
	Title   string `json:"title,omitempty"`
	Remarks string `json:"remarks,omitempty"`
	// Remarks on SDN and often additional information about the SDN
	Match float32 `json:"match,omitempty"`
}

Specially designated national from OFAC list 

type Search struct {
	SDNs      []Sdn     `json:"SDNs,omitempty"`
	AltNames  []Alt     `json:"altNames,omitempty"`
	Addresses []Address `json:"addresses,omitempty"`
}

Search results containing SDNs, alternate names and/or addreses

type SearchAccountsOpts 

type SearchAccountsOpts struct {
	XRequestId optional.String
}

type SearchFEDACHOpts 

type SearchFEDACHOpts struct {
	XRequestId    optional.String
	Name          optional.String
	RoutingNumber optional.String
	State         optional.String
	City          optional.String
	PostalCode    optional.String
	Limit         optional.Int32
}

type SearchFEDWIREOpts 

type SearchFEDWIREOpts struct {
	XRequestId    optional.String
	Name          optional.String
	RoutingNumber optional.String
	State         optional.String
	City          optional.String
	Limit         optional.Int32
}

type SearchSDNsOpts 

type SearchSDNsOpts struct {
	XRequestId optional.String
	Q          optional.String
	Name       optional.String
	Address    optional.String
	AltName    optional.String
	Limit      optional.Int32
}

type Transfer 

type Transfer struct {
	// Optional ID to uniquely identify this transfer. If omitted, one will be generated
	Id string `json:"id,omitempty"`
	// Type of transaction being actioned against the receiving institution. Expected values are pull (debits) or push (credits). Only one period used to signify decimal value will be included.
	TransferType string `json:"transferType,omitempty"`
	// Amount of money. USD - United States.
	Amount string `json:"amount"`
	// ID of the Originator account initiating the transfer.
	Originator string `json:"originator"`
	// ID of the Originator Depository to be be used to override the default depository.
	OriginatorDepository string `json:"originatorDepository,omitempty"`
	// ID of the Receiver account the transfer was sent to.
	Receiver string `json:"receiver"`
	// ID of the Receiver Depository to be used to override the default depository
	ReceiverDepository string `json:"receiverDepository,omitempty"`
	// Brief description of the transaction, that may appear on the receiving entity’s financial statement
	Description string `json:"description"`
	// Standard Entry Class code will be generated based on Receiver type for CCD and PPD
	StandardEntryClassCode string `json:"standardEntryClassCode,omitempty"`
	// Defines the state of the Transfer
	Status string `json:"status,omitempty"`
	// When set to true this indicates the transfer should be processed the same day if possible.
	SameDay   bool      `json:"sameDay,omitempty"`
	Created   time.Time `json:"created,omitempty"`
	WEBDetail WebDetail `json:"WEBDetail,omitempty"`
	IATDetail IatDetail `json:"IATDetail,omitempty"`
}

type TransfersApiService 

type TransfersApiService service

func (*TransfersApiService) AddTransfer 

func (a *TransfersApiService) AddTransfer(ctx context.Context, createTransfer CreateTransfer, localVarOptionals *AddTransferOpts) (Transfer, *http.Response, error)

func (*TransfersApiService) AddTransfers 

func (a *TransfersApiService) AddTransfers(ctx context.Context, createTransfer []CreateTransfer, localVarOptionals *AddTransfersOpts) ([]Transfer, *http.Response, error)

func (*TransfersApiService) DeleteTransferByID 

func (a *TransfersApiService) DeleteTransferByID(ctx context.Context, transferId string, localVarOptionals *DeleteTransferByIDOpts) (*http.Response, error)

func (*TransfersApiService) GetTransferByID 

func (a *TransfersApiService) GetTransferByID(ctx context.Context, transferId string, localVarOptionals *GetTransferByIDOpts) (Transfer, *http.Response, error)

func (*TransfersApiService) GetTransferEventsByID 

func (a *TransfersApiService) GetTransferEventsByID(ctx context.Context, transferId string, localVarOptionals *GetTransferEventsByIDOpts) ([]Event, *http.Response, error)

func (*TransfersApiService) GetTransferFiles 

func (a *TransfersApiService) GetTransferFiles(ctx context.Context, transferId string, localVarOptionals *GetTransferFilesOpts) ([]File, *http.Response, error)

func (*TransfersApiService) GetTransferNachaCode 

func (a *TransfersApiService) GetTransferNachaCode(ctx context.Context, transferId string, localVarOptionals *GetTransferNachaCodeOpts) (*http.Response, error)

func (*TransfersApiService) GetTransfers 

func (a *TransfersApiService) GetTransfers(ctx context.Context, localVarOptionals *GetTransfersOpts) ([]Transfer, *http.Response, error)

type UpdateCustomerStatus 

type UpdateCustomerStatus struct {
	// manual override of customer/SDN sanction status
	Status string `json:"status"`
}

Request body to update a customers status.

type UpdateCustomerStatusOpts 

type UpdateCustomerStatusOpts struct {
	XRequestId optional.String
}

type UpdateDepositoryOpts 

type UpdateDepositoryOpts struct {
	XIdempotencyKey optional.String
	XRequestId      optional.String
}

type UpdateFileOpts 

type UpdateFileOpts struct {
	XRequestId      optional.String
	XIdempotencyKey optional.String
}

type UpdateOriginatorOpts 

type UpdateOriginatorOpts struct {
	XIdempotencyKey optional.String
	XRequestId      optional.String
}

type UpdateReceiverOpts 

type UpdateReceiverOpts struct {
	XIdempotencyKey optional.String
	XRequestId      optional.String
}

type UpdateUserProfileOpts 

type UpdateUserProfileOpts struct {
	XIdempotencyKey optional.String
	XRequestId      optional.String
}

type User 

type User struct {
	// Moov API user ID
	Id string `json:"id,omitempty"`
	// Email address associated to the user
	Email     string `json:"email,omitempty"`
	FirstName string `json:"firstName,omitempty"`
	LastName  string `json:"lastName,omitempty"`
	// Phone number associated to user
	Phone string `json:"phone,omitempty"`
	// Company URL associated to user
	CompanyUrl string `json:"companyUrl,omitempty"`
	// Timestamp of when user was created
	CreatedAt time.Time `json:"createdAt,omitempty"`
}

type UserApiService 

type UserApiService service

func (*UserApiService) CheckUserLogin 

func (a *UserApiService) CheckUserLogin(ctx context.Context, localVarOptionals *CheckUserLoginOpts) (*http.Response, error)

func (*UserApiService) CreateUser 

func (a *UserApiService) CreateUser(ctx context.Context, createUser CreateUser, localVarOptionals *CreateUserOpts) (User, *http.Response, error)

func (*UserApiService) UpdateUserProfile 

func (a *UserApiService) UpdateUserProfile(ctx context.Context, userId string, userProfile UserProfile, localVarOptionals *UpdateUserProfileOpts) (*http.Response, error)

func (*UserApiService) UserLogin 

func (a *UserApiService) UserLogin(ctx context.Context, login Login, localVarOptionals *UserLoginOpts) (User, *http.Response, error)

func (*UserApiService) UserLogout 

func (a *UserApiService) UserLogout(ctx context.Context, localVarOptionals *UserLogoutOpts) (*http.Response, error)

type UserLoginOpts 

type UserLoginOpts struct {
	XRequestId      optional.String
	XIdempotencyKey optional.String
}

type UserLogoutOpts 

type UserLogoutOpts struct {
	XRequestId optional.String
}

type UserProfile 

type UserProfile struct {
	// Legal first name
	FirstName string `json:"firstName,omitempty"`
	// Legal last name
	LastName string `json:"lastName,omitempty"`
	// Phone number associated to user. Dots, hyphens and spaces are trimmed. +1 is the assumed country code.
	Phone string `json:"phone,omitempty"`
	// Company URL associated to user
	CompanyUrl string `json:"companyUrl,omitempty"`
}

type ValidateFileOpts 

type ValidateFileOpts struct {
	XRequestId optional.String
}

type Watch 

type Watch struct {
	// Object representing a customer or company watch
	WatchId string `json:"watchId,omitempty"`
}

Customer or Company watch

type WatchRequest 

type WatchRequest struct {
	// Private token supplied by clients to be used for authenticating webhooks.
	AuthToken string `json:"authToken"`
	// HTTPS url for webhook on search match
	Webhook string `json:"webhook"`
}

Webhook or other means of notification on search criteria. OFAC will make a POST request with a body of the customer (SDN, AltNames, and Address).

type WebDetail 

type WebDetail struct {
	// Metadata for the transaction, placed in addenda 05 record
	PaymentInformation string `json:"paymentInformation,omitempty"`
	// Defines if the transfer is authorized for a single transaction or reoccurring
	PaymentType string `json:"paymentType,omitempty"`
}

type WireDictionary 

type WireDictionary struct {
	WIREParticipants []WireParticipant `json:"WIREParticipants,omitempty"`
}

Search results containing WIREDictionary of Participants

type WireLocation 

type WireLocation struct {
	// City
	City string `json:"city,omitempty"`
	// State
	State string `json:"state,omitempty"`
}

WIRELocation is the FEDWIRE delivery address

type WireParticipant 

type WireParticipant struct {
	// The institution's routing number
	RoutingNumber string `json:"routingNumber,omitempty"`
	// Short name of financial institution
	TelegraphicName string `json:"telegraphicName,omitempty"`
	// Financial Institution Name
	CustomerName string `json:"customerName,omitempty"`
	// FEDWIRE Delivery Address
	WireLocation []WireLocation `json:"wireLocation,omitempty"`
	// Designates funds transfer status  * `Y` - Eligible * `N` - Ineligible
	FundsTransferStatus string `json:"fundsTransferStatus,omitempty"`
	// Designates funds settlement only status   * `S` - Settlement-Only
	FundsSettlementOnlyStatus string `json:"fundsSettlementOnlyStatus,omitempty"`
	// Designates book entry securities transfer status  * `Y` - Eligible * `N` - Ineligible
	BookEntrySecuritiesTransferStatus string `json:"bookEntrySecuritiesTransferStatus,omitempty"`
	// Date of last revision  * YYYYMMDD * Blank
	Date string `json:"date,omitempty"`
}

WIREParticipant holds a FedWIRE dir routing record as defined by Fed WIRE Format. https://frbservices.org/EPaymentsDirectory/fedwireFormat.html

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.