openapi

package
v0.3.0 Latest Latest
Warning

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

 Go to latest Published: Aug 13, 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
ACHFilesApi AddBatchToFile Post /v1/ach/files/{fileID}/batches Add Batch to File
ACHFilesApi CreateFile Post /v1/ach/files/create Create a new File object
ACHFilesApi DeleteACHFile Delete /v1/ach/files/{fileID} Permanently deletes a File and associated Batches. It cannot be undone.
ACHFilesApi DeleteFileBatch Delete /v1/ach/files/{fileID}/batches/{batchID} Delete a Batch from a File
ACHFilesApi GetFileBatch Get /v1/ach/files/{fileID}/batches/{batchID} Get a specific Batch on a FIle
ACHFilesApi GetFileBatches Get /v1/ach/files/{fileID}/batches Get the batches on a File.
ACHFilesApi GetFileByID Get /v1/ach/files/{fileID} Retrieves the details of an existing File. You need only supply the unique File identifier that was returned upon creation.
ACHFilesApi GetFileContents Get /v1/ach/files/{fileID}/contents Assembles the existing file (batches and controls) records, computes sequence numbers and totals. Returns plaintext file.
ACHFilesApi GetFiles Get /v1/ach/files Gets a list of Files
ACHFilesApi SegmentFile Post /v1/ach/files/{fileID}/segment Create a new file object
ACHFilesApi UpdateFile Post /v1/ach/files/{fileID} Updates the specified File Header by setting the values of the parameters passed. Any parameters not provided will be left unchanged.
ACHFilesApi ValidateFile Get /v1/ach/files/{fileID}/validate Validates the existing file. You need only supply the unique File identifier that was returned upon creation.
AccountsApi CreateAccount Post /v1/accounts Create a new account for a Customer
AccountsApi CreateTransaction Post /v1/accounts/transactions Post a transaction against multiple accounts. All transaction lines must sum to zero. No money is created or destroyed in a transaction - only moved from account to account. Accounts can be referred to in a Transaction without creating them first.
AccountsApi GetAccountTransactions Get /v1/accounts/{accountID}/transactions Get transactions for an account. Ordered descending from their posted date.
AccountsApi SearchAccounts Get /v1/accounts/search Search for account which matches all query parameters
CustomersApi CreateCustomer Post /v1/customers Create a new customer
CustomersApi GetCustomer Get /v1/customers/{customerID} Retrieves a Customer object associated with the customer ID.
CustomersApi GetCustomerDocumentContents Get /v1/customers/{customerID}/documents/{documentID} Retrieve the referenced document
CustomersApi GetCustomerDocuments Get /v1/customers/{customerID}/documents Get documents for a customer
CustomersApi UploadCustomerDocument Post /v1/customers/{customerID}/documents Upload a document for the given customer.
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
FEDWireMessageFileApi AddFEDWireMessageToFile Post /v1/wire/files/{fileID}/FEDWireMessage Add FEDWireMessage to File
GatewaysApi AddGateway Post /v1/ach/gateways Create a new Gateway object
GatewaysApi GetGateways Get /v1/ach/gateways Gets a list of Gatways
ImageCashLetterFilesApi AddICLToFile Post /v1/imagecashletter/files/{fileID}/cashLetters Add CashLetter to File
ImageCashLetterFilesApi CreateICLFile Post /v1/imagecashletter/files/create Create a new File object
ImageCashLetterFilesApi DeleteICLFile Delete /v1/imagecashletter/files/{fileID} Permanently deletes a File and associated CashLetters and Bundles. It cannot be undone.
ImageCashLetterFilesApi DeleteICLFromFile Delete /v1/imagecashletter/files/{fileID}/cashLetters/{cashLetterID} Delete a CashLetter from a File
ImageCashLetterFilesApi GetICLFileByID Get /v1/imagecashletter/files/{fileID} Retrieves the details of an existing File. You need only supply the unique File identifier that was returned upon creation.
ImageCashLetterFilesApi GetICLFileContents Get /v1/imagecashletter/files/{fileID}/contents Assembles the existing file (Cash Letters, Bundles and Controls) records, computes sequence numbers and totals. Returns plaintext file.
ImageCashLetterFilesApi GetICLFiles Get /v1/imagecashletter/files Gets a list of Files
ImageCashLetterFilesApi UpdateICLFile Post /v1/imagecashletter/files/{fileID} Updates the specified File Header by setting the values of the parameters passed. Any parameters not provided will be left unchanged.
ImageCashLetterFilesApi ValidateICLFile Get /v1/imagecashletter/files/{fileID}/validate Validates the existing file. You need only supply the unique File identifier that was returned upon creation.
MonitorApi PingACH Get /v1/ach/ping Check that the moov-io/ach service is running
MonitorApi PingAccounts Get /v1/accounts/ping Check that the moov-io/accounts service is running
MonitorApi PingAuth Get /v1/auth/ping Check that the moov-io/auth service is running
MonitorApi PingCustomers Get /v1/customers/ping Check that the moov-io/customers service is running
MonitorApi PingFED Get /v1/fed/ping Check that the moov-io/fed service is running
MonitorApi PingImageCashLetter Get /v1/imagecashletter/ping Check that the moov-io/imagecashletter 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 AddOFACCompanyNameWatch Post /v1/ofac/companies/watch Add company watch by name. The match percentage will be included in the webhook's JSON payload.
OFACApi AddOFACCompanyWatch Post /v1/ofac/companies/{companyID}/watch Add OFAC watch on a Company
OFACApi AddOFACCustomerNameWatch Post /v1/ofac/customers/watch Add customer watch by name. The match percentage will be included in the webhook's JSON payload.
OFACApi AddOFACCustomerWatch Post /v1/ofac/customers/{customerID}/watch Add OFAC watch on a Customer
OFACApi GetLatestDownloads Get /v1/ofac/downloads Return list of recent downloads of OFAC data
OFACApi GetOFACCompany Get /v1/ofac/companies/{companyID} Get information about a company, trust or organization such as addresses, alternate names, and remarks.
OFACApi GetOFACCustomer Get /v1/ofac/customers/{customerID} Get information about a customer, addresses, alternate names, and their SDN metadata.
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 RemoveOFACCompanyNameWatch Delete /v1/ofac/companies/watch/{watchID} Remove a Company name watch
OFACApi RemoveOFACCompanyWatch Delete /v1/ofac/companies/{companyID}/watch/{watchID} Remove company watch
OFACApi RemoveOFACCustomerNameWatch Delete /v1/ofac/customers/watch/{watchID} Remove a Customer name watch
OFACApi RemoveOFACCustomerWatch Delete /v1/ofac/customers/{customerID}/watch/{watchID} Remove customer watch
OFACApi Search Get /v1/ofac/search Search SDN names and metadata
OFACApi UpdateOFACCompanyStatus Put /v1/ofac/companies/{companyID} Update a Companies sanction status to always block or always allow transactions.
OFACApi UpdateOFACCustomerStatus 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/{userID} 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).
WireFilesApi CreateWireFile Post /v1/wire/files/create Create a new File object
WireFilesApi DeleteWireFileByID Delete /v1/wire/files/{fileID} Permanently deletes a File and associated FEDWireMessage. It cannot be undone.
WireFilesApi GetWireFileByID Get /v1/wire/files/{fileID} Retrieves the details of an existing File. You need only supply the unique File identifier that was returned upon creation.
WireFilesApi GetWireFileContents Get /v1/wire/files/{fileID}/contents Assembles the existing file witha FEDWireMessage, Returns plaintext file.
WireFilesApi GetWireFiles Get /v1/wire/files Gets a list of Files
WireFilesApi UpdateWireFileByID Post /v1/wire/files/{fileID} Updates the specified FEDWire Message by setting the values of the parameters passed. Any parameters not provided will be left unchanged.
WireFilesApi ValidateWireFile Get /v1/wire/files/{fileID}/validate Validates the existing file. You need only supply the unique File identifier that was returned upon creation.

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 ACHFilesApiService added in v0.2.0 

type ACHFilesApiService service

func (*ACHFilesApiService) AddBatchToFile added in v0.2.0 

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

func (*ACHFilesApiService) CreateFile added in v0.2.0 

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

func (*ACHFilesApiService) DeleteACHFile added in v0.2.0 

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

func (*ACHFilesApiService) DeleteFileBatch added in v0.2.0 

func (a *ACHFilesApiService) DeleteFileBatch(ctx context.Context, fileID string, batchID string, localVarOptionals *DeleteFileBatchOpts) (*http.Response, error)

func (*ACHFilesApiService) GetFileBatch added in v0.2.0 

func (a *ACHFilesApiService) GetFileBatch(ctx context.Context, fileID string, batchID string, localVarOptionals *GetFileBatchOpts) (Batch, *http.Response, error)

func (*ACHFilesApiService) GetFileBatches added in v0.2.0 

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

func (*ACHFilesApiService) GetFileByID added in v0.2.0 

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

func (*ACHFilesApiService) GetFileContents added in v0.2.0 

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

func (*ACHFilesApiService) GetFiles added in v0.2.0 

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

func (*ACHFilesApiService) SegmentFile added in v0.3.0 

func (a *ACHFilesApiService) SegmentFile(ctx context.Context, fileID string, createFile CreateFile, localVarOptionals *SegmentFileOpts) (File, *http.Response, error)

func (*ACHFilesApiService) UpdateFile added in v0.2.0 

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

func (*ACHFilesApiService) ValidateFile added in v0.2.0 

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

type APIClient 

type APIClient struct {
	ACHFilesApi *ACHFilesApiService

	AccountsApi *AccountsApiService

	CustomersApi *CustomersApiService

	DepositoriesApi *DepositoriesApiService

	EventsApi *EventsApiService

	FEDApi *FEDApiService

	FEDWireMessageFileApi *FEDWireMessageFileApiService

	GatewaysApi *GatewaysApiService

	ImageCashLetterFilesApi *ImageCashLetterFilesApiService

	MonitorApi *MonitorApiService

	OAuth2Api *OAuth2ApiService

	OFACApi *OFACApiService

	OriginatorsApi *OriginatorsApiService

	ReceiversApi *ReceiversApiService

	TransfersApi *TransfersApiService

	UserApi *UserApiService

	WireFilesApi *WireFilesApiService
	// 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
	ID string `json:"ID,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 AccountCreditedDrawdown added in v0.3.0 

type AccountCreditedDrawdown struct {
	// DrawdownCreditAccountNumber  9 character ABA
	DrawdownCreditAccountNumber string `json:"drawdownCreditAccountNumber,omitempty"`
}

AccountCreditedDrawdown is the account which is credited in a drawdown

type AccountDebitedDrawdown added in v0.3.0 

type AccountDebitedDrawdown struct {
	// Identification Code * `D` - Debit
	IdentificationCode string `json:"identificationCode"`
	// Identifier
	Identifier string `json:"identifier"`
	// Name
	Name string `json:"name"`
	// AddressLineOne
	AddressLineOne string `json:"addressLineOne,omitempty"`
	// AddressLineTwo
	AddressLineTwo string `json:"addressLineTwo,omitempty"`
	// AddressLineThree
	AddressLineThree string `json:"addressLineThree,omitempty"`
}

AccountDebitedDrawdown is the account which is debited in a drawdown

type AccountsApiService added in v0.2.0 

type AccountsApiService service

func (*AccountsApiService) CreateAccount added in v0.2.0 

func (a *AccountsApiService) CreateAccount(ctx context.Context, xUserID string, createAccount CreateAccount, localVarOptionals *CreateAccountOpts) (Account, *http.Response, error)

func (*AccountsApiService) CreateTransaction added in v0.2.0 

func (a *AccountsApiService) CreateTransaction(ctx context.Context, xUserID string, createTransaction CreateTransaction, localVarOptionals *CreateTransactionOpts) (Transaction, *http.Response, error)

func (*AccountsApiService) GetAccountTransactions added in v0.2.0 

func (a *AccountsApiService) GetAccountTransactions(ctx context.Context, accountID string, xUserID string, localVarOptionals *GetAccountTransactionsOpts) ([]Transaction, *http.Response, error)

func (*AccountsApiService) SearchAccounts added in v0.2.0 

func (a *AccountsApiService) SearchAccounts(ctx context.Context, xUserID string, localVarOptionals *SearchAccountsOpts) ([]Account, *http.Response, error)

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 AddDepositoryOpts 

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

type AddFEDWireMessageToFileOpts added in v0.3.0 

type AddFEDWireMessageToFileOpts struct {
	XRequestID      optional.String
	XIdempotencyKey optional.String
}

type AddGatewayOpts 

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

type AddICLToFileOpts added in v0.3.0 

type AddICLToFileOpts struct {
	XRequestID      optional.String
	XIDempotencyKey optional.String
}

type AddOFACCompanyNameWatchOpts added in v0.2.0 

type AddOFACCompanyNameWatchOpts struct {
	XRequestID optional.String
}

type AddOFACCompanyWatchOpts added in v0.2.0 

type AddOFACCompanyWatchOpts struct {
	XRequestID optional.String
}

type AddOFACCustomerNameWatchOpts added in v0.2.0 

type AddOFACCustomerNameWatchOpts struct {
	XRequestID optional.String
}

type AddOFACCustomerWatchOpts added in v0.2.0 

type AddOFACCustomerWatchOpts struct {
	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 AdditionalFiToFi added in v0.3.0 

type AdditionalFiToFi struct {
	// LineOne
	LineOne string `json:"lineOne,omitempty"`
	// LineTwo
	LineTwo string `json:"lineTwo,omitempty"`
	// LineThree
	LineThree string `json:"lineThree,omitempty"`
	// LineFour
	LineFour string `json:"lineFour,omitempty"`
	// LineFive
	LineFive string `json:"lineFive,omitempty"`
	// LineSix
	LineSix string `json:"lineSix,omitempty"`
}

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 {
	// Unique identifier for this Address
	ID   string `json:"ID,omitempty"`
	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 Adjustment added in v0.3.0 

type Adjustment struct {
	// Adjustment Reason Code  * `01` - Pricing Error * `03` - Extension Error * `04` - Item Not Accepted (Damaged) * `05` - Item Not Accepted (Quality) * `06` - Quantity Contested 07   Incorrect Product * `11` - Returns (Damaged) * `12` - Returns (Quality) * `59` - Item Not Received * `75` - Total Order Not Received * `81` - Credit as Agreed * `CM` - Covered by Credit Memo
	AdjustmentReasonCode string `json:"adjustmentReasonCode,omitempty"`
	// CreditDebitIndicator  * `CRDT` - Credit * `DBIT` - Debit
	CreditDebitIndicator string `json:"creditDebitIndicator,omitempty"`
	// CurrencyCode
	CurrencyCode string `json:"currencyCode,omitempty"`
	// Amount Must contain at least one numeric character and only one decimal period marker (e.g., $1,234.56 should be entered as 1234.56). Can have up to 5 numeric characters following the decimal period marker (e.g., 1234.56789). Amount must be greater than zero (i.e., at least .01).
	Amount string `json:"amount,omitempty"`
	// AdditionalInfo
	AdditionalInfo string `json:"additionalInfo,omitempty"`
}

Adjustment

type Advice added in v0.3.0 

type Advice struct {
	// Advice Code  * `HLD - Hold * `LTR` - Letter * `PHN` - Phone * `TLX` - Telex * `WRE` - Wire
	AdviceCode string `json:"adviceCode,omitempty"`
	// LineOne
	LineOne string `json:"lineOne,omitempty"`
	// LineTwo
	LineTwo string `json:"lineTwo,omitempty"`
	// LineThree
	LineThree string `json:"lineThree,omitempty"`
	// LineFour
	LineFour string `json:"lineFour,omitempty"`
	// LineFive
	LineFive string `json:"lineFive,omitempty"`
	// LineSix
	LineSix string `json:"lineSix,omitempty"`
}

Advice

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 Amount added in v0.3.0 

type Amount struct {
	// Amount 12 numeric, right-justified with leading zeros, an implied decimal point and no commas; e.g., $12,345.67 becomes 000001234567 Can be all zeros for subtype 90
	Amount string `json:"amount"`
}

Amount is an amount up to a penny less than $10 billion

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 BeneficiaryReference added in v0.3.0 

type BeneficiaryReference struct {
	// BeneficiaryReference
	BeneficiaryReference string `json:"beneficiaryReference,omitempty"`
}

type Bundle added in v0.3.0 

type Bundle struct {
	BundleHeader  BundleHeader  `json:"bundleHeader,omitempty"`
	Checks        []Checks      `json:"checks,omitempty"`
	Returns       []Returns     `json:"returns,omitempty"`
	BundleControl BundleControl `json:"bundleControl,omitempty"`
}

type BundleControl added in v0.3.0 

type BundleControl struct {
	// BundleControl ID
	ID string `json:"ID,omitempty"`
	// BundleItemsCount identifies the total number of items within the bundle.
	BundleItemsCount int32 `json:"bundleItemsCount"`
	// BundleTotalAmount identifies the total amount of item amounts within the bundle.
	BundleTotalAmount int32 `json:"bundleTotalAmount"`
	// MICRValidTotalAmount identifies the total amount of all CheckDetail Records within the bundle which contains 1 in the MICRValidIndicator.
	MicrValidTotalAmount int32 `json:"micrValidTotalAmount,omitempty"`
	// BundleImagesCount identifies the total number of Image ViewDetail Records  within the bundle.
	BundleImagesCount int32 `json:"bundleImagesCount,omitempty"`
	// UserField identifies a field used at the discretion of users of the standard.
	UserField string `json:"userField,omitempty"`
	// CreditTotalIndicator is a code that indicates whether Credits Items are included in the totals. If so they  they will be included in this record’s: Items Within Bundle Count, Bundle Total Amount and, Images Within Bundle Count * ` ` - No Credit Items * `0` - Credit Items are not included in totals * `1` - Credit Items are included in totals
	CreditTotalIndicator float32 `json:"creditTotalIndicator,omitempty"`
}

type BundleHeader added in v0.3.0 

type BundleHeader struct {
	// BundleHeader ID
	ID string `json:"ID,omitempty"`
	// A code that identifies the type of bundle. It is the same value as the CollectionTypeIndicator in the CashLetterHeader within which the bundle is contained, unless the CollectionTypeIndicator in the CashLetterHeader is 99.  * `00` - Preliminary Forward Information * `01` - Forward Presentment * `02` - Forward Presentment - Same-Day Settlement * `03` - Return * `04` - Return Notification * `05` - Preliminary Return Notification * `06` - Final Return Notification
	CollectionTypeIndicator string `json:"collectionTypeIndicator,omitempty"`
	// DestinationRoutingNumber contains the routing and transit number of the institution that receives and processes the cash letter or the bundle.
	DestinationRoutingNumber string `json:"destinationRoutingNumber,omitempty"`
	// ECEInstitutionRoutingNumber contains the routing and transit number of the institution that that creates the bundle header.
	ECEInstitutionRoutingNumber string `json:"eCEInstitutionRoutingNumber,omitempty"`
	// BundleBusinessDate is the business date of the bundle.
	BundleBusinessDate time.Time `json:"bundleBusinessDate,omitempty"`
	// BundleCreationDate is the date that the bundle is created.
	BundleCreationDate time.Time `json:"bundleCreationDate,omitempty"`
	// BundleID is number that identifies the bundle, assigned by the institution that creates the bundle.
	BundleID string `json:"bundleID,omitempty"`
	// BundleSequenceNumber is a number assigned by the institution that creates the bundle. Usually denotes the relative position of the bundle within the cash letter.
	BundleSequenceNumber string `json:"bundleSequenceNumber,omitempty"`
	// CycleNumber is a code assigned by the institution that creates the bundle.  Denotes the cycle under which the bundle is created.
	CycleNumber string `json:"cycleNumber,omitempty"`
	// UserField identifies a field used at the discretion of users of the standard.
	UserField string `json:"userField,omitempty"`
}

type BusinessFunctionCode added in v0.3.0 

type BusinessFunctionCode struct {
	// BusinessFunctionCode * `BTR` - Bank Transfer (Beneficiary is a bank) * `DRC` - Customer or Corporate Drawdown Request * `CKS` - Check Same Day Settlement * `DRW` - Drawdown Payment * `CTP` - Customer Transfer Plus * `FFR` - Fed Funds Returned * `CTR` - Customer Transfer (Beneficiary is a not a bank) * `FFS` - Fed Funds Sold * `DEP` - Deposit to Sender’s Account * `SVC` - Service Message * `DRB` - Bank-to-Bank Drawdown Request
	BusinessFunctionCode string `json:"businessFunctionCode"`
	// TransactionTypeCode If {3600} is CTR, an optional Transaction Type Code element is permitted; however, the Transaction Type Code 'COV' is not permitted.
	TransactionTypeCode string `json:"transactionTypeCode,omitempty"`
}

BusinessFunctionCode is the business function code

type CashLetter added in v0.3.0 

type CashLetter struct {
	CashLetterHeader     CashLetterHeader       `json:"cashLetterHeader,omitempty"`
	CreditItems          []CreditItem           `json:"creditItems,omitempty"`
	Bundles              []Bundle               `json:"bundles,omitempty"`
	RoutingNumberSummary []RoutingNumberSummary `json:"routingNumberSummary,omitempty"`
	CashLetterControl    CashLetterControl      `json:"cashLetterControl,omitempty"`
}

type CashLetterControl added in v0.3.0 

type CashLetterControl struct {
	// CashLetterControl ID
	ID string `json:"ID,omitempty"`
	// CashLetterBundleCount identifies the total number of bundles within the cash letter.
	CashLetterBundleCount int32 `json:"cashLetterBundleCount,omitempty"`
	// CashLetterItemsCount identifies the total number of items within the cash letter.
	CashLetterItemsCount int32 `json:"cashLetterItemsCount"`
	// CashLetterTotalAmount identifies the total dollar value of all item amounts within the cash letter.
	CashLetterTotalAmount int32 `json:"cashLetterTotalAmount"`
	// CashLetterImagesCount identifies the total number of ImageViewDetail(s) within the CashLetter.
	CashLetterImagesCount int32 `json:"cashLetterImagesCount,omitempty"`
	// ECEInstitutionName identifies the short name of the institution that creates the CashLetterControl.
	ECEInstitutionName string `json:"eCEInstitutionName,omitempty"`
	// SettlementDate identifies the date that the institution that creates the cash letter expects settlement.
	SettlementDate time.Time `json:"settlementDate"`
	// CreditTotalIndicator is a code that indicates whether Credits Items are included in this record’s totals. If so they will be included in TotalItemCount and FileTotalAmount. TotalRecordCount includes all records of all types regardless of the value of this field. * ` ` - No Credit Items * `0` - Credit Items are not included in totals * `1` - Credit Items are included in totals
	CreditTotalIndicator float32 `json:"creditTotalIndicator,omitempty"`
}

type CashLetterHeader added in v0.3.0 

type CashLetterHeader struct {
	// CashLetterHeader ID
	ID string `json:"ID,omitempty"`
	// CollectionTypeIndicator is a code that identifies the type of cash letter.  * `00` - Preliminary Forward Information * `01` - Forward Presentment * `02` - Forward Presentment - Same-Day Settlement * `03` - Return * `04` - Return Notification * `05` - Preliminary Return Notification * `06` - Final Return Notification * `20` - No Detail * `99` - Bundles not the same collection type. Use of the value is only allowed by clearing arrangement.
	CollectionTypeIndicator string `json:"collectionTypeIndicator,omitempty"`
	// DestinationRoutingNumber is the routing and transit number of the institution that receives and processes the cash letter or the bundle.
	DestinationRoutingNumber string `json:"destinationRoutingNumber,omitempty"`
	// ECEInstitutionRoutingNumber is the routing and transit number of the institution that creates the Cash Letter Header record
	ECEInstitutionRoutingNumber string `json:"eCEInstitutionRoutingNumber,omitempty"`
	// cashLetterBusinessDate is the business date of the cash letter. (Format YYYYMMDD, where - YYYY year, MM month, DD day)
	CashLetterBusinessDate string `json:"cashLetterBusinessDate,omitempty"`
	// cashLetterCreationDate is the date that the cash letter is created (Format YYYYMMDD, where - YYYY year, MM month, DD day)
	CashLetterCreationDate time.Time `json:"cashLetterCreationDate,omitempty"`
	// CashLetterCreationTime is the time that the cash letter is created. (Format - hhmm, where - hh hour, mm minute)
	CashLetterCreationTime string `json:"cashLetterCreationTime,omitempty"`
	// RecordTypeIndicator is a code that indicates the presence of records or the type of records contained in the cash letter. If an image is associated with any CheckDetail or Return, the cash letter must have a RecordTypeIndicator of I or F.  * `N` - No electronic check records or image records (Type 2x’s, 3x’s, 5x’s); e.g., an empty cash letter. * `E` - Cash letter contains electronic check records with no images (Type 2x’s and 3x’s only). * `I` - Cash letter contains electronic check records (Type 2x’s, 3x’s) and image records (Type 5x’s). * `F` - Cash letter contains electronic check records (Type 2x’s and 3x’s) and image records (Type 5x’s) that correspond to a previously sent cash letter (i.e., E file).
	RecordTypeIndicator string `json:"recordTypeIndicator,omitempty"`
	// DocumentationTypeIndicator is a code that indicates the type of documentation that supports all check records in the cash letter.  * `A` - No image provided, paper provided separately * `B` - No image provided, paper provided separately, image upon request * `C` - Image provided separately, no paper provided * `D` - Image provided separately, no paper provided, image upon request * `E` - Image and paper provided separately * `F` - Image and paper provided separately, image upon request * `G` - Image included, no paper provided * `H` - Image included, no paper provided, image upon request * `I` - Image included, paper provided separately * `J` - Image included, paper provided separately, image upon request * `K` - No image provided, no paper provided * `L` - No image provided, no paper provided, image upon request * `M` - No image provided, Electronic Check provided separately * `Z` - Not Same Type–Documentation associated with each item in Cash Letter will be different. The Check Detail
	DocumentationTypeIndicator string `json:"documentationTypeIndicator,omitempty"`
	// CashLetterID uniquely identifies the cash letter. It is assigned by the institution that creates the cash letter and must be unique within a Cash Letter Business Date.
	CashLetterID string `json:"cashLetterID,omitempty"`
	// OriginatorContactName is the name of contact at the institution that creates the cash letter.
	OriginatorContactName string `json:"originatorContactName,omitempty"`
	// OriginatorContactPhoneNumber is the phone number of the contact at the institution that creates the cash letter.
	OriginatorContactPhoneNumber string `json:"originatorContactPhoneNumber,omitempty"`
	// fedWorkType is any valid codes specified by the Federal Reserve Bank
	FedWorkType string `json:"fedWorkType,omitempty"`
	// ReturnsIndicator ddentifies type of returns  * ` ` - Original Message * `E` - Administrative - items being returned that are handled by the bank and usually do not directly affect the customer or its account. * `R` - Customer–items being returned that directly affect a customer’s account. * `J` - Reject Return
	ReturnsIndicator string `json:"returnsIndicator,omitempty"`
	// UserField is a field used at the discretion of users of the standard
	UserField string `json:"userField,omitempty"`
}

type CcdDetail added in v0.2.0 

type CcdDetail struct {
	// Metadata for the transaction, placed in addenda 05 record
	PaymentInformation string `json:"paymentInformation"`
}

type Charges added in v0.3.0 

type Charges struct {
	// Charge Details * `B` - Beneficiary * `S` - Shared
	ChargeDetails string `json:"chargeDetails,omitempty"`
	// SendersChargesOne  The first three characters must contain an alpha currency code (e.g., USD).  The remaining characters for the amount must begin with at least one numeric character (0-9) and only one decimal comma marker.  $1,234.56 should be entered as USD1234,56 and $0.99 should be entered as USD0,99.
	SendersChargesOne string `json:"sendersChargesOne,omitempty"`
	// SendersChargesTwo  The first three characters must contain an alpha currency code (e.g., USD).  The remaining characters for the amount must begin with at least one numeric character (0-9) and only one decimal comma marker.  $1,234.56 should be entered as USD1234,56 and $0.99 should be entered as USD0,99.
	SendersChargesTwo string `json:"sendersChargesTwo,omitempty"`
	// SendersChargesThree  The first three characters must contain an alpha currency code (e.g., USD).  The remaining characters for the amount must begin with at least one numeric character (0-9) and only one decimal comma marker.  $1,234.56 should be entered as USD1234,56 and $0.99 should be entered as USD0,99.
	SendersChargesThree string `json:"sendersChargesThree,omitempty"`
	// SendersChargesFour  The first three characters must contain an alpha currency code (e.g., USD).  The remaining characters for the amount must begin with at least one numeric character (0-9) and only one decimal comma marker.  $1,234.56 should be entered as USD1234,56 and $0.99 should be entered as USD0,99.
	SendersChargesFour string `json:"sendersChargesFour,omitempty"`
}

type CheckDetail added in v0.3.0 

type CheckDetail struct {
	// CheckDetail ID
	ID string `json:"ID,omitempty"`
	// AuxiliaryOnUs identifies a code used on commercial checks at the discretion of the payor bank.
	AuxiliaryOnUs string `json:"auxiliaryOnUs,omitempty"`
	// ExternalProcessingCode identifies a code used for special purposes as authorized by the Accredited Standards Committee X9. Also known as Position 44.
	ExternalProcessingCode string `json:"externalProcessingCode,omitempty"`
	// PayorBankRoutingNumber identifies a number that identifies the institution by or through which the item is payable. Must be a valid routing and transit number issued by the ABA’s Routing Number Registrar. Shall represent the first 8 digits of a 9-digit routing number or 8 numeric digits of a 4 dash 4 routing number. A valid routing number consists of 2 fields: the eight- digit Payor Bank Routing Number  and the one-digit Payor Bank Routing Number Check Digit.
	PayorBankRoutingNumber string `json:"payorBankRoutingNumber,omitempty"`
	// PayorBankCheckDigit identifies a digit representing the routing number check digit.  The combination of Payor Bank Routing Number and payor Bank Routing Number Check Digit must be a mod-checked routing number with a valid check digit.
	PayorBankCheckDigit string `json:"payorBankCheckDigit,omitempty"`
	// OnUs identifies data specified by the payor bank. On-Us data usually consists of the payor’s account number, a serial number or transaction code, or both.
	OnUs string `json:"onUs,omitempty"`
	// Amount identifies the amount of the check.  All amounts fields have two implied decimal points. e.g., 100000 is $1,000.00
	ItemAmount int32 `json:"itemAmount,omitempty"`
	// ECEInstitutionItemSequenceNumber identifies a number assigned by the institution that creates the CheckDetail. Field must contain a numeric value. It cannot be all blanks.
	ECEInstitutionItemSequenceNumber string `json:"eCEInstitutionItemSequenceNumber,omitempty"`
	// DocumentationTypeIndicator identifies a code that indicates the type of documentation that supports the check record.  This field is superseded by the Cash Letter Documentation Type Indicator in the Cash Letter Header Record for all Defined Values except ‘Z’ Not Same Type. In the case of Defined Value of ‘Z’, the Documentation Type Indicator in this record takes precedent.  Shall be present when Cash Letter Documentation Type Indicator in the Cash Letter Header Record is Defined Value of ‘Z’.  * `A` - No image provided, paper provided separately * `B` - No image provided, paper provided separately, image upon request * `C` - Image provided separately, no paper provided * `D` - Image provided separately, no paper provided, image upon request * `E` - Image and paper provided separately * `F` - Image and paper provided separately, image upon request * `G` - Image included, no paper provided * `H` - Image included, no paper provided, image upon request * `I` - Image included, paper provided separately * `J` - Image included, paper provided separately, image upon request * `K` - No image provided, no paper provided * `L` - No image provided, no paper provided, image upon request * `M` - No image provided, Electronic Check provided separately
	DocumentationTypeIndicator string `json:"documentationTypeIndicator,omitempty"`
	// ReturnAcceptanceIndicator is a code that indicates whether the institution that creates the CheckDetail will or will not support electronic return processing.  * `0` -Will not accept any electronic information * `1` -Will accept preliminary return notifications, returns, and final return notifications * `2` -Will accept preliminary return notifications and returns * `3` -Will accept preliminary return notifications and final return notifications * `4` -Will accept returns and final return notifications * `5` -Will accept preliminary return notifications only * `6` -Will accept returns only * `7` -Will accept final return notifications only * `8` -Will accept preliminary return notifications, returns, final return notifications, and image returns * `9` -Will accept preliminary return notifications, returns and image returns * `A` -Will accept preliminary return notifications, final return notifications and image returns * `B` -Will accept returns, final return notifications and image returns * `C` -Will accept preliminary return notifications and image returns * `D` -Will accept returns and image returns * `E` -Will accept final return notifications and image returns * `F` -Will accept image returns only
	ReturnAcceptanceIndicator string `json:"returnAcceptanceIndicator,omitempty"`
	// MICRValidIndicator is a code that indicates whether any character in the Magnetic Ink Character Recognition (MICR) property is unreadable, or the OnUs property is missing from the CheckDetail. * `1` - Good read * `2` - Good read, missing field * `3` - Read error encountered * `4` - Missing field and read error encountered
	MICRValidIndicator string `json:"mICRValidIndicator,omitempty"`
	// BOFDIndicator is a code that indicates whether the ECE institution indicated on the Bundle Header Record (Type 20) is the Bank of First Deposit (BOFD). This field shall be consistent with values contained in the Check Detail Addendum A Record (Type 26) and Check Detail Addendum C Record (Type 28). * `Y` - ECE institution is BOFD * `N` - ECE institution is not BOFD * `U` - ECE institution relationship to BOFD is undetermined
	BOFDIndicator string `json:"bOFDIndicator,omitempty"`
	// AddendumCount is a number of Check Detail Record Addenda to follow. This represents the number of CheckDetailAddendumA, CheckDetailAddendumB and CheckDetailAddendumC types.  It matches the total number of addendum records associated with this item. The standard supports up to 99 addendum records.
	AddendumCount int32 `json:"addendumCount,omitempty"`
	// CorrectionIndicator identifies whether and how the MICR line was repaired, for fields other than Payor Bank Routing Number and Amount. * `0` - No Repair * `1` - Repaired (form of repair unknown) * `2` - Repaired without Operator intervention * `3` - Repaired with Operator intervention * `4` - Undetermined if repair has been done or not
	CorrectionIndicator string `json:"correctionIndicator,omitempty"`
	// ArchiveTypeIndicator is a code that indicates the type of archive that supports this CheckDetail. Access method, availability and time-frames shall be defined by clearing arrangements.  * `A` - Microfilm * `B` - Image * `C` - Paper * `D` - Microfilm and image * `E` - Microfilm and paper * `F` - Image and paper * `G` - Microfilm, image and paper * `H` - Electronic Check Instrument * `I` - None
	ArchiveTypeIndicator string               `json:"archiveTypeIndicator,omitempty"`
	CheckDetailAddendumA CheckDetailAddendumA `json:"checkDetailAddendumA,omitempty"`
	CheckDetailAddendumB CheckDetailAddendumB `json:"checkDetailAddendumB,omitempty"`
	CheckDetailAddendumC CheckDetailAddendumC `json:"checkDetailAddendumC,omitempty"`
	ImageViewDetail      ImageViewDetail      `json:"imageViewDetail,omitempty"`
	ImageViewData        ImageViewData        `json:"imageViewData,omitempty"`
	ImageViewAnalysis    ImageViewAnalysis    `json:"imageViewAnalysis,omitempty"`
}

type CheckDetailAddendumA added in v0.3.0 

type CheckDetailAddendumA struct {
	// CheckDetailAddendumA ID
	ID string `json:"ID,omitempty"`
	// RecordNumber is a number representing the order in which each CheckDetailAddendumA was created. CheckDetailAddendumA shall be in sequential order starting with 1.
	RecordNumber int32 `json:"recordNumber"`
	// ReturnLocationRoutingNumber is a valid routing and transit number indicating where returns, final return notifications, and preliminary return notifications are sent, usually the BOFD.
	ReturnLocationRoutingNumber string `json:"returnLocationRoutingNumber"`
	// BOFDEndorsementDate is the date of endorsement
	BOFDEndorsementDate time.Time `json:"bOFDEndorsementDate,omitempty"`
	// BOFDItemSequenceNumber is a number that identifies the item in the CheckDetailAddendumA.
	BOFDItemSequenceNumber string `json:"bOFDItemSequenceNumber,omitempty"`
	// BOFDAccountNumber is a number that identifies the depository account at the Bank of First Deposit.
	BOFDAccountNumber string `json:"bOFDAccountNumber,omitempty"`
	// BOFDBranchCode is a code that identifies the branch at the Bank of First Deposit.
	BOFDBranchCode string `json:"bOFDBranchCode,omitempty"`
	// PayeeName is the name of the payee from the check.
	PayeeName string `json:"payeeName,omitempty"`
	// TruncationIndicator identifies if the institution truncated the original check item.
	TruncationIndicator string `json:"truncationIndicator"`
	// BOFDConversionIndicator is a code that indicates the conversion within the processing institution between original paper check, image and IRD. The indicator is specific to the action of institution that created this record.  * `0` - Did not convert physical document * `1` - Original paper converted to IRD * `2` - Original paper converted to image * `3` - IRD converted to another IRD * `4` - IRD converted to image of IRD * `5` - Image converted to an IRD * `6` - Image converted to another image (e.g., transcoded) * `7` - Did not convert image (e.g., same as source) * `8` - Undetermined
	BOFDConversionIndicator string `json:"bOFDConversionIndicator,omitempty"`
	// BOFDCorrectionIndicator identifies whether and how the MICR line of this item was repaired by the creator of this CheckDetailAddendumA Record for fields other than Payor Bank Routing Number and Amount. * `0` - No Repair * `1` - Repaired (form of repair unknown) * `2` - Repaired without Operator intervention * `3` - Repaired with Operator intervention * `4` - Undetermined if repair has been done or not
	BOFDBOFDCorrectionIndicator string `json:"bOFDBOFDCorrectionIndicator,omitempty"`
	// UserField identifies a field used at the discretion of users of the standard.
	UserField string `json:"userField,omitempty"`
}

type CheckDetailAddendumB added in v0.3.0 

type CheckDetailAddendumB struct {
	// CheckDetailAddendumB ID
	ID string `json:"ID,omitempty"`
	// ImageReferenceKeyIndicator identifies whether ImageReferenceKeyLength contains a variable value within the allowable range, or contains a defined value and the content is ItemReferenceKey.  * `0` - ImageReferenceKeyIndicator has Defined Value of 0034 and ImageReferenceKey contains the Image Reference Key. * `1`- ImageReferenceKeyIndicator contains a value other than Value 0034; or ImageReferenceKeyIndicator contains Value 0034, which is not a Defined Value, and the content of ImageReferenceKey has no special significance with regards to an Image Reference Key; or ImageReferenceKeyIndicator is 0000, meaning the ImageReferenceKey is not present.
	ImageReferenceKeyIndicator string `json:"imageReferenceKeyIndicator,omitempty"`
	// microfilmArchiveSequenceNumber is a number that identifies the item in the microfilm archive system; it may be different than the Check Detail.ECEInstitutionItemSequenceNumber and from the ImageReferenceKey.
	MicrofilmArchiveSequenceNumber string `json:"microfilmArchiveSequenceNumber"`
	// MicrofilmArchiveSequenceNumber A number that identifies the item in the microfilm archive system; it may be different than the Check Detail.ECEInstitutionItemSequenceNumber and from the ImageReferenceKey.  * `0034` - ImageReferenceKey contains the ImageReferenceKey (ImageReferenceKeyIndicator is 0). * `0000` - ImageReferenceKey not present (ImageReferenceKeyIndicator is 1). * `0001` - 9999: May include Value 0034, and ImageReferenceKey has no special significance to Image Reference Key (ImageReferenceKey is 1).
	LengthImageReferenceKey string `json:"lengthImageReferenceKey,omitempty"`
	// ImageReferenceKey is used to find the image of the item in the image data system.  Size is variable based on lengthImageReferenceKey. The position within the file is variable based on the lengthImageReferenceKey.
	ImageReferenceKey string `json:"imageReferenceKey,omitempty"`
	// Descript describes the transaction.  The position within the file is variable based on the lengthImageReferenceKey.
	Descript string `json:"descript,omitempty"`
	// UserField identifies a field used at the discretion of users of the standard.
	UserField string `json:"userField,omitempty"`
}

type CheckDetailAddendumC added in v0.3.0 

type CheckDetailAddendumC struct {
	// CheckDetailAddendumC ID
	ID string `json:"ID,omitempty"`
	// RecordNumber is a number representing the order in which each CheckDetailAddendumC was created. CheckDetailAddendumA shall be in sequential order starting with 1.
	RecordNumber int32 `json:"recordNumber"`
	// EndorsingBankRoutingNumber is a valid routing and transit number indicating the bank that endorsed the check.
	EndorsingBankRoutingNumber string `json:"endorsingBankRoutingNumber"`
	// BOFDEndorsementBusinessDate is the date of endorsement.
	BOFDEndorsementBusinessDate time.Time `json:"bOFDEndorsementBusinessDate,omitempty"`
	// EndorsingItemSequenceNumber is a number that identifies the item at the endorsing bank.
	EndorsingBankSequenceNumber string `json:"endorsingBankSequenceNumber,omitempty"`
	// TruncationIndicator identifies if the institution truncated the original check item.
	TruncationIndicator string `json:"truncationIndicator"`
	// EndorsingBankConversionIndicator is a code that indicates the conversion within the processing institution between original paper check, image and IRD. The indicator is specific to the action institution identified in the EndorsingBankRoutingNumber.  * `0` - Did not convert physical document * `1` - Original paper converted to IRD * `2` - Original paper converted to image * `3` - IRD converted to another IRD * `4` - IRD converted to image of IRD * `5` - Image converted to an IRD * `6` - Image converted to another image (e.g., transcoded) * `7` - Did not convert image (e.g., same as source) * `8` - Undetermined
	EndorsingBankConversionIndicator string `json:"endorsingBankConversionIndicator,omitempty"`
	// EndorsingCorrectionIndicator identifies whether and how the MICR line of this item was repaired by the creator of this CheckDetailAddendumC Record for fields other than Payor Bank Routing Number and Amount.  * `0` - No Repair * `1` - Repaired (form of repair unknown) * `2` - Repaired without Operator intervention * `3` - Repaired with Operator intervention * `4` - Undetermined if repair has been done or not
	EndorsingBankCorrectionIndicator string `json:"endorsingBankCorrectionIndicator,omitempty"`
	// ReturnReason is a code that indicates the reason for non-payment.
	ReturnReason string `json:"returnReason,omitempty"`
	// UserField identifies a field used at the discretion of users of the standard.
	UserField string `json:"userField,omitempty"`
	// * `0` - Depository Bank (BOFD) - this value is used when the CheckDetailAddendumC Record reflects the Return * `Processing Bank in lieu of BOFD. * `1` - Other Collecting Bank * `2` - Other Returning Bank * `3` - Payor Bank
	EndorsingBankIdentifier string `json:"endorsingBankIdentifier,omitempty"`
}

type CheckOAuthClientCredentialsOpts 

type CheckOAuthClientCredentialsOpts struct {
	XRequestID optional.String
}

type CheckUserLoginOpts 

type CheckUserLoginOpts struct {
	XRequestID optional.String
}

type Checks added in v0.3.0 

type Checks struct {
	CheckDetail CheckDetail `json:"checkDetail,omitempty"`
}

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 CoverPayment added in v0.3.0 

type CoverPayment struct {
	// SwiftFieldTag
	SwiftFieldTag string `json:"swiftFieldTag,omitempty"`
	// SwiftLineOne
	SwiftLineOne string `json:"swiftLineOne,omitempty"`
	// SwiftLineTwo
	SwiftLineTwo string `json:"swiftLineTwo,omitempty"`
	// SwiftLineThree
	SwiftLineThree string `json:"swiftLineThree,omitempty"`
	// SwiftLineFour
	SwiftLineFour string `json:"swiftLineFour,omitempty"`
	// SwiftLineFive
	SwiftLineFive string `json:"swiftLineFive,omitempty"`
	// SwiftLineSix
	SwiftLineSix string `json:"swiftLineSix,omitempty"`
}

CoverPayment

type CreateAccount 

type CreateAccount struct {
	// Customer ID associated with accounts
	CustomerID string `json:"customerID"`
	// Initial balance of account in USD cents. This amount is to be deposited from an account at another Financial Institution or in-person (i.e. cash) on account creation.
	Balance int32 `json:"balance"`
	// Caller defined label for this account.
	Name string `json:"name"`
	// Random number to be used as unique to distinguish this Account
	Number string `json:"number,omitempty"`
	// 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"`
	// Middle Name
	MiddleName string `json:"middleName,omitempty"`
	// Surname or Last Name
	LastName string `json:"lastName"`
	// 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"`
	// Primary email address of customer name@domain.com
	Email string `json:"email"`
	// Customer Social Security Number (SSN)
	SSN       string          `json:"SSN,omitempty"`
	Phones    []CreatePhone   `json:"phones,omitempty"`
	Addresses []CreateAddress `json:"addresses"`
	// Map of unique keys associated to values to act as foreign key relationships or arbitrary data associated to a Customer.
	Metadata map[string]string `json:"metadata,omitempty"`
}

type CreateCustomerOpts 

type CreateCustomerOpts struct {
	XRequestID optional.String
	XUserID    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 CreateFile2 added in v0.3.0 

type CreateFile2 struct {
	// File ID
	ID          string       `json:"ID,omitempty"`
	FileHeader  FileHeader2  `json:"fileHeader"`
	CashLetters []CashLetter `json:"cashLetters,omitempty"`
	Bundles     []Bundle     `json:"bundles,omitempty"`
	FileControl FileControl2 `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 CreateICLFileOpts added in v0.3.0 

type CreateICLFileOpts struct {
	XRequestID      optional.String
	XIDempotencyKey optional.String
}

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 CreateTransaction added in v0.2.0 

type CreateTransaction struct {
	Lines []TransactionLine `json:"lines,omitempty"`
}

type CreateTransactionOpts added in v0.2.0 

type CreateTransactionOpts struct {
	XRequestID optional.String
}

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"`
	CCDDetail CcdDetail `json:"CCDDetail,omitempty"`
	IATDetail IatDetail `json:"IATDetail,omitempty"`
	TELDetail TelDetail `json:"TELDetail,omitempty"`
	WEBDetail WebDetail `json:"WEBDetail,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 CreateWireFileOpts added in v0.3.0 

type CreateWireFileOpts struct {
	XRequestID      optional.String
	XIdempotencyKey optional.String
}

type CreditItem added in v0.3.0 

type CreditItem struct {
	// CreditItem ID
	ID string `json:"ID,omitempty"`
	// AuxiliaryOnUs identifies a code used at the discretion of the creating bank. The handling of dashes and spaces shall be determined between the exchange partners.
	AuxiliaryOnUs string `json:"auxiliaryOnUs,omitempty"`
	// ExternalProcessingCode identifies a code used for special purposes as authorized by the Accredited Standards Committee X9. Also known as Position 44.
	ExternalProcessingCode string `json:"externalProcessingCode,omitempty"`
	// PostingBankRoutingNumber is a routing number assigned by the posting bank to identify this credit.
	PostingBankRoutingNumber string `json:"postingBankRoutingNumber,omitempty"`
	// OnUs identifies data specified by the payor bank. On-Us data usually consists of the payor’s account number, a serial number or transaction code, or both.
	OnUs string `json:"onUs,omitempty"`
	// Amount identifies the amount of the check.  All amounts fields have two implied decimal points. e.g., 100000 is $1,000.00
	ItemAmount int32 `json:"itemAmount,omitempty"`
	// CreditItemSequenceNumber identifies a number assigned by the institution that creates the CreditItem.
	CreditItemSequenceNumber string `json:"creditItemSequenceNumber,omitempty"`
	// DocumentationTypeIndicator is a code used to indicate the type of documentation that supports this record. Shall be present when Cash Letter Documentation Type Indicator in the Cash Letter Header Record is Defined Value of ‘Z’.  * `A` - No image provided, paper provided separately * `B` - No image provided, paper provided separately, image upon request * `C` - Image provided separately, no paper provided * `D` - Image provided separately, no paper provided, image upon request * `E` - Image and paper provided separately * `F` - Image and paper provided separately, image upon request * `G` - Image included, no paper provided * `H` - Image included, no paper provided, image upon request * `I` - Image included, paper provided separately * `J` - Image included, paper provided separately, image upon request * `K` - No image provided, no paper provided * `L` - No image provided, no paper provided, image upon request
	DocumentationTypeIndicator string `json:"documentationTypeIndicator,omitempty"`
	// AccountTypeCode is a code that indicates the type of account to which this CreditItem is associated.  * `0` - Unknown * `1` - DDA account * `2` - General Ledger account * `3` - Savings account * `4` - Money Market account * `5` - Other Account
	AcccountTypeCode string `json:"acccountTypeCode,omitempty"`
	// AccountTypeCode is a code that indicates the type of account to which this CreditItem is associated.  * `00` - Unknown * `01` - Internal–ATM * `02` - Internal–Branch * `03` - Internal–Other * `04` - External–Bank to Bank (Correspondent) * `05` - External–Business to Bank (Customer) * `06` - External–Business to Bank Remote Capture * `07` - External–Processor to Bank * `08` - External–Bank to Processor * `09` - Lockbox * `10` - International–Internal * `11` - International–External * `21–50` - User Defined
	SourceWorkCode string `json:"sourceWorkCode,omitempty"`
	// UserField identifies a field used at the discretion of users of the standard.
	UserField string `json:"userField,omitempty"`
}

type CurrencyInstructedAmount added in v0.3.0 

type CurrencyInstructedAmount struct {
	// SwiftFieldTag
	SwiftFieldTag string `json:"swiftFieldTag,omitempty"`
	// Amount
	Amount string `json:"amount,omitempty"`
}

CurrencyInstructedAmount

type Customer 

type Customer struct {
	// The unique identifier for the customer who owns the account
	ID string `json:"ID,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"`
	// 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"`
	// Map of unique keys associated to values to act as foreign key relationships or arbitrary data associated to a Customer.
	Metadata  map[string]string `json:"metadata,omitempty"`
	CreatedAt time.Time         `json:"createdAt,omitempty"`
	// Last time the object was modified
	LastModified time.Time `json:"lastModified,omitempty"`
}

type CustomersApiService added in v0.2.0 

type CustomersApiService service

func (*CustomersApiService) CreateCustomer added in v0.2.0 

func (a *CustomersApiService) CreateCustomer(ctx context.Context, createCustomer CreateCustomer, localVarOptionals *CreateCustomerOpts) (Customer, *http.Response, error)

func (*CustomersApiService) GetCustomer added in v0.2.0 

func (a *CustomersApiService) GetCustomer(ctx context.Context, customerID string, localVarOptionals *GetCustomerOpts) (Customer, *http.Response, error)

func (*CustomersApiService) GetCustomerDocumentContents added in v0.2.0 

func (a *CustomersApiService) GetCustomerDocumentContents(ctx context.Context, customerID string, documentID string, localVarOptionals *GetCustomerDocumentContentsOpts) (*os.File, *http.Response, error)

func (*CustomersApiService) GetCustomerDocuments added in v0.2.0 

func (a *CustomersApiService) GetCustomerDocuments(ctx context.Context, customerID string, localVarOptionals *GetCustomerDocumentsOpts) ([]Document, *http.Response, error)

func (*CustomersApiService) UploadCustomerDocument added in v0.2.0 

func (a *CustomersApiService) UploadCustomerDocument(ctx context.Context, customerID string, type_ string, file *os.File, localVarOptionals *UploadCustomerDocumentOpts) (Document, *http.Response, error)

type DateRemittanceDocument added in v0.3.0 

type DateRemittanceDocument struct {
	// DateRemittanceDocument CCYYMMDD
	DateRemittanceDocument string `json:"dateRemittanceDocument,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 DeleteICLFileOpts added in v0.3.0 

type DeleteICLFileOpts struct {
	XRequestID optional.String
}

type DeleteICLFromFileOpts added in v0.3.0 

type DeleteICLFromFileOpts 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 DeleteWireFileByIDOpts added in v0.3.0 

type DeleteWireFileByIDOpts 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 Document added in v0.2.0 

type Document struct {
	// The unique identifier for this document
	ID          string `json:"ID,omitempty"`
	Type        string `json:"type,omitempty"`
	ContentType string `json:"contentType,omitempty"`
	// Optional array of errors encountered dring automated parsing.
	ParseErrors []string  `json:"parseErrors,omitempty"`
	UploadedAt  time.Time `json:"uploadedAt,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 Dpl added in v0.3.0 

type Dpl struct {
	// Name of the Denied Person
	Name string `json:"name,omitempty"`
	// Denied Person's street address
	StreetAddress string `json:"streetAddress,omitempty"`
	// Denied Person's city
	City string `json:"city,omitempty"`
	// Denied Person's state
	State string `json:"state,omitempty"`
	// Denied Person's country
	Country string `json:"country,omitempty"`
	// Denied Person's postal code
	PostalCode string `json:"postalCode,omitempty"`
	// Date when denial came into effect
	EffectiveDate string `json:"effectiveDate,omitempty"`
	// Date when denial expires, if blank denial never expires
	ExpirationDate string `json:"expirationDate,omitempty"`
	// Denotes whether or not the Denied Person was added by a standard order
	StandardOrder string `json:"standardOrder,omitempty"`
	// Most recent date when the Denied Person record was updated
	LastUpdate string `json:"lastUpdate,omitempty"`
	// Most recent action taken regarding the denial
	Action string `json:"action,omitempty"`
	// Reference to the order's citation in the Federal Register
	FrCitation string  `json:"frCitation,omitempty"`
	Match      float32 `json:"match,omitempty"`
}

BIS Denied Persons List item

type EntryDetail 

type EntryDetail struct {
	// Entry Detail ID
	ID string `json:"ID,omitempty"`
	// 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 ErrorWire added in v0.3.0 

type ErrorWire struct {
	// ErrorCategory * `E` - Data Error * `F` - Insufficient Balance * `H` - Accountability Error * `I` - In Process or Intercepted * `W` - Cutoff Hour Error * `X` - Duplicate IMAD
	ErrorCategory string `json:"errorCategory,omitempty"`
	// ErrorCode
	ErrorCode string `json:"errorCode,omitempty"`
	// ErrorDescription
	ErrorDescription string `json:"errorDescription,omitempty"`
}

ErrorWire

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 ExchangeRate added in v0.3.0 

type ExchangeRate struct {
	// ExchangeRate is the exchange rate  Must contain at least one numeric character and only one decimal comma marker (e.g., an exchange rate of 1.2345 should be entered as 1,2345).
	ExchangeRate string `json:"exchangeRate,omitempty"`
}

ExchangeRate is the exchange rate

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 FEDWireMessageFileApiService added in v0.3.0 

type FEDWireMessageFileApiService service

func (*FEDWireMessageFileApiService) AddFEDWireMessageToFile added in v0.3.0 

func (a *FEDWireMessageFileApiService) AddFEDWireMessageToFile(ctx context.Context, fileID string, fedWireMessage FedWireMessage, localVarOptionals *AddFEDWireMessageToFileOpts) (*http.Response, error)

type FedWireMessage added in v0.3.0 

type FedWireMessage struct {
	// FEDWireMessage ID
	ID                              string                          `json:"ID,omitempty"`
	MessageDisposition              MessageDisposition              `json:"messageDisposition,omitempty"`
	ReceiptTimeStamp                ReceiptTimeStamp                `json:"receiptTimeStamp,omitempty"`
	OutputMessageAccountabilityData OutputMessageAccountabilityData `json:"outputMessageAccountabilityData,omitempty"`
	ErrorWire                       ErrorWire                       `json:"errorWire,omitempty"`
	SenderSupplied                  SenderSupplied                  `json:"senderSupplied"`
	TypeSubType                     TypeSubType                     `json:"typeSubType"`
	InputMessageAccountabilityData  InputMessageAccountabilityData  `json:"inputMessageAccountabilityData"`
	Amount                          Amount                          `json:"amount"`
	SenderDepositoryInstitution     SenderDepositoryInstitution     `json:"senderDepositoryInstitution"`
	ReceiverDepositoryInstitution   ReceiverDepositoryInstitution   `json:"receiverDepositoryInstitution"`
	BusinessFunctionCode            BusinessFunctionCode            `json:"businessFunctionCode"`
	SenderReference                 SenderReference                 `json:"senderReference,omitempty"`
	PreviousMessageIdentifier       PreviousMessageIdentifier       `json:"previousMessageIdentifier,omitempty"`
	LocalInstrument                 LocalInstrument                 `json:"localInstrument,omitempty"`
	PaymentNotification             PaymentNotification             `json:"paymentNotification,omitempty"`
	Charges                         Charges                         `json:"charges,omitempty"`
	InstructedAmount                InstructedAmount                `json:"instructedAmount,omitempty"`
	ExchangeRate                    ExchangeRate                    `json:"exchangeRate,omitempty"`
	BeneficiaryIntermediaryFI       FinancialInstitution            `json:"beneficiaryIntermediaryFI,omitempty"`
	BeneficiaryFI                   FinancialInstitution            `json:"beneficiaryFI,omitempty"`
	Beneficiary                     Personal                        `json:"beneficiary,omitempty"`
	BeneficiaryReference            BeneficiaryReference            `json:"beneficiaryReference,omitempty"`
	AccountDebitedDrawdown          AccountDebitedDrawdown          `json:"accountDebitedDrawdown,omitempty"`
	Originator                      Personal                        `json:"originator,omitempty"`
	OriginatorOptionF               OriginatorOptionF               `json:"originatorOptionF,omitempty"`
	OriginatorFI                    FinancialInstitution            `json:"originatorFI,omitempty"`
	InstructingFI                   FinancialInstitution            `json:"instructingFI,omitempty"`
	AccountCreditedDrawdown         AccountCreditedDrawdown         `json:"accountCreditedDrawdown,omitempty"`
	OriginatorToBeneficiary         OriginatorToBeneficiary         `json:"originatorToBeneficiary,omitempty"`
	FiReceiverFI                    FiToFi                          `json:"fiReceiverFI,omitempty"`
	FiDrawdownDebitAccountAdvice    Advice                          `json:"fiDrawdownDebitAccountAdvice,omitempty"`
	FiIntermediaryFI                FiToFi                          `json:"fiIntermediaryFI,omitempty"`
	FiIntermediaryFIAdvice          Advice                          `json:"fiIntermediaryFIAdvice,omitempty"`
	FiBeneficiaryFI                 FiToFi                          `json:"fiBeneficiaryFI,omitempty"`
	FiBeneficiaryFIAdvice           Advice                          `json:"fiBeneficiaryFIAdvice,omitempty"`
	FiBeneficiary                   FiToFi                          `json:"fiBeneficiary,omitempty"`
	FiBeneficiaryAdvice             Advice                          `json:"fiBeneficiaryAdvice,omitempty"`
	FiPaymentMethodToBeneficiary    FiPaymentMethodToBeneficiary    `json:"fiPaymentMethodToBeneficiary,omitempty"`
	FiAdditionalFIToFI              AdditionalFiToFi                `json:"fiAdditionalFIToFI,omitempty"`
	CurrencyInstructedAmount        CurrencyInstructedAmount        `json:"currencyInstructedAmount,omitempty"`
	OrderingCustomer                CoverPayment                    `json:"orderingCustomer,omitempty"`
	OrderingInstitution             CoverPayment                    `json:"orderingInstitution,omitempty"`
	IntermediaryInstitution         CoverPayment                    `json:"intermediaryInstitution,omitempty"`
	InstitutionAccount              CoverPayment                    `json:"institutionAccount,omitempty"`
	BeneficiaryCustomer             CoverPayment                    `json:"beneficiaryCustomer,omitempty"`
	Remittance                      CoverPayment                    `json:"remittance,omitempty"`
	SenderToReceiver                CoverPayment                    `json:"senderToReceiver,omitempty"`
	UnstructuredAddenda             UnstructuredAddenda             `json:"unstructuredAddenda,omitempty"`
	RelatedRemittance               RelatedRemittance               `json:"relatedRemittance,omitempty"`
	RemittanceOriginator            RemittanceOriginator            `json:"remittanceOriginator,omitempty"`
	RemittanceBeneficiary           RemittanceBeneficiary           `json:"remittanceBeneficiary,omitempty"`
	PrimaryRemittanceDocument       PrimaryRemittanceDocument       `json:"primaryRemittanceDocument,omitempty"`
	ActualAmountPaid                RemittanceAmount                `json:"actualAmountPaid,omitempty"`
	GrossAmountRemittanceDocument   RemittanceAmount                `json:"grossAmountRemittanceDocument,omitempty"`
	AmountNegotiatedDiscount        RemittanceAmount                `json:"amountNegotiatedDiscount,omitempty"`
	Adjustment                      Adjustment                      `json:"adjustment,omitempty"`
	DateRemittanceDocument          DateRemittanceDocument          `json:"dateRemittanceDocument,omitempty"`
	SecondaryRemittanceDocument     SecondaryRemittanceDocument     `json:"secondaryRemittanceDocument,omitempty"`
	RemittanceFreeText              RemittanceFreeText              `json:"remittanceFreeText,omitempty"`
	ServiceMessage                  ServiceMessage                  `json:"serviceMessage,omitempty"`
}

type FiPaymentMethodToBeneficiary added in v0.3.0 

type FiPaymentMethodToBeneficiary struct {
	// PaymentMethod
	PaymentMethod         string `json:"paymentMethod,omitempty"`
	AdditionalInformation string `json:"AdditionalInformation,omitempty"`
}

type FiToFi added in v0.3.0 

type FiToFi struct {
	// LineOne
	LineOne string `json:"lineOne,omitempty"`
	// LineTwo
	LineTwo string `json:"lineTwo,omitempty"`
	// LineThree
	LineThree string `json:"lineThree,omitempty"`
	// LineFour
	LineFour string `json:"lineFour,omitempty"`
	// LineFive
	LineFive string `json:"lineFive,omitempty"`
	// LineSix
	LineSix string `json:"lineSix,omitempty"`
}

FIToFI

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 File2 added in v0.3.0 

type File2 struct {
	// File ID
	ID          string       `json:"ID,omitempty"`
	FileHeader  FileHeader2  `json:"fileHeader,omitempty"`
	CashLetters []CashLetter `json:"cashLetters,omitempty"`
	Bundles     []Bundle     `json:"bundles,omitempty"`
	FileControl FileControl2 `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 FileControl2 added in v0.3.0 

type FileControl2 struct {
	// FileControl ID
	ID string `json:"ID,omitempty"`
	// CashLetterCount identifies the total number of cash letters within the file.
	CashLetterCount int32 `json:"cashLetterCount"`
	// TotalRecordCount identifies the total number of records of all types sent in the file, including the FileControl.
	TotalRecordCount int32 `json:"totalRecordCount"`
	// totalItemCount identifies the total number of Items sent within the file.
	TotalItemCount int32 `json:"totalItemCount"`
	// FileTotalAmount identifies the total Item amount of the complete file.
	FileTotalAmount int32 `json:"fileTotalAmount"`
	// immediateOriginContactName identifies contact at the institution that creates the file.
	ImmediateOriginContactName string `json:"immediateOriginContactName,omitempty"`
	// ImmediateOriginContactPhoneNumber identifies the phone number of the contact at the institution that creates the file.
	ImmediateOriginContactPhoneNumber string `json:"immediateOriginContactPhoneNumber,omitempty"`
	// CreditTotalIndicator is a code that indicates whether Credits Items are included in this record’s totals. If so they will be included in TotalItemCount and FileTotalAmount. TotalRecordCount includes all records of all types regardless of the value of this field. * ` ` - No Credit Items * `0` - Credit Items are not included in totals * `1` - Credit Items are included in totals
	CreditTotalIndicator string `json:"creditTotalIndicator,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 FileHeader2 added in v0.3.0 

type FileHeader2 struct {
	// FileHeader ID
	ID string `json:"ID,omitempty"`
	// StandardLevel identifies the standard level of the file.  * `03` - DSTU X9.37 - 2003 * `30` - X9.100-187-2008 * `35` - X9.100-187-2013 and 2016
	StandardLevel string `json:"standardLevel"`
	// TestFileIndicator dentifies whether the file is a test or production file.  * `T` - Test File * `P` - Production File
	TestFileIndicator string `json:"testFileIndicator"`
	// ImmediateDestination is the routing and transit number of the Federal Reserve Bank (FRB) or receiver to which the file is being sent.
	ImmediateDestination string `json:"immediateDestination"`
	// ImmediateOrigin is the routing and transit number of the Federal Reserve Bank (FRB) or originator from which the file is being sent.
	ImmediateOrigin string `json:"immediateOrigin"`
	// FileCreationDate is the date that the immediate origin institution creates the file.
	FileCreationDate time.Time `json:"fileCreationDate"`
	// FileCreationTime is the time the immediate origin institution creates the file. (Format - hhmm, where - hh hour, mm minute)
	FileCreationTime string `json:"fileCreationTime"`
	// ResendIndicator Indicates whether the file has been previously transmitted. (Y - Yes, N - No)
	ResendIndicator string `json:"resendIndicator"`
	// ImmediateDestinationName Identifies the short name of the institution that receives the file.
	ImmediateDestinationName string `json:"immediateDestinationName,omitempty"`
	// immediateOriginName identifies the short name of the institution that sends the file.
	ImmediateOriginName string `json:"immediateOriginName,omitempty"`
	// FileIDModifier is a code that permits multiple files, created on the same date, same time and between the same institutions, to be distinguished one from another. If all of the following fields in a previous file are equal to the same fields in this file: FileHeader ImmediateDestination, ImmediateOrigin, FileCreationDate, and FileCreationTime, it must be defined.
	FileIDModifier string `json:"fileIDModifier,omitempty"`
	// CountryCode is a 2-character code as approved by the International Organization for Standardization (ISO) used to identify the country in which the payer bank is located.
	CountryCode string `json:"countryCode,omitempty"`
	// UserField identifies a field used at the discretion of users of the standard.
	UserField string `json:"userField,omitempty"`
	// CompanionDocumentIndicator identifies a field used to indicate the Companion Document being used. Shall be present only under clearing arrangements. Companion Document usage and values defined by clearing arrangements. Values: 0–9 Reserved for United States use A–J Reserved for Canadian use Other - as defined by clearing arrangements.
	CompanionDocumentIndicator string `json:"companionDocumentIndicator,omitempty"`
}

type FinancialInstitution added in v0.3.0 

type FinancialInstitution struct {
	// Identification Code:  * `B` - SWIFT Bank Identifier Code (BIC) * `C` - CHIPS Participant * `D` - Demand Deposit Account (DDA) Number * `F` - Fed Routing Number * `T` - SWIFT BIC or Bank Entity Identifier (BEI) and Account Number * `U` - CHIPS Identifier
	IdentificationCode string `json:"identificationCode"`
	// Identifier
	Identifier string `json:"identifier"`
	// Name
	Name    string   `json:"name"`
	Address Address2 `json:"address"`
}

FinancialInstitution is financial institution demographic information

type Gateway 

type Gateway struct {
	// ID to uniquely identify a gateway
	ID string `json:"ID,omitempty"`
	// 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 GetAccountTransactionsOpts added in v0.2.0 

type GetAccountTransactionsOpts struct {
	Limit      optional.Float32
	XRequestID optional.String
}

type GetClientsForUserIdOpts 

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

type GetCustomerDocumentContentsOpts added in v0.2.0 

type GetCustomerDocumentContentsOpts struct {
	XRequestID optional.String
	XUserID    optional.String
}

type GetCustomerDocumentsOpts added in v0.2.0 

type GetCustomerDocumentsOpts struct {
	XRequestID optional.String
	XUserID    optional.String
}

type GetCustomerOpts 

type GetCustomerOpts struct {
	XRequestID optional.String
	XUserID    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 GetGatewaysOpts 

type GetGatewaysOpts struct {
	XRequestID optional.String
}

type GetICLFileByIDOpts added in v0.3.0 

type GetICLFileByIDOpts struct {
	XRequestID optional.String
}

type GetICLFileContentsOpts added in v0.3.0 

type GetICLFileContentsOpts struct {
	XRequestID optional.String
}

type GetICLFilesOpts added in v0.3.0 

type GetICLFilesOpts struct {
	XRequestID optional.String
}

type GetLatestDownloadsOpts 

type GetLatestDownloadsOpts struct {
	Limit optional.Int32
}

type GetOFACCompanyOpts added in v0.2.0 

type GetOFACCompanyOpts struct {
	XRequestID optional.String
}

type GetOFACCustomerOpts added in v0.2.0 

type GetOFACCustomerOpts struct {
	XRequestID optional.String
}

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 GetWireFileByIDOpts added in v0.3.0 

type GetWireFileByIDOpts struct {
	XRequestID optional.String
}

type GetWireFileContentsOpts added in v0.3.0 

type GetWireFileContentsOpts struct {
	XRequestID optional.String
}

type GetWireFilesOpts added in v0.3.0 

type GetWireFilesOpts struct {
	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 ImageCashLetterFilesApiService added in v0.3.0 

type ImageCashLetterFilesApiService service

func (*ImageCashLetterFilesApiService) AddICLToFile added in v0.3.0 

func (a *ImageCashLetterFilesApiService) AddICLToFile(ctx context.Context, fileID string, cashLetter CashLetter, localVarOptionals *AddICLToFileOpts) (*http.Response, error)

func (*ImageCashLetterFilesApiService) CreateICLFile added in v0.3.0 

func (a *ImageCashLetterFilesApiService) CreateICLFile(ctx context.Context, createFile2 CreateFile2, localVarOptionals *CreateICLFileOpts) (File2, *http.Response, error)

func (*ImageCashLetterFilesApiService) DeleteICLFile added in v0.3.0 

func (a *ImageCashLetterFilesApiService) DeleteICLFile(ctx context.Context, fileID string, localVarOptionals *DeleteICLFileOpts) (*http.Response, error)

func (*ImageCashLetterFilesApiService) DeleteICLFromFile added in v0.3.0 

func (a *ImageCashLetterFilesApiService) DeleteICLFromFile(ctx context.Context, fileID string, cashLetterID string, localVarOptionals *DeleteICLFromFileOpts) (*http.Response, error)

func (*ImageCashLetterFilesApiService) GetICLFileByID added in v0.3.0 

func (a *ImageCashLetterFilesApiService) GetICLFileByID(ctx context.Context, fileID string, localVarOptionals *GetICLFileByIDOpts) (File2, *http.Response, error)

func (*ImageCashLetterFilesApiService) GetICLFileContents added in v0.3.0 

func (a *ImageCashLetterFilesApiService) GetICLFileContents(ctx context.Context, fileID string, localVarOptionals *GetICLFileContentsOpts) (string, *http.Response, error)

func (*ImageCashLetterFilesApiService) GetICLFiles added in v0.3.0 

func (a *ImageCashLetterFilesApiService) GetICLFiles(ctx context.Context, localVarOptionals *GetICLFilesOpts) ([]File2, *http.Response, error)

func (*ImageCashLetterFilesApiService) UpdateICLFile added in v0.3.0 

func (a *ImageCashLetterFilesApiService) UpdateICLFile(ctx context.Context, fileID string, fileHeader2 FileHeader2, localVarOptionals *UpdateICLFileOpts) (File2, *http.Response, error)

func (*ImageCashLetterFilesApiService) ValidateICLFile added in v0.3.0 

func (a *ImageCashLetterFilesApiService) ValidateICLFile(ctx context.Context, fileID string, localVarOptionals *ValidateICLFileOpts) (File2, *http.Response, error)

type ImageViewAnalysis added in v0.3.0 

type ImageViewAnalysis struct {
	// ImageViewAnalysis ID
	ID string `json:"ID,omitempty"`
	// GlobalImageQuality is a code that indicates whether the image view was tested for any of the conditions related to image quality defined in the Image Quality Information.  * `0` -  The image was not tested for any of the image quality conditions * `1` -  The image was tested and one or more image quality conditions were reported * `2` -  The image was tested and no image quality conditions were reported
	GlobalImageQuality string `json:"globalImageQuality,omitempty"`
	// GlobalImageUsability is a code that indicates whether the image view was tested for any of the conditions related to image usability defined in the Image Usability Information.  * `0` -  The image was not tested for any of the image quality conditions * `1` -  The image was tested and one or more image quality conditions were reported * `2` -  The image was tested and no image quality conditions were reported
	GlobalImageUsability string `json:"globalImageUsability,omitempty"`
	// ImagingBankSpecificTest designates the capture institution may be able to perform specific tests that can indicate a potentially problematic image view caused by conditions other than those listed in the Image Quality and Image Usability Information fields. By mutual agreement, clearing partners can use the UserField to report the presence or absence of additional image conditions found through tests that are particular to the specific imaging institution. The meaning and interpretation of the User Field data must be understood and agreed upon between participants.   * `0` -  The image was not tested for any of the image quality conditions * `1` -  The image was tested and one or more image quality conditions were reported * `2` -  The image was tested and no image quality conditions were reported
	ImagingBankSpecificTest string `json:"imagingBankSpecificTest,omitempty"`
	// PartialImage is a code that indicates if only a portion of the image view is represented digitally while the other portion is suspected to be missing or corrupt.  * `0` -  The image was not tested for any of the image quality conditions * `1` -  The image was tested and one or more image quality conditions were reported * `2` -  The image was tested and no image quality conditions were reported
	PartialImage string `json:"partialImage,omitempty"`
	// ExcessiveImageSkew is a code that indicates if the image view skew exceeds an acceptable value. This value is specific to the imaging institution’s own defined requirements and/or constraints.  * `0` -  The image was not tested for any of the image quality conditions * `1` -  The image was tested and one or more image quality conditions were reported * `2` -  The image was tested and no image quality conditions were reported
	ExcessiveImageSkew string `json:"excessiveImageSkew,omitempty"`
	// PiggybackImage is a code that indicates if a “piggyback” condition has been detected. With a “piggyback” condition, the intended image view may be extended, obscured, or replaced by image(s) of additional document(s). A piggyback occurs when two or more documents are fed together and captured as one document when only a single document should have been fed and captured.  * `0` -  The image was not tested for any of the image quality conditions * `1` -  The image was tested and one or more image quality conditions were reported * `2` -  The image was tested and no image quality conditions were reported
	PiggybackImage string `json:"piggybackImage,omitempty"`
	// TooLightOrTooDark is a code that indicates if the image view is too light or too dark. The value is specific to the imaging institution’s own defined requirements and/or constraints.  * `0` -  The image was not tested for any of the image quality conditions * `1` -  The image was tested and one or more image quality conditions were reported * `2` -  The image was tested and no image quality conditions were reported
	TooLightOrTooDark string `json:"tooLightOrTooDark,omitempty"`
	// StreaksAndOrBands is a A code that indicates if the image view is likely corrupted due to streaks and/or bands. Streaks and bands can be caused by such problems as dirt, dust, ink, or debris on a lens or in the optical path, and failures in the imaging equipment scanner.  * `0` -  The image was not tested for any of the image quality conditions * `1` -  The image was tested and one or more image quality conditions were reported * `2` -  The image was tested and no image quality conditions were reported
	StreaksAndOrBands string `json:"streaksAndOrBands,omitempty"`
	// BelowMinimumImageSize is a code that indicates if the size of the compressed image view is below an acceptable value. The value is specific to the imaging institution’s own defined requirements and/or constraints.  * `0` -  The image was not tested for any of the image quality conditions * `1` -  The image was tested and one or more image quality conditions were reported * `2` -  The image was tested and no image quality conditions were reported
	BelowMinimumImageSize string `json:"belowMinimumImageSize,omitempty"`
	// ExceedsMaximumImageSize is a code that indicates if the size of the compressed image view is above an acceptable value. The value is specific to the imaging institution’s own defined requirements and/or constraints.  * `0` -  The image was not tested for any of the image quality conditions * `1` -  The image was tested and one or more image quality conditions were reported * `2` -  The image was tested and no image quality conditions were reported
	ExceedsMaximumImageSize string `json:"exceedsMaximumImageSize,omitempty"`
	// ImageEnabledPOD is a code that indicates if the image view was used within an image-enabled POD (Proof of Deposit) application.  * `0` -  The image was not tested for any of the image quality conditions * `1` -  The image was tested and one or more image quality conditions were reported * `2` -  The image was tested and no image quality conditions were reported
	ImageEnabledPOD string `json:"imageEnabledPOD,omitempty"`
	// SourceDocumentBad is a code that indicates if it is possible to obtain a better image from the source document when it is known that the current image of the document is unusable.  * `0` -  The image was not tested for any of the image quality conditions * `1` -  The image was tested and one or more image quality conditions were reported * `2` -  The image was tested and no image quality conditions were reported
	SourceDocumentBad string `json:"sourceDocumentBad,omitempty"`
	// DateUsability is a code that indicates if the date Area of Interest is usable and readable from the image. The definition of the Area of Interest for image usability testing purposes is specific to the imaging institution's own defined requirements and/or constraint  * `0` -  The image was not tested for any of the image quality conditions * `1` -  The image was tested and one or more image quality conditions were reported * `2` -  The image was tested and no image quality conditions were reported
	DateUsability string `json:"dateUsability,omitempty"`
	// PayeeUsability is a code that indicates if the payee name Area of Interest is usable and readable from the image. The definition of the Area of Interest for image usability testing purposes is specific to the imaging institution's own defined requirements and/or constraints.  * `0` -  The image was not tested for any of the image quality conditions * `1` -  The image was tested and one or more image quality conditions were reported * `2` -  The image was tested and no image quality conditions were reported
	PayeeUsability string `json:"payeeUsability,omitempty"`
	// AmountInWordsUsability is a code that indicates if the amount in words (legal amount) Area of Interest is usable and readable from the image. The definition of the Area of Interest for image usability testing purposes is specific to the imaging institution's own defined requirements and/or constraints.  * `0` -  The image was not tested for any of the image quality conditions * `1` -  The image was tested and one or more image quality conditions were reported * `2` -  The image was tested and no image quality conditions were reported
	ConvenienceAmountUsability string `json:"convenienceAmountUsability,omitempty"`
	// SignatureUsability is a code that indicates if the signature Area of Interest is usable and readable from the image. The definition of the Area of Interest for image usability testing purposes is specific to the imaging institution's own defined requirements and/or constraints.  * `0` -  The image was not tested for any of the image quality conditions * `1` -  The image was tested and one or more image quality conditions were reported * `2` -  The image was tested and no image quality conditions were reported
	AmountInWordsUsability string `json:"amountInWordsUsability,omitempty"`
	//  * `0` -  The image was not tested for any of the image quality conditions * `1` -  The image was tested and one or more image quality conditions were reported * `2` -  The image was tested and no image quality conditions were reported
	SignatureUsability string `json:"signatureUsability,omitempty"`
	// PayorNameAddressUsability is a code that indicates if the payor name and address Area of Interest is usable and readable from the image. The definition of the Area of Interest for image usability testing purposes is specific to the imaging institution's own defined requirements and/or constraints.  * `0` -  The image was not tested for any of the image quality conditions * `1` -  The image was tested and one or more image quality conditions were reported * `2` -  The image was tested and no image quality conditions were reported
	PayorNameAddressUsability string `json:"payorNameAddressUsability,omitempty"`
	// MICRLineUsability is a code that indicates if the MICR line Area of Interest is usable and readable from the image. The definition of the Area of Interest for image usability testing purposes is specific to the imaging institution's own defined requirements and/or constraints.  * `0` -  The image was not tested for any of the image quality conditions * `1` -  The image was tested and one or more image quality conditions were reported * `2` -  The image was tested and no image quality conditions were reported
	MICRLineUsability string `json:"mICRLineUsability,omitempty"`
	// MemoLineUsability is code that indicates if the memo line Area of Interest is usable and readable from the image. The definition of the Area of Interest for image usability testing purposes is specific to the imaging institution's own defined requirements and/or constraints. * `0` -  The image was not tested for any of the image quality conditions * `1` -  The image was tested and one or more image quality conditions were reported * `2` -  The image was tested and no image quality conditions were reported
	MemoLineUsability string `json:"memoLineUsability,omitempty"`
	// PayorBankNameAddressUsability is a code that indicates if the payor bank name and address Area of Interest is usable and readable from the image. The definition of the Area of Interest for image usability testing purposes is specific to the imaging institution's own defined requirements and/or constraints.  * `0` -  The image was not tested for any of the image quality conditions * `1` -  The image was tested and one or more image quality conditions were reported * `2` -  The image was tested and no image quality conditions were reported
	PayorBankNameAddressUsability string `json:"payorBankNameAddressUsability,omitempty"`
	// PayeeEndorsementUsability is a code that indicates if the payee endorsement Area of Interest is usable and readable from the image. The definition of the Area of Interest for image usability testing purposes is specific to the imaging institution's own defined requirements and/or constraints.  * `0` -  The image was not tested for any of the image quality conditions * `1` -  The image was tested and one or more image quality conditions were reported * `2` -  The image was tested and no image quality conditions were reported
	PayeeEndorsementUsability string `json:"payeeEndorsementUsability,omitempty"`
	// BOFDEndorsementUsability is a code that indicates if the Bank of First Deposit (BOFD) endorsement Area of Interest is usable and readable from the image. The definition of the Area of Interest for image usability testing purposes is specific to the imaging institution's own defined requirements and/or constraints.  * `0` -  The image was not tested for any of the image quality conditions * `1` -  The image was tested and one or more image quality conditions were reported * `2` -  The image was tested and no image quality conditions were reported
	BOFDEndorsementUsability string `json:"bOFDEndorsementUsability,omitempty"`
	// TransitEndorsementUsability is a code that indicates if the transit endorsement Area of Interest is usable and readable from the image. The definition of the Area of Interest for image usability testing purposes is specific to the imaging institution's own defined requirements and/or constraints.  * `0` -  The image was not tested for any of the image quality conditions * `1` -  The image was tested and one or more image quality conditions were reported * `2` -  The image was tested and no image quality conditions were reported
	TransitEndorsementUsability string `json:"transitEndorsementUsability,omitempty"`
	// UserField identifies a field used at the discretion of users of the standard.
	UserField string `json:"userField,omitempty"`
}

type ImageViewData added in v0.3.0 

type ImageViewData struct {
	// ImageViewData ID
	ID string `json:"ID,omitempty"`
	// ECEInstitutionRoutingNumber contains the routing and transit number of the institution that that creates the bundle header.  This number is imported from the Bundle Header Record (Clause 9.4) associated with the image view conveyed in this Image View Data Property.
	ECEInstitutionRoutingNumber string `json:"eCEInstitutionRoutingNumber,omitempty"`
	// BundleBusinessDate is the business date of the bundle.
	BundleBusinessDate time.Time `json:"bundleBusinessDate,omitempty"`
	// CycleNumber is a code assigned by the institution that creates the bundle.  Denotes the cycle under which the bundle is created.
	CycleNumber string `json:"cycleNumber,omitempty"`
	// ECEInstitutionItemSequenceNumber is a number assigned by the institution that creates the CheckDetail or Return.  This number is imported from the CheckDetail.ECEInstitutionItemSequenceNumber or Return.ECEInstitutionItemSequenceNumber associated with the image view conveyed in this Image View Data Record. The ECE institution must construct the sequence number to guarantee uniqueness for a given routing number, business day, and cycle number. Must contain a numeric value.
	IvDataECEInstitutionItemSequenceNumber string `json:"ivData.ECEInstitutionItemSequenceNumber,omitempty"`
	// SecurityOriginatorName is a unique name that creates the Digital Signature for data to be exchanged. Shall be present only under clearing arrangements and when ImageViewDetail.DigitalSignatureIndicator is 1 Shall not be present when ImageViewDetail.ImageIndicator is 0.
	IvDataSecurityOriginatorName string `json:"ivData.SecurityOriginatorName,omitempty"`
	// SecurityAuthenticatorName is the unique name that performs authentication on received data. Shall be present only under clearing arrangements and when ImageViewDetail.DigitalSignatureIndicator is 1 Shall not be present when ImageViewDetail.ImageIndicator is 0.
	IvDataSecurityAuthenticatorName string `json:"ivData.SecurityAuthenticatorName,omitempty"`
	// SecurityKeyName is a name or character sequence used by the signer (originator) to communicate a key identifierto the recipient (authenticator) so the recipient can obtain the key needed to validate the signature. The name is typically used as an identifier related to the key pair used to sign the image. The name is mutually known to the security originator and the security authenticator and is unique to this relationship. Shall be present only under clearing arrangements and when ImageViewDetail.DigitalSignatureIndicator is 1 Shall not be present when ImageViewDetail.ImageIndicator is 0.
	IvDataSecurityKeyName string `json:"ivData.SecurityKeyName,omitempty"`
	// ClippingOrigin is a code that defines the corner of the conveyed image view that is taken as the reference point for the clipping coordinates. Top, bottom, left, and right references apply to a view that presents a visually correct orientation. When clipping information is present, the nature of the Area of Interest defined by the clipping rectangle is determined by the value of the ImageViewDetail.ViewDescriptor. Primary front and rear views shall only have a Defined Value of 0.  Can be blank.  * `0` - Clipping information is not present–full view present * `1` - Clipping origin is top left corner of image view * `2` - Clipping origin is top right corner of image view * `3` - Clipping origin is bottom right corner of image view * `4` - Clipping origin is bottom left corner of image view
	IvDataClippingOrigin int32 `json:"ivData.ClippingOrigin,omitempty"`
	// ClippingCoordinateH1 is a number that represents the horizontal offset in pixels from the clipping origin to the nearest vertical side of the clipping rectangle. The clipping coordinates (h1, h2, v1, v2) convey the clipping rectangle’s offsets in both horizontal (h) and vertical (v) directions. The offset values collectively establish the boundary sides of the clipping rectangle. Pixels on the boundary of the clipping rectangle are included in the selected array of pixels. That is, the first pixel of the selected array is at offset (h1, v1) and the last pixel of the selected array is at offset (h2, v2). The corner pixel at the origin of the image view is assumed to have the offset value (0, 0). Shall be present if Image View Data.ClippingOrigin is present and non-zero. Shall not be present when ImageViewDetail.ImageIndicator is 0. Valid values - 0000–9999
	IvDataClippingCoordinateH1 string `json:"ivData.ClippingCoordinateH1,omitempty"`
	// ClippingCoordinateH2 is a number that represents the horizontal offset in pixels from the clipping origin to the furthermost vertical side of the clipping rectangle. Shall be present if Image View Data.ClippingOrigin is present and non-zero. Shall not be present when ImageViewDetail.ImageIndicator is 0. Valid values - 0000–9999
	IvDataClippingCoordinateH2 string `json:"ivData.ClippingCoordinateH2,omitempty"`
	// ClippingCoordinateV1 is a number that represents the vertical offset in pixels from the clipping origin to the nearest horizontal side of the clipping rectangle. Shall be present if Image View Data.ClippingOrigin is present and non-zero. Shall not be present when ImageViewDetail.ImageIndicator is 0. Valid values - 0000–9999
	IvDataClippingCoordinateV1 string `json:"ivData.ClippingCoordinateV1,omitempty"`
	// ClippingCoordinateV2 is number that represents the vertical offset in pixels from the clipping origin to the furthermost horizontal side of the clipping rectangle. Shall be present if Image View Data.ClippingOrigin is present and non-zero. Shall not be present when ImageViewDetail.ImageIndicator is 0. Valid values - 0000–9999
	IvDataClippingCoordinateV2 string `json:"ivData.ClippingCoordinateV2,omitempty"`
	// LengthImageReferenceKey is the number of characters in the ImageViewData.ImageReferenceKey. Shall not be present when ImageViewDetail.ImageIndicator is 0. Valid values - 0000ImageReferenceKey is not present 0001–9999  Valid when ImageReferenceKey is present
	IvDataLengthImageReferenceKey string `json:"ivData.LengthImageReferenceKey,omitempty"`
	// ImageReferenceKey is assigned by the ECE institution that creates the CheckDetail or Return, and the related Image View Records. This designator, when used, shall uniquely identify the item image to the ECE institution. This designator is a special key with significance to the creating institution. It is intended to be used to locate within an archive the unique image associated with the item. The designator could be a full access path and name that would allow direct look up and access to the image, for example a URL. This shall match CheckDetailAddendumB.ImageReferenceKey, or ReturnAddendumCImageReferenceKey Record, if used. Valid size - 0 – 9999
	IvDataImageReferenceKey string `json:"ivData.ImageReferenceKey,omitempty"`
	// LengthDigitalSignature is the number of bytes in the Image View Data.DigitalSignature. Shall not be present when ImageViewDetail.ImageIndicator is 0.
	IvDataLengthDigitalSignature string `json:"ivData.LengthDigitalSignature,omitempty"`
	// DigitalSignature is created by applying the cryptographic algorithm and private/secret key against the data to be protected. The Digital Signature provides user authentication and data integrity. Shall be present only under clearing arrangements and when ImageViewDetail.DigitalSignatureIndicator is 1 Shall not be present when ImageViewDetail.ImageIndicator is 0. Valid size - 0-99999
	IvDataDigitalSignature string `json:"ivData.DigitalSignature,omitempty"`
	// LengthImageData is the number of bytes in the ImageViewData.ImageData. Shall be present when ImageViewDetail.ImageIndicator is NOT 0 Valid values - 0000001–99999999
	IvDataLengthImageData string `json:"ivData.LengthImageData,omitempty"`
	// ImageData contains the image view. The Image Data generally consists of an image header and the image raster data. The image header provides information that is required to interpret the image raster data. The image raster data contains the scanned image of the physical item in raster (line by line) format. Each scan line comprises a set of concatenated pixels. The image comprises a set of scan lines. The image raster data is typically compressed to reduce the number of bytes needed to transmit and store the image. The header/image format type is defined by the ImageViewDetail.ImageViewFormatIndicator . The syntax and semantics of the image header/image format are understood by referring to the appropriate image format specification. The compression scheme used to compress the image raster data is specified in the ImageViewCompressionAlgorithmIdentifier and in the image header portion of the Image Data or by association with the selected image format. Shall be present when ImageViewDetail.ImageIndicator Record is NOT 0. Valid size - 0-9999999
	IvDataImageData string `json:"ivData.ImageData,omitempty"`
}

type ImageViewDetail added in v0.3.0 

type ImageViewDetail struct {
	// ImageViewDetail ID
	ID string `json:"ID,omitempty"`
	// ImageIndicator is a code that indicates the presence and disposition of an image view conveyed in the related ImageViewData.  When an image view is not present (0) then certain conditional fields in this ImageViewDetail and the related ImageViewData shall not be present and will be filled with blank space.  * `0` - Image view not present * `1` - Image view present, actual check * `2` - Image view present, not actual check * `3` - Image view present, unable to determine if value is 1 or 2
	ImageIndicator int32 `json:"imageIndicator,omitempty"`
	// ImageCreatorRoutingNumber identifies the financial institution that created the image view.
	ImageCreatorRoutingNumber string `json:"imageCreatorRoutingNumber,omitempty"`
	// ImageCreatorDate is the date assigned by the image creator for the image view conveyed in the related ImageData.
	ImageCreatorDate time.Time `json:"imageCreatorDate,omitempty"`
	// ImageViewFormatIndicator is a code that identifies the type of image format used in the related ImageViewData.ImageData. The image format type is also commonly specified by reference to the file extension used when image data is saved as an image file.  Agreement not required: * `00` - TIFF 6; Extension: TIF Agreement required: * `01` - IOCA FS 11; Extension: ICA * `20` - PNG (Portable Network Graphics); Extension: PNG ‘21’JFIF (JPEG File Interchange Format); Extension: JPG * `22` - SPIFF (Still Picture Interchange File Format) (ITU-T Rec. T.84 Annex F); Extension: SPF * `23` - JBIG data stream (ITU-T Rec. T.82/ISO/IEC 11544:1993); Extension: JBG ‘24’JPEG 2000 (ISO/IEC 15444-1:2000); Extension: JP2
	ImageViewFormatIndicator string `json:"imageViewFormatIndicator,omitempty"`
	// ImageViewCompressionAlgorithm is a code that identifies the algorithm or method used to compress the Image Data in the related ImageViewData.ImageData.  Agreement not required: * `00` - Group 4 facsimile compression (ITU-T Rec. T.563/CCITT Rec. T.6) Agreement required: * `01` - JPEG Baseline (JPEG Interchange Format) (ITU-T Rec. T.81/ISO/IEC 10918) * `02` - ABIC * `21` - PNG (Portable Network Graphics) * `22` - JBIG (ITU-T Rec. T.82/ISO/IEC 11544:1993) * `23` - JPEG 2000 (ISO/IEC 15444–1:2000)
	ImageViewCompressionAlgorithm string `json:"imageViewCompressionAlgorithm,omitempty"`
	// ViewSideIndicator is a code that indicates the image view conveyed in the related ImageViewData. An image view may be a full view of the item (i.e., the entire full face of the document) or may be a partial view (snippet) as determined by viewDescriptor.  * `0` - Front image view * `1` - Rear image view
	ViewSideIndicator string `json:"viewSideIndicator,omitempty"`
	// ViewDescriptor is a code that indicates the nature of the image view based on ImageViewData.ImageData.  * `00` -  Full view * `01` -  Partial view–unspecified Area of Interest * `02` -  Partial view–date Area of Interest * `03` -  Partial view–payee Area of Interest * `04` -  Partial view–convenience amount Area of Interest * `05` -  Partial view–amount in words (legal amount) Area of Interest * `06` -  Partial view–signature Area(s) of Interest * `07` -  Partial view–payor name and address Area of Interest * `08` -  Partial view–MICR line Area of Interest * `09` -  Partial view–memo line Area of Interest * `10` -  Partial view–payor bank name and address Area of Interest * `11` -  Partial view–payee endorsement Area of Interest * `12` -  Partial view–Bank Of First Deposit (BOFD) endorsement Area of Interest * `13` -  Partial view–transit endorsement Area of Interest * `14 - 99` -  Reserved for X9
	ViewDescriptor string `json:"viewDescriptor,omitempty"`
	// DigitalSignatureIndicator is a code that indicates the presence or absence of a digital signature for the image view contained in ImageViewData.ImageData. If present, the Digital Signature is conveyed in the related DigitalSignature.  * `0` - Digital Signature is not present * `1` - Digital Signature is present
	DigitalSignatureIndicator string `json:"digitalSignatureIndicator,omitempty"`
	// DigitalSignatureMethod is a code that identifies the cryptographic algorithm used to generate and validate the Digital Signature in ImageViewData.DigitalSignature. * `00` - Digital Signature Algorithm (DSA) with SHA1 (ANSI X9.30) * `01` - RSA with MD5 (ANSI X9.31) * `02` - RSA with MDC2 (ANSI X9.31) * `03` - RSA with SHA1 (ANSI X9.31) * `04` - Elliptic Curve DSA (ECDSA) with SHA1 (ANSI X9.62) * `05 - 99` - Reserved for emerging cryptographic algorithms.
	DigitalSignatureMethod string `json:"digitalSignatureMethod,omitempty"`
	// SecurityKeySize is the length in bits of the cryptographic algorithm key used to create the Digital Signature. Valid values 0–99999
	SecurityKeySize int32 `json:"securityKeySize,omitempty"`
	// ProtectedDataStart is a number that represents the offset in bytes from the first byte (counted as byte 1) of the image data in ImageViewData.ImageData to the first byte of the image data protected by the digital signature. Valid values - 0000000 - Digital Signature is applied to entire image data 000001–9999999 - Valid offset values
	ProtectedDataStart int32 `json:"protectedDataStart,omitempty"`
	// ProtectedDataLength is number of contiguous bytes of image data in the related ImageViewData.ImageData protected by the digital signature starting with the byte indicated by the value of the ProtectedDataStart in this ImageViewDetail. The ProtectedDataLength value shall not exceed the ImageViewData.ImageDataLength. Valid values - 0000000 - Digital Signature is applied to entire image data 000001–9999999 - Valid length values
	ProtectedDataLength int32 `json:"protectedDataLength,omitempty"`
	// ImageRecreateIndicator is a code that indicates whether the sender has the ability to recreate the image view conveyed in the related ImageViewData.ImageData.  * `0` - Sender can recreate the image view for the duration of the agreed upon retention time frames. * `1` - Sender cannot recreate image view.
	ImageRecreateIndicator int32 `json:"imageRecreateIndicator,omitempty"`
	// UserField identifies a field used at the discretion of users of the standard.
	UserField string `json:"userField,omitempty"`
	// OverrideIndicator is a code that indicates to a receiving exchange partner that this image view has a detected image test failure that cannot be corrected and that this view shall be accepted regardless of any image test failures.  * ` ` -  blank/space indicates no observed image test failure present * `0` -  No override information for this view or not applicable * `1` -  Imperfect image * `A` -  IQA Fail–Image view reviewed and deemed usable—no alternate format * `B` -  IQA Fail–Image view reviewed and deemed usable—alternate format included in this file * `C` -  IQA Fail–Image view reviewed and deemed usable–alternate format included in this file and original document available * `D` -  IQA Fail–Image view reviewed and deemed usable–alternate format available * `E` -  IQA Fail–Image view reviewed and deemed usable–original document available * `F` -  IQA Fail–Image view reviewed and deemed usable–original document and alternate format available * `G` -  IQA Fail–Image view reviewed and deemed unusable–no alternate format * `H` -  IQA Fail–Image view reviewed and deemed unusable–alternate format included in this file * `I` -  IQA Fail–Image view reviewed and deemed unusable–alternate format included in this file and original document available * `J` -  IQA Fail–Image view reviewed and deemed unusable–alternate format available * `K` -  IQA Fail–Image view reviewed and deemed unusable–original document available * `L` -  IQA Fail–Image view reviewed and deemed unusable–original document and alternate format available * `M` -  IQA Fail–Image view not reviewed–no alternate format * `N` -  IQA Fail–Image view not reviewed–alternate format included in this file * `O` -  IQA Fail–Image view not reviewed–alternate format included in this file and original
	OverrideIndicator string `json:"overrideIndicator,omitempty"`
}

type InitiateMicroDepositsOpts 

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

type InlineObject added in v0.2.0 

type InlineObject struct {
	// Document to be uploaded
	File *os.File `json:"file"`
}

type InputMessageAccountabilityData added in v0.3.0 

type InputMessageAccountabilityData struct {
	// InputCycleDate CCYYMMDD
	InputCycleDate string `json:"inputCycleDate"`
	// InputSource
	InputSource string `json:"inputSource"`
	// InputSequenceNumber
	InputSequenceNumber string `json:"inputSequenceNumber"`
}

InputMessageAccountabilityData (IMAD)

type InstructedAmount added in v0.3.0 

type InstructedAmount struct {
	// CurrencyCode
	CurrencyCode string `json:"currencyCode,omitempty"`
	// Amount  Must begin with at least one numeric character (0-9) and contain only one decimal comma marker (e.g., $1,234.56 should be entered as 1234,56 and $0.99 should be entered as
	Amount string `json:"amount,omitempty"`
}

InstructedAmount is the instructed amount

type LocalInstrument added in v0.3.0 

type LocalInstrument struct {
	// LocalInstrument  * `ANSI` - ANSI X12 format * `COVS` - Sequence B Cover Payment Structured * `GXML` - General XML format * `IXML` - ISO 20022 XML formaT * `NARR` - Narrative Text * `PROP` - Proprietary Local Instrument Code * `RMTS` - Remittance Information Structured * `RRMT` - Related Remittance Information * `S820` - STP 820 format * `SWIF` - SWIFT field 70 (Remittance Information) * `UEDI` - UN/EDIFACT format
	LocalInstrumentCode string `json:"localInstrumentCode,omitempty"`
	// ProprietaryCode
	ProprietaryCode string `json:"proprietaryCode,omitempty"`
}

LocalInstrument is the local instrument

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 MessageDisposition added in v0.3.0 

type MessageDisposition struct {
	// formatVersion identifies the format version 30
	FormatVersion string `json:"formatVersion,omitempty"`
	// testProductionCode identifies if test or production.  * `T` - Test * `P` - Production
	TestProductionCode string `json:"testProductionCode,omitempty"`
	// MessageDuplicationCode  * ` ` - Original Message * `R` - Retrieval of an original message * `P` - Resend
	MessageDuplicationCode string `json:"messageDuplicationCode,omitempty"`
	// MessageStatusIndicator  Outgoing Messages * `0` - In process or Intercepted * `2` - Successful with Accounting (Value) * `3` - Rejected due to Error Condition * `7` - Successful without Accounting (Non-Value)  Incoming Messages * `N` - Successful with Accounting (Value) * `S` - Successful without Accounting (Non-Value)
	MessageStatusIndicator string `json:"messageStatusIndicator,omitempty"`
}

type MonitorApiService 

type MonitorApiService service

func (*MonitorApiService) PingACH 

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

func (*MonitorApiService) PingAccounts added in v0.2.0 

func (a *MonitorApiService) PingAccounts(ctx context.Context, localVarOptionals *PingAccountsOpts) (*http.Response, error)

func (*MonitorApiService) PingAuth 

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

func (*MonitorApiService) PingCustomers added in v0.2.0 

func (a *MonitorApiService) PingCustomers(ctx context.Context, localVarOptionals *PingCustomersOpts) (*http.Response, error)

func (*MonitorApiService) PingFED 

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

func (*MonitorApiService) PingImageCashLetter added in v0.3.0 

func (a *MonitorApiService) PingImageCashLetter(ctx context.Context, localVarOptionals *PingImageCashLetterOpts) (*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) AddOFACCompanyNameWatch added in v0.2.0 

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

func (*OFACApiService) AddOFACCompanyWatch added in v0.2.0 

func (a *OFACApiService) AddOFACCompanyWatch(ctx context.Context, companyID string, watchRequest WatchRequest, localVarOptionals *AddOFACCompanyWatchOpts) (Watch, *http.Response, error)

func (*OFACApiService) AddOFACCustomerNameWatch added in v0.2.0 

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

func (*OFACApiService) AddOFACCustomerWatch added in v0.2.0 

func (a *OFACApiService) AddOFACCustomerWatch(ctx context.Context, customerID string, watchRequest WatchRequest, localVarOptionals *AddOFACCustomerWatchOpts) (Watch, *http.Response, error)

func (*OFACApiService) GetLatestDownloads 

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

func (*OFACApiService) GetOFACCompany added in v0.2.0 

func (a *OFACApiService) GetOFACCompany(ctx context.Context, companyID string, localVarOptionals *GetOFACCompanyOpts) (OfacCompany, *http.Response, error)

func (*OFACApiService) GetOFACCustomer added in v0.2.0 

func (a *OFACApiService) GetOFACCustomer(ctx context.Context, customerID string, localVarOptionals *GetOFACCustomerOpts) (OfacCustomer, *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) RemoveOFACCompanyNameWatch added in v0.2.0 

func (a *OFACApiService) RemoveOFACCompanyNameWatch(ctx context.Context, watchID string, name string, localVarOptionals *RemoveOFACCompanyNameWatchOpts) (*http.Response, error)

func (*OFACApiService) RemoveOFACCompanyWatch added in v0.2.0 

func (a *OFACApiService) RemoveOFACCompanyWatch(ctx context.Context, companyID string, watchID string, localVarOptionals *RemoveOFACCompanyWatchOpts) (*http.Response, error)

func (*OFACApiService) RemoveOFACCustomerNameWatch added in v0.2.0 

func (a *OFACApiService) RemoveOFACCustomerNameWatch(ctx context.Context, watchID string, name string, localVarOptionals *RemoveOFACCustomerNameWatchOpts) (*http.Response, error)

func (*OFACApiService) RemoveOFACCustomerWatch added in v0.2.0 

func (a *OFACApiService) RemoveOFACCustomerWatch(ctx context.Context, customerID string, watchID string, localVarOptionals *RemoveOFACCustomerWatchOpts) (*http.Response, error)

func (*OFACApiService) Search added in v0.2.0 

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

func (*OFACApiService) UpdateOFACCompanyStatus added in v0.2.0 

func (a *OFACApiService) UpdateOFACCompanyStatus(ctx context.Context, companyID string, updateCompanyStatus UpdateCompanyStatus, localVarOptionals *UpdateOFACCompanyStatusOpts) (*http.Response, error)

func (*OFACApiService) UpdateOFACCustomerStatus added in v0.2.0 

func (a *OFACApiService) UpdateOFACCustomerStatus(ctx context.Context, customerID string, updateCustomerStatus UpdateCustomerStatus, localVarOptionals *UpdateOFACCustomerStatusOpts) (*http.Response, error)

type OfacCompany added in v0.2.0 

type OfacCompany struct {
	// OFAC Company ID
	ID        string            `json:"ID,omitempty"`
	Sdn       Sdn               `json:"sdn,omitempty"`
	Addresses []Address         `json:"addresses,omitempty"`
	Alts      []Alt             `json:"alts,omitempty"`
	Status    OfacCompanyStatus `json:"status,omitempty"`
}

OFAC Company and metadata

type OfacCompanyStatus added in v0.2.0 

type OfacCompanyStatus 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 Company
	Status    string    `json:"status,omitempty"`
	CreatedAt time.Time `json:"createdAt,omitempty"`
}

Status properties of an OFAC Company

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 OriginatorOptionF added in v0.3.0 

type OriginatorOptionF struct {
	// PartyIdentifier  Must be one of the following two formats: 1./Account Number (slash followed by at least one valid non-space character:  e.g., /123456)  2.Unique Identifier/ (4 character code followed by a slash and at least one valid non-space character:    e.g., SOSE/123-456-789) ARNU: Alien Registration Number CCPT: Passport Number CUST: Customer Identification Number  DRLC/    Driver’s License Number  EMPL/    Employer Number NIDN: National Identify Number  SOSE/    Social Security Number TXID: Tax Identification Number
	PartyIdentifier string `json:"partyIdentifier,omitempty"`
	// Name  Format:  Must begin with Line Code 1 followed by a slash and at least one valid non-space character: e.g., 1/SMITH JOHN.
	Name string `json:"name,omitempty"`
	// LineOne  Format: Must begin with one of the following Line Codes followed by a slash and at least one valid non-space character. 1Name 2Address 3Country and Town 4Date of Birth 5Place of Birth 6Customer Identification Number 7National Identity Number 8Additional Information  For example: 2/123 MAIN STREET 3/US/NEW YORK, NY 10000 7/111-22-3456
	LineOne string `json:"lineOne,omitempty"`
	// LineTwo  Format: Must begin with one of the following Line Codes followed by a slash and at least one valid non-space character. 1Name 2Address 3Country and Town 4Date of Birth 5Place of Birth 6Customer Identification Number 7National Identity Number 8Additional Information  For example: 2/123 MAIN STREET 3/US/NEW YORK, NY 10000 7/111-22-3456
	LineTwo string `json:"lineTwo,omitempty"`
	// LineThree  Format: Must begin with one of the following Line Codes followed by a slash and at least one valid non-space character. 1Name 2Address 3Country and Town 4Date of Birth 5Place of Birth 6Customer Identification Number 7National Identity Number 8Additional Information  For example: 2/123 MAIN STREET 3/US/NEW YORK, NY 10000 7/111-22-3456
	LineThree string `json:"lineThree,omitempty"`
}

OptionF is originator option F

type OriginatorToBeneficiary added in v0.3.0 

type OriginatorToBeneficiary struct {
	// LineOne
	LineOne string `json:"lineOne,omitempty"`
	// LineTwo
	LineTwo string `json:"lineTwo,omitempty"`
	// LineThree
	LineThree string `json:"lineThree,omitempty"`
	// LineFour
	LineFour string `json:"lineFour,omitempty"`
}

OriginatorToBeneficiary

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 OutputMessageAccountabilityData added in v0.3.0 

type OutputMessageAccountabilityData struct {
	// OutputCycleDate (CCYYMMDD)
	OutputCycleDate string `json:"outputCycleDate,omitempty"`
	// OutputDestinationID
	OutputDestinationID string `json:"outputDestinationID,omitempty"`
	// OutputSequenceNumber
	OutputSequenceNumber string `json:"outputSequenceNumber,omitempty"`
	// Output Date MMDD, based on the calendar date
	OutputDate string `json:"outputDate,omitempty"`
	// Output Time HHMM, based on a 24-hour clock, Eastern Time
	OutputTime string `json:"outputTime,omitempty"`
	// OutputFRBApplicationIdentification
	OutputFRBApplicationIdentification string `json:"outputFRBApplicationIdentification,omitempty"`
}

type PaymentNotification added in v0.3.0 

type PaymentNotification struct {
	// Payment Notification Indicator  * `0 - 6` - Reserved for market practice conventions. * `7 - 9` - Reserved for bilateral agreements between Fedwire senders and receivers.
	PaymentNotificationIndicator string `json:"paymentNotificationIndicator,omitempty"`
	// ContactNotificationElectronicAddress
	ContactNotificationElectronicAddress string `json:"contactNotificationElectronicAddress,omitempty"`
	// ContactName
	ContactName string `json:"contactName,omitempty"`
	// ContactPhoneNumber
	ContactPhoneNumber string `json:"contactPhoneNumber,omitempty"`
	// ContactMobileNumber
	ContactMobileNumber string `json:"contactMobileNumber,omitempty"`
	// FaxNumber
	FaxNumber string `json:"faxNumber,omitempty"`
	// EndToEndIdentification
	EndToEndIdentification string `json:"endToEndIdentification,omitempty"`
}

PaymentNotification is the payment notification

type Personal added in v0.3.0 

type Personal struct {
	// Identification Code:  * `1` - Passport Number * `2` - Tax Identification Number * `3` - Driver’s License Number * `4` - Alien Registration Number * `5` - Corporate Identification * `9` - Other Identification
	IdentificationCode string `json:"identificationCode"`
	// Identifier
	Identifier string `json:"identifier"`
	// Name
	Name    string   `json:"name"`
	Address Address2 `json:"address"`
}

Personal is personal demographic information

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 PingAccountsOpts added in v0.2.0 

type PingAccountsOpts struct {
	XRequestID optional.String
}

type PingAuthOpts 

type PingAuthOpts struct {
	XRequestID optional.String
}

type PingCustomersOpts added in v0.2.0 

type PingCustomersOpts struct {
	XRequestID optional.String
}

type PingFEDOpts 

type PingFEDOpts struct {
	XRequestID optional.String
}

type PingImageCashLetterOpts added in v0.3.0 

type PingImageCashLetterOpts struct {
	XRequestID optional.String
}

type PingOFACOpts 

type PingOFACOpts struct {
	XRequestID optional.String
}

type PingPaygateOpts 

type PingPaygateOpts struct {
	XRequestID optional.String
}

type PreviousMessageIdentifier added in v0.3.0 

type PreviousMessageIdentifier struct {
	// PreviousMessageIdentifier
	PreviousMessageIdentifier string `json:"previousMessageIdentifier,omitempty"`
}

The identifier for a previous message

type PrimaryRemittanceDocument added in v0.3.0 

type PrimaryRemittanceDocument struct {
	// Document Type Code  * `AROI` - Accounts Receivable Open Item * `BOLD` - Bill of Lading Shipping Notice * `CINV` - Commercial Invoice * `CMCN` - Commercial Contract * `CNFA` - Credit Note Related to Financial Adjustment * `CREN` - Credit Note * `DEBN` - Debit Note * `DISP` - Dispatch Advice * `DNFA` - Debit Note Related to Financial Adjustment HIRI Hire Invoice * `MSIN` - Metered Service Invoice * `PROP` - Proprietary Document Type * `PUOR` - Purchase Order * `SBIN` - Self Billed Invoice * `SOAC` - Statement of Account * `TSUT` - Trade Services Utility Transaction VCHR Voucher
	DocumentTypeCode string `json:"documentTypeCode,omitempty"`
	// ProprietaryDocumentTypeCode
	ProprietaryDocumentTypeCode string `json:"proprietaryDocumentTypeCode,omitempty"`
	// DocumentIdentificationNumber
	DocumentIdentificationNumber string `json:"documentIdentificationNumber,omitempty"`
	// Issuer
	Issuer string `json:"issuer,omitempty"`
}

type ReceiptTimeStamp added in v0.3.0 

type ReceiptTimeStamp struct {
	// ReceiptDate MMDD, based on the calendar date
	ReceiptDate string `json:"receiptDate,omitempty"`
	// ReceiptTime HHMM, based on a 24-hour clock, Eastern Time
	ReceiptTime string `json:"receiptTime,omitempty"`
	// ApplicationIdentification
	ReceiptApplicationIdentification string `json:"receiptApplicationIdentification,omitempty"`
}

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 ReceiverDepositoryInstitution added in v0.3.0 

type ReceiverDepositoryInstitution struct {
	// ReceiverABANumber
	ReceiverABANumber string `json:"receiverABANumber"`
	// ReceiverShortName
	ReceiverShortName string `json:"receiverShortName"`
}

ReceiverDepositoryInstitution is the receiver depository institution

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 RelatedRemittance added in v0.3.0 

type RelatedRemittance struct {
	// RemittanceIdentification
	RemittanceIdentification string `json:"remittanceIdentification,omitempty"`
	// RemittanceLocationMethod  * `EDIC` - Electronic Data Interchange * `EMAL` - Email * `FAXI` - Fax * `POST` - Postal services * `SMS` - Short Message Service (text) * `URI` - Uniform Resource Identifier
	RemittanceLocationMethod string `json:"remittanceLocationMethod,omitempty"`
	// RemittanceLocationElectronicAddress (E-mail or URL address)
	RemittanceLocationElectronicAddress string         `json:"remittanceLocationElectronicAddress,omitempty"`
	RemittanceData                      RemittanceData `json:"remittanceData,omitempty"`
}

RelatedRemittance

type RemittanceAmount added in v0.3.0 

type RemittanceAmount struct {
	// CurrencyCode
	CurrencyCode string `json:"currencyCode,omitempty"`
	// Amount Must contain at least one numeric character and only one decimal period marker (e.g., $1,234.56 should be entered as 1234.56). Can have up to 5 numeric characters following the decimal period marker (e.g., 1234.56789). Amount must be greater than zero (i.e., at least .01).
	Amount string `json:"amount,omitempty"`
}

RemittanceAmount

type RemittanceBeneficiary added in v0.3.0 

type RemittanceBeneficiary struct {
	// IdentificationType  * `OI` - Organization ID * `PI` - Private ID
	IdentificationType string `json:"identificationType,omitempty"`
	// IdentificationCode  Organization Identification Codes  * `BANK` - Bank Party Identification * `CUST` - Customer Number * `DUNS` - Data Universal Number System (Dun & Bradstreet) * `EMPL` - Employer Identification Number * `GS1G` - Global Location Number * `PROP` - Proprietary Identification Number * `SWBB` - SWIFT BIC or BEI * `TXID` - Tax Identification Number  Private Identification Codes  * `ARNU` - Alien Registration Number * `CCPT` - Passport Number * `CUST` - Customer Number * `DPOB` - Date & Place of Birth * `DRLC` - Driver’s License Number * `EMPL` - Employee Identification Number * `NIDN` - National Identity Number * `PROP` - Proprietary Identification Number * `SOSE` - Social Security Number * `TXID` - Tax Identification Number
	IdentificationCode string `json:"identificationCode,omitempty"`
	// IdentificationNumber
	IdentificationNumber string `json:"identificationNumber,omitempty"`
	// IdentificationNumberIssuer
	IdentificationNumberIssuer string `json:"identificationNumberIssuer,omitempty"`
	// DateBirthPlace
	DateBirthPlace string         `json:"dateBirthPlace,omitempty"`
	RemittanceData RemittanceData `json:"remittanceData,omitempty"`
}

type RemittanceData added in v0.3.0 

type RemittanceData struct {
	// Name
	Name string `json:"name,omitempty"`
	// AddressType  * `ADDR` - Complete Postal Address * `BIZZ` - Business Address * `DLVY` - Delivery Address * `HOME` - Home Address * `MLTO` - Mail Address * `PBOX` - Post Office Box
	AddressType string `json:"addressType,omitempty"`
	// Department
	Department string `json:"department,omitempty"`
	// SubDepartment
	SubDepartment string `json:"subDepartment,omitempty"`
	// StreetName
	StreetName string `json:"streetName,omitempty"`
	// BuildingNumber
	BuildingNumber string `json:"buildingNumber,omitempty"`
	// PostCode
	PostCode string `json:"postCode,omitempty"`
	// TownName
	TownName string `json:"townName,omitempty"`
	// CountrySubDivisionState
	CountrySubDivisionState string `json:"countrySubDivisionState,omitempty"`
	// Country
	Country string `json:"country,omitempty"`
	// AddressLineOne
	AddressLineOne string `json:"addressLineOne,omitempty"`
	// AddressLineTwo
	AddressLineTwo string `json:"addressLineTwo,omitempty"`
	// AddressLineThree
	AddressLineThree string `json:"addressLineThree,omitempty"`
	// AddressLineFour
	AddressLineFour string `json:"addressLineFour,omitempty"`
	// AddressLineFive
	AddressLineFive string `json:"addressLineFive,omitempty"`
	// AddressLineSix
	AddressLineSix string `json:"addressLineSix,omitempty"`
	// AddressLineSeven
	AddressLineSeven string `json:"addressLineSeven,omitempty"`
	// CountryOfResidence
	CountryOfResidence string `json:"countryOfResidence,omitempty"`
}

type RemittanceFreeText added in v0.3.0 

type RemittanceFreeText struct {
	// LineOne
	LineOne string `json:"lineOne,omitempty"`
	// LineTwo
	LineTwo string `json:"lineTwo,omitempty"`
	// LineThree
	LineThree string `json:"lineThree,omitempty"`
}

type RemittanceOriginator added in v0.3.0 

type RemittanceOriginator struct {
	// Identification Type  * `OI` - Organization ID * `PI` - Private ID
	IdentificationType string `json:"identificationType,omitempty"`
	// IdentificationCode  Organization Identification Codes  * `BANK` - Bank Party Identification * `CUST` - Customer Number * `DUNS` - Data Universal Number System (Dun & Bradstreet) * `EMPL` - Employer Identification Number * `GS1G` - Global Location Number * `PROP` - Proprietary Identification Number * `SWBB` - SWIFT BIC or BEI * `TXID` - Tax Identification Number  Private Identification Codes  * `ARNU` - Alien Registration Number * `CCPT` - Passport Number * `CUST` - Customer Number * `DPOB` - Date & Place of Birth * `DRLC` - Driver’s License Number * `EMPL` - Employee Identification Number * `NIDN` - National Identity Number * `PROP` - Proprietary Identification Number * `SOSE` - Social Security Number * `TXID` - Tax Identification Number
	IdentificationCode string `json:"identificationCode,omitempty"`
	// IdentificationNumber
	IdentificationNumber string `json:"identificationNumber,omitempty"`
	// IdentificationNumberIssuer
	IdentificationNumberIssuer string `json:"identificationNumberIssuer,omitempty"`
	// DateBirthPlace
	DateBirthPlace string         `json:"dateBirthPlace,omitempty"`
	RemittanceData RemittanceData `json:"remittanceData,omitempty"`
	// CountryOfResidence
	CountryOfResidence string `json:"countryOfResidence,omitempty"`
	// ContactName
	ContactName string `json:"contactName,omitempty"`
	// ContactPhoneNumber
	ContactPhoneNumber string `json:"contactPhoneNumber,omitempty"`
	// ContactMobileNumber
	ContactMobileNumber string `json:"contactMobileNumber,omitempty"`
	// ContactFaxNumber
	ContactFaxNumber string `json:"contactFaxNumber,omitempty"`
	// ContactElectronicAddress ( i.e., E-mail or URL address)
	ContactElectronicAddress string `json:"contactElectronicAddress,omitempty"`
	// ContactOther
	ContactOther string `json:"contactOther,omitempty"`
}

RemittanceOriginator

type RemoveOFACCompanyNameWatchOpts added in v0.2.0 

type RemoveOFACCompanyNameWatchOpts struct {
	XRequestID optional.String
}

type RemoveOFACCompanyWatchOpts added in v0.2.0 

type RemoveOFACCompanyWatchOpts struct {
	XRequestID optional.String
}

type RemoveOFACCustomerNameWatchOpts added in v0.2.0 

type RemoveOFACCustomerNameWatchOpts struct {
	XRequestID optional.String
}

type RemoveOFACCustomerWatchOpts added in v0.2.0 

type RemoveOFACCustomerWatchOpts struct {
	XRequestID optional.String
}

type ReturnDetail added in v0.3.0 

type ReturnDetail struct {
	// CheckDetail ID
	ID string `json:"ID,omitempty"`
	// PayorBankRoutingNumber identifies a number that identifies the institution by or through which the item is payable. Must be a valid routing and transit number issued by the ABA’s Routing Number Registrar. Shall represent the first 8 digits of a 9-digit routing number or 8 numeric digits of a 4 dash 4 routing number. A valid routing number consists of 2 fields: the eight- digit Payor Bank Routing Number  and the one-digit Payor Bank Routing Number Check Digit.
	PayorBankRoutingNumber string `json:"payorBankRoutingNumber,omitempty"`
	// PayorBankCheckDigit identifies a digit representing the routing number check digit.  The combination of Payor Bank Routing Number and payor Bank Routing Number Check Digit must be a mod-checked routing number with a valid check digit.
	PayorBankCheckDigit string `json:"payorBankCheckDigit,omitempty"`
	// OnUs identifies data specified by the payor bank. On-Us data usually consists of the payor’s account number, a serial number or transaction code, or both.
	OnUs string `json:"onUs,omitempty"`
	// Amount identifies the amount of the check.  All amounts fields have two implied decimal points. e.g., 100000 is $1,000.00
	ItemAmount int32 `json:"itemAmount,omitempty"`
	// ReturnReason is a code that indicates the reason for non-payment.
	ReturnReason string `json:"returnReason,omitempty"`
	// AddendumCount is a number of Check Detail Record Addenda to follow. This represents the number of CheckDetailAddendumA, CheckDetailAddendumB and CheckDetailAddendumC types.  It matches the total number of addendum records associated with this item. The standard supports up to 99 addendum records.
	AddendumCount int32 `json:"addendumCount,omitempty"`
	// DocumentationTypeIndicator identifies a code that indicates the type of documentation that supports the check record.  This field is superseded by the Cash Letter Documentation Type Indicator in the Cash Letter Header Record for all Defined Values except ‘Z’ Not Same Type. In the case of Defined Value of ‘Z’, the Documentation Type Indicator in this record takes precedent.  Shall be present when Cash Letter Documentation Type Indicator in the Cash Letter Header Record is Defined Value of ‘Z’.  * `A` - No image provided, paper provided separately * `B` - No image provided, paper provided separately, image upon request * `C` - Image provided separately, no paper provided * `D` - Image provided separately, no paper provided, image upon request * `E` - Image and paper provided separately * `F` - Image and paper provided separately, image upon request * `G` - Image included, no paper provided * `H` - Image included, no paper provided, image upon request * `I` - Image included, paper provided separately * `J` - Image included, paper provided separately, image upon request * `K` - No image provided, no paper provided * `L` - No image provided, no paper provided, image upon request * `M` - No image provided, Electronic Check provided separately
	DocumentationTypeIndicator string `json:"documentationTypeIndicator,omitempty"`
	// ForwardBundleDate represents for electronic check exchange items, the year, month, and day that designates the business date of the original forward bundle. This data is transferred from the BundleHeader BundleBusinessDate.  For items presented in paper cash letters, the year, month, and day that the cash letter was created.
	ForwardBundleDate time.Time `json:"forwardBundleDate,omitempty"`
	// ECEInstitutionItemSequenceNumber identifies a number assigned by the institution that creates the CheckDetail. Field must contain a numeric value. It cannot be all blanks.
	ECEInstitutionItemSequenceNumber string `json:"eCEInstitutionItemSequenceNumber,omitempty"`
	// ExternalProcessingCode identifies a code used for special purposes as authorized by the Accredited Standards Committee X9. Also known as Position 44.
	ExternalProcessingCode string `json:"externalProcessingCode,omitempty"`
	// ReturnNotificationIndicator is a code that identifies the type of notification. The CashLetterHeader.CollectionTypeIndicator and the BundleHeader.CollectionTypeIndicator when equal 05 or 06 takes precedence over this field.  * `1` - Preliminary notification * `2` - Final notification
	ReturnNotificationIndicator string `json:"returnNotificationIndicator,omitempty"`
	// ArchiveTypeIndicator is a code that indicates the type of archive that supports this CheckDetail. Access method, availability and time-frames shall be defined by clearing arrangements. * `A` - Microfilm * `B` - Image * `C` - Paper * `D` - Microfilm and image * `E` - Microfilm and paper * `F` - Image and paper * `G` - Microfilm, image and paper * `H` - Electronic Check Instrument * `I` - None
	ArchiveTypeIndicator string `json:"archiveTypeIndicator,omitempty"`
	// TimesReturned is code used to indicate the number of times the paying bank has returned this item.  * `0` - The item has been returned an unknown number of times * `1` - The item has been returned once * `2` - The item has been returned twice * `3` - The item has been returned three times
	TimesReturned         int32                 `json:"timesReturned,omitempty"`
	ReturnDetailAddendumA ReturnDetailAddendumA `json:"returnDetailAddendumA,omitempty"`
	ReturnDetailAddendumB ReturnDetailAddendumB `json:"returnDetailAddendumB,omitempty"`
	ReturnDetailAddendumC ReturnDetailAddendumC `json:"returnDetailAddendumC,omitempty"`
	ReturnDetailAddendumD ReturnDetailAddendumD `json:"returnDetailAddendumD,omitempty"`
	ImageViewDetail       ImageViewDetail       `json:"imageViewDetail,omitempty"`
	ImageViewData         ImageViewData         `json:"imageViewData,omitempty"`
	ImageViewAnalysis     ImageViewAnalysis     `json:"imageViewAnalysis,omitempty"`
}

type ReturnDetailAddendumA added in v0.3.0 

type ReturnDetailAddendumA struct {
	// ReturnDetailAddendumA ID
	ID string `json:"ID,omitempty"`
	// RecordNumber is a number representing the order in which each ReturnDetailAddendumA was created. ReturnDetailAddendumA shall be in sequential order starting with 1.
	RecordNumber int32 `json:"recordNumber"`
	// ReturnLocationRoutingNumber is a valid routing and transit number indicating where returns, final return notifications, and preliminary return notifications are sent, usually the BOFD.
	ReturnLocationRoutingNumber string `json:"returnLocationRoutingNumber"`
	// BOFDEndorsementDate is the date of endorsement
	BOFDEndorsementDate time.Time `json:"bOFDEndorsementDate,omitempty"`
	// BOFDItemSequenceNumber is a number that identifies the item in the CheckDetailAddendumA.
	BOFDItemSequenceNumber string `json:"bOFDItemSequenceNumber,omitempty"`
	// BOFDAccountNumber is a number that identifies the depository account at the Bank of First Deposit.
	BOFDAccountNumber string `json:"bOFDAccountNumber,omitempty"`
	// BOFDBranchCode is a code that identifies the branch at the Bank of First Deposit.
	BOFDBranchCode string `json:"bOFDBranchCode,omitempty"`
	// PayeeName is the name of the payee from the check.
	PayeeName string `json:"payeeName,omitempty"`
	// TruncationIndicator identifies if the institution truncated the original check item.
	TruncationIndicator string `json:"truncationIndicator"`
	// BOFDConversionIndicator is a code that indicates the conversion within the processing institution between original paper check, image and IRD. The indicator is specific to the action of institution that created this record.  * `0` - Did not convert physical document * `1` - Original paper converted to IRD * `2` - Original paper converted to image * `3` - IRD converted to another IRD * `4` - IRD converted to image of IRD * `5` - Image converted to an IRD * `6` - Image converted to another image (e.g., transcoded) * `7` - Did not convert image (e.g., same as source) * `8` - Undetermined
	BOFDConversionIndicator string `json:"bOFDConversionIndicator,omitempty"`
	// BOFDCorrectionIndicator identifies whether and how the MICR line of this item was repaired by the creator of this CheckDetailAddendumA Record for fields other than Payor Bank Routing Number and Amount. * `0` - No Repair * `1` - Repaired (form of repair unknown) * `2` - Repaired without Operator intervention * `3` - Repaired with Operator intervention * `4` - Undetermined if repair has been done or not
	BOFDBOFDCorrectionIndicator string `json:"bOFDBOFDCorrectionIndicator,omitempty"`
	// UserField identifies a field used at the discretion of users of the standard.
	UserField string `json:"userField,omitempty"`
}

type ReturnDetailAddendumB added in v0.3.0 

type ReturnDetailAddendumB struct {
	// ReturnDetailAddendumB ID
	ID string `json:"ID,omitempty"`
	// PayorBankName is short name of the institution by or through which the item is payable.
	PayorBankName string `json:"payorBankName,omitempty"`
	// AuxiliaryOnUs identifies a code used on commercial checks at the discretion of the payor bank.
	AuxiliaryOnUs string `json:"auxiliaryOnUs,omitempty"`
	// PayorBankSequenceNumber is a number that identifies the item at the payor bank.
	PayorBankSequenceNumber string `json:"payorBankSequenceNumber,omitempty"`
	// PayorBankBusinessDate is the year, month, and day the payor bank processed the Return Record.
	PayorBankBusinessDate time.Time `json:"payorBankBusinessDate,omitempty"`
	// PayorAccountName is the account name from payor bank records.
	PayorAccountName string `json:"payorAccountName,omitempty"`
}

type ReturnDetailAddendumC added in v0.3.0 

type ReturnDetailAddendumC struct {
	// ReturnDetailAddendumC ID
	ID string `json:"ID,omitempty"`
	// ImageReferenceKeyIndicator identifies whether ImageReferenceKeyLength contains a variable value within the allowable range, or contains a defined value and the content is ItemReferenceKey.  * `0` - ImageReferenceKeyIndicator has Defined Value of 0034 and ImageReferenceKey contains the Image Reference Key. * `1`- ImageReferenceKeyIndicator contains a value other than Value 0034; or ImageReferenceKeyIndicator contains Value 0034, which is not a Defined Value, and the content of ImageReferenceKey has no special significance with regards to an Image Reference Key; or ImageReferenceKeyIndicator is 0000, meaning the ImageReferenceKey is not present.
	ImageReferenceKeyIndicator string `json:"imageReferenceKeyIndicator,omitempty"`
	// microfilmArchiveSequenceNumber is a number that identifies the item in the microfilm archive system; it may be different than the Check Detail.ECEInstitutionItemSequenceNumber and from the ImageReferenceKey.
	MicrofilmArchiveSequenceNumber string `json:"microfilmArchiveSequenceNumber,omitempty"`
	// MicrofilmArchiveSequenceNumber A number that identifies the item in the microfilm archive system; it may be different than the Check Detail.ECEInstitutionItemSequenceNumber and from the ImageReferenceKey.  * `0034` - ImageReferenceKey contains the ImageReferenceKey (ImageReferenceKeyIndicator is 0). * `0000` - ImageReferenceKey not present (ImageReferenceKeyIndicator is 1). * `0001` - 9999: May include Value 0034, and ImageReferenceKey has no special significance to Image Reference Key (ImageReferenceKey is 1).
	LengthImageReferenceKey string `json:"lengthImageReferenceKey,omitempty"`
	// ImageReferenceKey is used to find the image of the item in the image data system.  Size is variable based on lengthImageReferenceKey. The position within the file is variable based on the lengthImageReferenceKey.
	ImageReferenceKey string `json:"imageReferenceKey,omitempty"`
	// Descript describes the transaction.  The position within the file is variable based on the lengthImageReferenceKey.
	Descript string `json:"descript,omitempty"`
	// UserField identifies a field used at the discretion of users of the standard.
	UserField string `json:"userField,omitempty"`
}

type ReturnDetailAddendumD added in v0.3.0 

type ReturnDetailAddendumD struct {
	// ReturnDetailAddendumD ID
	ID string `json:"ID,omitempty"`
	// RecordNumber is a number representing the order in which each ReturnDetailAddendumD was created. ReturnDetailAddendumD shall be in sequential order starting with 1.  Maximum 99.
	RecordNumber string `json:"recordNumber,omitempty"`
	// EndorsingBankRoutingNumber is a valid routing and transit number indicating the bank that endorsed the check.
	EndorsingBankRoutingNumber string `json:"endorsingBankRoutingNumber"`
	// BOFDEndorsementBusinessDate is the date of endorsement
	BOFDEndorsementBusinessDate time.Time `json:"bOFDEndorsementBusinessDate"`
	// EndorsingItemSequenceNumber is a number that identifies the item at the endorsing bank.
	EndorsingBankSequenceNumber string `json:"endorsingBankSequenceNumber,omitempty"`
	// TruncationIndicator identifies if the institution truncated the original check item.
	TruncationIndicator string `json:"truncationIndicator"`
	// EndorsingBankConversionIndicator is a code that indicates the conversion within the processing institution between original paper check, image and IRD. The indicator is specific to the action institution identified in the EndorsingBankRoutingNumber.  * `0` - Did not convert physical document * `1` - Original paper converted to IRD * `2` - Original paper converted to image * `3` - IRD converted to another IRD * `4` - IRD converted to image of IRD * `5` - Image converted to an IRD * `6` - Image converted to another image (e.g., transcoded) * `7` - Did not convert image (e.g., same as source) * `8` - Undetermined
	EndorsingBankConversionIndicator string `json:"endorsingBankConversionIndicator,omitempty"`
	// EndorsingCorrectionIndicator identifies whether and how the MICR line of this item was repaired by the creator of this CheckDetailAddendumC Record for fields other than Payor Bank Routing Number and Amount.  * `0` - No Repair * `1` - Repaired (form of repair unknown) * `2` - Repaired without Operator intervention * `3` - Repaired with Operator intervention * `4` - Undetermined if repair has been done or not
	EndorsingBankCorrectionIndicator string `json:"endorsingBankCorrectionIndicator,omitempty"`
	// ReturnReason is a code that indicates the reason for non-payment.
	ReturnReason string `json:"returnReason,omitempty"`
	// UserField identifies a field used at the discretion of users of the standard.
	UserField string `json:"userField,omitempty"`
	// * `0` - Depository Bank (BOFD) - this value is used when the CheckDetailAddendumC Record reflects the Return * `Processing Bank in lieu of BOFD. * `1` - Other Collecting Bank * `2` - Other Returning Bank * `3` - Payor Bank
	EndorsingBankIdentifier string `json:"endorsingBankIdentifier,omitempty"`
}

type Returns added in v0.3.0 

type Returns struct {
	ReturnDetail ReturnDetail `json:"returnDetail,omitempty"`
}

type RoutingNumberSummary added in v0.3.0 

type RoutingNumberSummary struct {
	// RoutingNumberSummary ID
	ID string `json:"ID,omitempty"`
	// CashLetterRoutingNumber is a number that identifies a given payor bank within a cash letter containing one or more payor banks.
	CashLetterRoutingNumber string `json:"cashLetterRoutingNumber"`
	// RoutingNumberTotalAmount is the total amount for all Check Detail Records associated with the Payor bank routing number designated in the Routing Number within Cash Letter.
	RoutingNumberTotalAmount int32 `json:"routingNumberTotalAmount,omitempty"`
	// RoutingNumberItemCount is the the total number of all Check Detail Records associated with the payor bank routing number designated in the Routing Number within Cash Letter.
	RoutingNumberItemCount int32 `json:"routingNumberItemCount,omitempty"`
	// UserField identifies a field used at the discretion of users of the standard.
	UserField string `json:"userField,omitempty"`
}

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"`
	DeniedPersons []Dpl     `json:"deniedPersons,omitempty"`
}

Search results containing SDNs, alternate names and/or addreses

type SearchAccountsOpts 

type SearchAccountsOpts struct {
	Number        optional.String
	RoutingNumber optional.String
	Type_         optional.String
	CustomerID    optional.String
	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 SearchOpts added in v0.2.0 

type SearchOpts struct {
	XRequestID optional.String
	Q          optional.String
	Name       optional.String
	Address    optional.String
	City       optional.String
	State      optional.String
	Providence optional.String
	Zip        optional.String
	Country    optional.String
	AltName    optional.String
	Limit      optional.Int32
}

type SecondaryRemittanceDocument added in v0.3.0 

type SecondaryRemittanceDocument struct {
	// Document Type Code  * `AROI` - Accounts Receivable Open Item * `DISP` - Dispatch Advice * `FXDR` - Foreign Exchange Deal Reference * `PROP` - Proprietary Document Type PUOR Purchase Order * `RADM` - Remittance Advice Message * `RPIN` - Related Payment Instruction * `SCOR1` - Structured Communication Reference VCHR Voucher
	DocumentTypeCode string `json:"documentTypeCode,omitempty"`
	// proprietaryDocumentTypeCode
	ProprietaryDocumentTypeCode string `json:"proprietaryDocumentTypeCode,omitempty"`
	// documentIdentificationNumber
	DocumentIdentificationNumber string `json:"documentIdentificationNumber,omitempty"`
	// Issuer
	Issuer string `json:"issuer,omitempty"`
}

SecondaryRemittanceDocument

type SegmentFileOpts added in v0.3.0 

type SegmentFileOpts struct {
	XRequestID      optional.String
	XIdempotencyKey optional.String
}

type SenderDepositoryInstitution added in v0.3.0 

type SenderDepositoryInstitution struct {
	// SenderABANumber
	SenderABANumber string `json:"senderABANumber"`
	// SenderShortName
	SenderShortName string `json:"senderShortName"`
}

SenderDepositoryInstitution is the receiver depository institution

type SenderReference added in v0.3.0 

type SenderReference struct {
	// SenderReference
	SenderReference string `json:"senderReference,omitempty"`
}

SenderReference is sender reference

type SenderSupplied added in v0.3.0 

type SenderSupplied struct {
	// FormatVersion 30
	FormatVersion string `json:"formatVersion"`
	// UserRequestCorrelation
	UserRequestCorrelation string `json:"userRequestCorrelation"`
	// Identifies if test or production.  * `T` - Test * `P` - Production
	TestProductionCode string `json:"testProductionCode"`
	// MessageDuplicationCode  * ` ` - Original Message * `R` - Retrieval of an original message * `P` - Resend
	MessageDuplicationCode string `json:"messageDuplicationCode"`
}

SenderSupplied

type ServiceMessage added in v0.3.0 

type ServiceMessage struct {
	// LineOne
	LineOne string `json:"lineOne,omitempty"`
	// LineTwo
	LineTwo string `json:"lineTwo,omitempty"`
	// LineThree
	LineThree string `json:"lineThree,omitempty"`
	// LineFour
	LineFour string `json:"lineFour,omitempty"`
	// LineFive
	LineFive string `json:"lineFive,omitempty"`
	// LineSix
	LineSix string `json:"lineSix,omitempty"`
	// LineSeven
	LineSeven string `json:"lineSeven,omitempty"`
	// LineEight
	LineEight string `json:"lineEight,omitempty"`
	// LineNine
	LineNine string `json:"lineNine,omitempty"`
	// LineTen
	LineTen string `json:"lineTen,omitempty"`
	// LineEleven
	LineEleven string `json:"lineEleven,omitempty"`
	// LineTwelve
	LineTwelve string `json:"lineTwelve,omitempty"`
}

type TelDetail added in v0.2.0 

type TelDetail struct {
	// Phone number for optional communication during business hours required for TEL transfers
	PhoneNumber string `json:"phoneNumber,omitempty"`
	// Defines if the transfer is authorized for a single transaction or reoccurring
	PaymentType string `json:"paymentType,omitempty"`
}

type Transaction added in v0.2.0 

type Transaction struct {
	// Unique ID of a transaction
	ID        string            `json:"ID,omitempty"`
	Timestamp time.Time         `json:"timestamp,omitempty"`
	Lines     []TransactionLine `json:"lines,omitempty"`
}

type TransactionLine added in v0.2.0 

type TransactionLine struct {
	// Account ID
	AccountID string `json:"accountID,omitempty"`
	Purpose   string `json:"purpose,omitempty"`
	// Change in account balance (in USD cents)
	Amount float32 `json:"amount,omitempty"`
}

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"`
	CCDDetail CcdDetail `json:"CCDDetail,omitempty"`
	IATDetail IatDetail `json:"IATDetail,omitempty"`
	TELDetail TelDetail `json:"TELDetail,omitempty"`
	WEBDetail WebDetail `json:"WEBDetail,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 TypeSubType added in v0.3.0 

type TypeSubType struct {
	// TypeCode:  * `10` - Funds Transfer - A funds transfer in which the sender and/or receiver may be a bank or a third party (i.e., customer of a bank). * `15` - Foreign Transfer - A funds transfer to or from a foreign central bank or government or international organization with an account at the Federal Reserve Bank of New York. * `16` - Settlement Transfer - A funds transfer between Fedwire Funds Service participants.
	TypeCode string `json:"typeCode"`
	// SubTypeCode:  * `00` - Basic Funds Transfer - A basic value funds transfer. * `01` - Request for Reversal - A non-value request for reversal of a funds transfer originated on the current business day. * `02` - Reversal of Transfer - A value reversal of a funds transfer received on the current business day.  May be used in response to a subtype code ‘01’ Request for Reversal. * `07` - Request for Reversal of a Prior Day Transfer - A non-value request for a reversal of a funds transfer originated on a prior business day. * `08` - Reversal of a Prior Day Transfer - A value reversal of a funds transfer received on a prior business day.  May be used in response to a subtype code ‘07’ Request for Reversal of a Prior Day Transfer. * `31` - Request for Credit (Drawdown) - A non-value request for the receiver to send a funds transfer to a designated party. * `32` - Funds Transfer Honoring a Request for Credit (Drawdown) -  A value funds transfer honoring a subtype 31 request for credit. * `33` -Refusal to Honor a Request for Credit (Drawdown) - A non-value message indicating refusal to honor a subtype 31 request for credit. * `90` - Service Message - A non-value message used to communicate questions and information that is not covered by a specific subtype.
	SubTypeCode string `json:"subTypeCode"`
}

TypeSubtype is the type and sub type codes

type UnstructuredAddenda added in v0.3.0 

type UnstructuredAddenda struct {
	// AddendaLength  Addenda Length must be numeric, padded with leading zeros if less than four characters and must equal length of content in Addenda Information (e.g., if content of Addenda Information is 987 characters, Addenda Length must be 0987).
	AddendaLength string `json:"addendaLength,omitempty"`
	// Addenda
	Addenda string `json:"addenda,omitempty"`
}

type UpdateCompanyStatus added in v0.2.0 

type UpdateCompanyStatus struct {
	// manual override of company/SDN sanction status
	Status string `json:"status"`
	// Free form notes about manually changing the Company status
	Notes string `json:"notes,omitempty"`
}

Request body to update a company status.

type UpdateCustomerStatus 

type UpdateCustomerStatus struct {
	// manual override of customer/SDN sanction status
	Status string `json:"status"`
	// Free form notes about manually changing the Customer status
	Notes string `json:"notes,omitempty"`
}

Request body to update a customers status.

type UpdateDepositoryOpts 

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

type UpdateFileOpts 

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

type UpdateICLFileOpts added in v0.3.0 

type UpdateICLFileOpts struct {
	XRequestID      optional.String
	XIDempotencyKey optional.String
}

type UpdateOFACCompanyStatusOpts added in v0.2.0 

type UpdateOFACCompanyStatusOpts struct {
	XRequestID optional.String
}

type UpdateOFACCustomerStatusOpts added in v0.2.0 

type UpdateOFACCustomerStatusOpts struct {
	XRequestID 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 UpdateWireFileByIDOpts added in v0.3.0 

type UpdateWireFileByIDOpts struct {
	XRequestID      optional.String
	XIdempotencyKey optional.String
}

type UploadCustomerDocumentOpts added in v0.2.0 

type UploadCustomerDocumentOpts struct {
	XRequestID optional.String
	XUserID    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 ValidateICLFileOpts added in v0.3.0 

type ValidateICLFileOpts struct {
	XRequestID optional.String
}

type ValidateWireFileOpts added in v0.3.0 

type ValidateWireFileOpts 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 or company (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 WireFilesApiService added in v0.3.0 

type WireFilesApiService service

func (*WireFilesApiService) CreateWireFile added in v0.3.0 

func (a *WireFilesApiService) CreateWireFile(ctx context.Context, createFile2 CreateFile2, localVarOptionals *CreateWireFileOpts) (File2, *http.Response, error)

func (*WireFilesApiService) DeleteWireFileByID added in v0.3.0 

func (a *WireFilesApiService) DeleteWireFileByID(ctx context.Context, fileID string, localVarOptionals *DeleteWireFileByIDOpts) (*http.Response, error)

func (*WireFilesApiService) GetWireFileByID added in v0.3.0 

func (a *WireFilesApiService) GetWireFileByID(ctx context.Context, fileID string, localVarOptionals *GetWireFileByIDOpts) (File2, *http.Response, error)

func (*WireFilesApiService) GetWireFileContents added in v0.3.0 

func (a *WireFilesApiService) GetWireFileContents(ctx context.Context, fileID string, localVarOptionals *GetWireFileContentsOpts) (string, *http.Response, error)

func (*WireFilesApiService) GetWireFiles added in v0.3.0 

func (a *WireFilesApiService) GetWireFiles(ctx context.Context, localVarOptionals *GetWireFilesOpts) ([]File2, *http.Response, error)

func (*WireFilesApiService) UpdateWireFileByID added in v0.3.0 

func (a *WireFilesApiService) UpdateWireFileByID(ctx context.Context, fileID string, createFile2 CreateFile2, localVarOptionals *UpdateWireFileByIDOpts) (File2, *http.Response, error)

func (*WireFilesApiService) ValidateWireFile added in v0.3.0 

func (a *WireFilesApiService) ValidateWireFile(ctx context.Context, fileID string, localVarOptionals *ValidateWireFileOpts) (File2, *http.Response, error)

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.