client

package
v0.5.2 Latest Latest
Warning

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

 Go to latest Published: Feb 22, 2021 License: Apache-2.0 Imports: 23 Imported by: 5

README

Go API client for client

Customers focuses on solving authentic identification of humans who are legally able to hold and transfer currency within the US. Primarily this project solves Know Your Customer (KYC), Customer Identification Program (CIP), Office of Foreign Asset Control (OFAC) checks and verification workflows to comply with United States federal law and ensure authentic transfers. Customers has an objective to be a service for detailed due diligence on individuals and companies for Financial Institutions and services in a modernized and extensible way.

Customer phone numbers and addresses are stored and partially used in KYC/OFAC validation. Arbitrary key/value pairs can be stored for a Customer. Documents and Disclaimers, and their acknowledgment are also stored under a Customer as they're accepted. Bank Accounts, which can be validated with micro-deposits currently, are stored under each Customer.

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

Documentation for API Endpoints

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

Class Method HTTP request Description
AccountValidationApi CompleteAccountValidation Put /customers/{customerID}/accounts/{accountID}/validations Complete Account Validation
AccountValidationApi GetAccountValidation Get /customers/{customerID}/accounts/{accountID}/validations/{validationID} Get Account Validation
AccountValidationApi InitAccountValidation Post /customers/{customerID}/accounts/{accountID}/validations Initiate Account Validation
AccountsApi CreateCustomerAccount Post /customers/{customerID}/accounts Create Customer Account
AccountsApi DecryptAccountNumber Post /customers/{customerID}/accounts/{accountID}/decrypt Decrypt Account Number
AccountsApi DeleteCustomerAccount Delete /customers/{customerID}/accounts/{accountID} Delete Customer Account
AccountsApi GetCustomerAccountByID Get /customers/{customerID}/accounts/{accountID} Get Customer Account
AccountsApi GetCustomerAccounts Get /customers/{customerID}/accounts Get Customer Accounts
AccountsApi GetLatestAccountOFACSearch Get /customers/{customerID}/accounts/{accountID}/ofac Latest Account OFAC Search
AccountsApi RefreshAccountOFACSearch Put /customers/{customerID}/accounts/{accountID}/refresh/ofac Refresh Account OFAC Search
AccountsApi UpdateAccountStatus Put /customers/{customerID}/accounts/{accountID}/status Update Account Status
ConfigurationApi GetOrganizationConfiguration Get /configuration/customers Get Organization Configuration
ConfigurationApi GetOrganizationLogo Get /configuration/logo Get Organization Logo
ConfigurationApi UpdateOrganizationConfiguration Put /configuration/customers Update Organization Configuration
ConfigurationApi UploadOrganizationLogo Put /configuration/logo Update Organization Logo
CustomersApi AddCustomerAddress Post /customers/{customerID}/address Add Customer Address
CustomersApi CreateCustomer Post /customers Create Customer
CustomersApi DeleteCustomer Delete /customers/{customerID} Delete Customer
CustomersApi DeleteCustomerAddress Delete /customers/{customerID}/addresses/{addressID} Delete Customer Address
CustomersApi GetCustomer Get /customers/{customerID} Get Customer
CustomersApi GetLatestOFACSearch Get /customers/{customerID}/ofac Latest Customer OFAC search
CustomersApi Ping Get /ping Ping Customers Service
CustomersApi RefreshOFACSearch Put /customers/{customerID}/refresh/ofac Refresh Customer OFAC search
CustomersApi ReplaceCustomerMetadata Put /customers/{customerID}/metadata Update Customer Metadata
CustomersApi SearchCustomers Get /customers Search Customers
CustomersApi UpdateCustomer Put /customers/{customerID} Update Customer
CustomersApi UpdateCustomerAddress Put /customers/{customerID}/addresses/{addressID} Update Customer Address
CustomersApi UpdateCustomerStatus Put /customers/{customerID}/status Update Customer Status
DisclaimersApi AcceptDisclaimer Post /customers/{customerID}/disclaimers/{disclaimerID} Accept Customer Disclaimer
DisclaimersApi GetCustomerDisclaimers Get /customers/{customerID}/disclaimers Get Customer Disclaimers
DocumentsApi DeleteCustomerDocument Delete /customers/{customerID}/documents/{documentID} Delete Customer Document
DocumentsApi GetCustomerDocumentContents Get /customers/{customerID}/documents/{documentID} Get Customer Document
DocumentsApi GetCustomerDocuments Get /customers/{customerID}/documents Get Customer Documents
DocumentsApi UploadCustomerDocument Post /customers/{customerID}/documents Upload Customer Document
ReportsApi GetReportOfCustomerAccounts Get /reports/accounts Create Report of Accounts

Documentation For Models

Documentation For Authorization

Endpoints do not require authorization.

Author

Documentation

Index

Constants

This section is empty.

Variables

View Source 
var (
	// ContextOAuth2 takes an oauth2.TokenSource as authentication for the request.
	ContextOAuth2 = contextKey("token")

	// ContextBasicAuth takes BasicAuth as authentication for the request.
	ContextBasicAuth = contextKey("basic")

	// ContextAccessToken takes a string oauth2 access token as authentication for the request.
	ContextAccessToken = contextKey("accesstoken")

	// ContextAPIKey takes an APIKey as authentication for the request
	ContextAPIKey = contextKey("apikey")
)

Functions

func CacheExpires 

func CacheExpires(r *http.Response) time.Time

CacheExpires helper function to determine remaining time before repeating a request.

Types

type APIClient 

type APIClient struct {
	AccountValidationApi *AccountValidationApiService

	AccountsApi *AccountsApiService

	ConfigurationApi *ConfigurationApiService

	CustomersApi *CustomersApiService

	DisclaimersApi *DisclaimersApiService

	DocumentsApi *DocumentsApiService

	ReportsApi *ReportsApiService
	// contains filtered or unexported fields
}

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

ChangeBasePath changes base path to allow switching to mocks

func (*APIClient) GetConfig 

func (c *APIClient) GetConfig() *Configuration

Allow modification of underlying config for alternate implementations and testing Caution: modifying the configuration while live can cause data races and potentially unwanted behavior

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

APIResponse stores the API response returned by the server.

func NewAPIResponse 

func NewAPIResponse(r *http.Response) *APIResponse

NewAPIResponse returns a new APIResonse object.

func NewAPIResponseWithError 

func NewAPIResponseWithError(errorMessage string) *APIResponse

NewAPIResponseWithError returns a new APIResponse object with the provided error message.

type AcceptDisclaimerOpts 

type AcceptDisclaimerOpts struct {
	XRequestID    optional.String
	XOrganization optional.String
}

AcceptDisclaimerOpts Optional parameters for the method 'AcceptDisclaimer'

type Account 

type Account struct {
	// A unique identifier for this account
	AccountID string `json:"accountID"`
	// The unique identifier for the customer who owns the account
	CustomerID string `json:"customerID"`
	// Legal holder name on the account
	HolderName string `json:"holderName"`
	// The masked account number for the bank account
	MaskedAccountNumber string `json:"maskedAccountNumber"`
	// The ABA routing transit number for the bank account.
	RoutingNumber string             `json:"routingNumber"`
	Status        AccountStatus      `json:"status"`
	Type          AccountType        `json:"type"`
	Institution   InstitutionDetails `json:"institution,omitempty"`
}

Account struct for Account

type AccountStatus 

type AccountStatus string

AccountStatus Enumeration if this account has been validated through micro-deposits or another available strategy. 

const (
	ACCOUNTSTATUS_NONE      AccountStatus = "none"
	ACCOUNTSTATUS_VALIDATED AccountStatus = "validated"
)

List of AccountStatus

type AccountType 

type AccountType string

AccountType Defines the account as *checking* or *savings* 

const (
	ACCOUNTTYPE_CHECKING AccountType = "Checking"
	ACCOUNTTYPE_SAVINGS  AccountType = "Savings"
)

List of AccountType

type AccountValidationApiService 

type AccountValidationApiService service

AccountValidationApiService AccountValidationApi service

func (*AccountValidationApiService) CompleteAccountValidation 

func (a *AccountValidationApiService) CompleteAccountValidation(ctx _context.Context, customerID string, accountID string, completeAccountValidationRequest CompleteAccountValidationRequest, localVarOptionals *CompleteAccountValidationOpts) (CompleteAccountValidationResponse, *_nethttp.Response, error)

CompleteAccountValidation Complete Account Validation Complete account validation with specified strategy and vendor.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param customerID customerID of the Customer the accountID belongs to
  • @param accountID accountID of the Account to validate
  • @param completeAccountValidationRequest
  • @param optional nil or *CompleteAccountValidationOpts - Optional Parameters:
  • @param "XRequestID" (optional.String) - Optional requestID allows application developer to trace requests through the systems logs
  • @param "XOrganization" (optional.String) - Value used to separate and identify models

@return CompleteAccountValidationResponse

func (*AccountValidationApiService) GetAccountValidation 

func (a *AccountValidationApiService) GetAccountValidation(ctx _context.Context, customerID string, accountID string, validationID string, localVarOptionals *GetAccountValidationOpts) (AccountValidationResponse, *_nethttp.Response, error)

GetAccountValidation Get Account Validation Get information about account validation strategy, status, etc.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param customerID customerID of the Customer the accountID belongs to
  • @param accountID accountID of the Account to validate
  • @param validationID ID of the Validation
  • @param optional nil or *GetAccountValidationOpts - Optional Parameters:
  • @param "XRequestID" (optional.String) - Optional requestID allows application developer to trace requests through the systems logs
  • @param "XOrganization" (optional.String) - Value used to separate and identify models

@return AccountValidationResponse

func (*AccountValidationApiService) InitAccountValidation 

func (a *AccountValidationApiService) InitAccountValidation(ctx _context.Context, customerID string, accountID string, initAccountValidationRequest InitAccountValidationRequest, localVarOptionals *InitAccountValidationOpts) (InitAccountValidationResponse, *_nethttp.Response, error)

InitAccountValidation Initiate Account Validation Initiate account validation with specified strategy and vendor.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param customerID customerID of the Customer the accountID belongs to
  • @param accountID accountID of the Account to validate
  • @param initAccountValidationRequest
  • @param optional nil or *InitAccountValidationOpts - Optional Parameters:
  • @param "XRequestID" (optional.String) - Optional requestID allows application developer to trace requests through the systems logs
  • @param "XOrganization" (optional.String) - Value used to separate and identify models

@return InitAccountValidationResponse

type AccountValidationResponse 

type AccountValidationResponse struct {
	// A unique identifier for the validation
	ValidationID string `json:"validationID,omitempty"`
	// Validation strategy
	Strategy string `json:"strategy,omitempty"`
	// Validation vendor
	Vendor string `json:"vendor,omitempty"`
	// Validation status
	Status    string    `json:"status,omitempty"`
	CreatedAt time.Time `json:"createdAt,omitempty"`
	UpdatedAt time.Time `json:"updatedAt,omitempty"`
}

AccountValidationResponse struct for AccountValidationResponse

type AccountsApiService 

type AccountsApiService service

AccountsApiService AccountsApi service

func (*AccountsApiService) CreateCustomerAccount 

func (a *AccountsApiService) CreateCustomerAccount(ctx _context.Context, customerID string, createAccount CreateAccount, localVarOptionals *CreateCustomerAccountOpts) (Account, *_nethttp.Response, error)

CreateCustomerAccount Create Customer Account Create an account for the given customer

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param customerID customerID of the Customer to add an Account onto
  • @param createAccount
  • @param optional nil or *CreateCustomerAccountOpts - Optional Parameters:
  • @param "XRequestID" (optional.String) - Optional requestID allows application developer to trace requests through the systems logs
  • @param "XOrganization" (optional.String) - Value used to separate and identify models

@return Account

func (*AccountsApiService) DecryptAccountNumber 

func (a *AccountsApiService) DecryptAccountNumber(ctx _context.Context, customerID string, accountID string, localVarOptionals *DecryptAccountNumberOpts) (TransitAccountNumber, *_nethttp.Response, error)

DecryptAccountNumber Decrypt Account Number Return the account number encrypted with a shared secret for application requests. This encryption key is different from the key used for persistence.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param customerID customerID of the Customer the accountID belongs to
  • @param accountID accountID of the Account to get decrypted account number
  • @param optional nil or *DecryptAccountNumberOpts - Optional Parameters:
  • @param "XRequestID" (optional.String) - Optional requestID allows application developer to trace requests through the systems logs
  • @param "XOrganization" (optional.String) - Value used to separate and identify models

@return TransitAccountNumber

func (*AccountsApiService) DeleteCustomerAccount 

func (a *AccountsApiService) DeleteCustomerAccount(ctx _context.Context, customerID string, accountID string, localVarOptionals *DeleteCustomerAccountOpts) (*_nethttp.Response, error)

DeleteCustomerAccount Delete Customer Account Remove an account from the given Customer

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param customerID customerID of the Customer to remove an Account
  • @param accountID accountID of the Account
  • @param optional nil or *DeleteCustomerAccountOpts - Optional Parameters:
  • @param "XRequestID" (optional.String) - Optional requestID allows application developer to trace requests through the systems logs
  • @param "XOrganization" (optional.String) - Value used to separate and identify models

func (*AccountsApiService) GetCustomerAccountByID 

func (a *AccountsApiService) GetCustomerAccountByID(ctx _context.Context, customerID string, accountID string, localVarOptionals *GetCustomerAccountByIDOpts) (Account, *_nethttp.Response, error)

GetCustomerAccountByID Get Customer Account Retrieve an account by ID for the given customer.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param customerID customerID of the Customer to get an Account for
  • @param accountID accountID of the Account
  • @param optional nil or *GetCustomerAccountByIDOpts - Optional Parameters:
  • @param "XRequestID" (optional.String) - Optional requestID allows application developer to trace requests through the systems logs
  • @param "XOrganization" (optional.String) - Value used to separate and identify models

@return Account

func (*AccountsApiService) GetCustomerAccounts 

func (a *AccountsApiService) GetCustomerAccounts(ctx _context.Context, customerID string, localVarOptionals *GetCustomerAccountsOpts) ([]Account, *_nethttp.Response, error)

GetCustomerAccounts Get Customer Accounts Retrieve all accounts for the given customer.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param customerID customerID of the Customer to get Accounts for
  • @param optional nil or *GetCustomerAccountsOpts - Optional Parameters:
  • @param "XRequestID" (optional.String) - Optional requestID allows application developer to trace requests through the systems logs
  • @param "XOrganization" (optional.String) - Value used to separate and identify models

@return []Account

func (*AccountsApiService) GetLatestAccountOFACSearch 

func (a *AccountsApiService) GetLatestAccountOFACSearch(ctx _context.Context, customerID string, accountID string, localVarOptionals *GetLatestAccountOFACSearchOpts) (OfacSearch, *_nethttp.Response, error)

GetLatestAccountOFACSearch Latest Account OFAC Search Get the latest OFAC search for an Account

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param customerID customerID of the Customer
  • @param accountID accountID of the Account to get latest OFAC search
  • @param optional nil or *GetLatestAccountOFACSearchOpts - Optional Parameters:
  • @param "XRequestID" (optional.String) - Optional requestID allows application developer to trace requests through the systems logs
  • @param "XOrganization" (optional.String) - Value used to separate and identify models

@return OfacSearch

func (*AccountsApiService) RefreshAccountOFACSearch 

func (a *AccountsApiService) RefreshAccountOFACSearch(ctx _context.Context, customerID string, accountID string, localVarOptionals *RefreshAccountOFACSearchOpts) (OfacSearch, *_nethttp.Response, error)

RefreshAccountOFACSearch Refresh Account OFAC Search Refresh OFAC search for a given Account

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param customerID customerID of the Customer to refresh OFAC search
  • @param accountID accountID of the Account to get latest OFAC search
  • @param optional nil or *RefreshAccountOFACSearchOpts - Optional Parameters:
  • @param "XRequestID" (optional.String) - Optional requestID allows application developer to trace requests through the systems logs
  • @param "XOrganization" (optional.String) - Value used to separate and identify models

@return OfacSearch

func (*AccountsApiService) UpdateAccountStatus 

func (a *AccountsApiService) UpdateAccountStatus(ctx _context.Context, customerID string, accountID string, updateAccountStatus UpdateAccountStatus) (Account, *_nethttp.Response, error)

UpdateAccountStatus Update Account Status Update the status for the specified accountID

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param customerID Customer ID
  • @param accountID accountID of the Account to validate
  • @param updateAccountStatus

@return Account

type AddCustomerAddressOpts 

type AddCustomerAddressOpts struct {
	XRequestID    optional.String
	XOrganization optional.String
}

AddCustomerAddressOpts Optional parameters for the method 'AddCustomerAddress'

type AddressType 

type AddressType string

AddressType address type 

const (
	ADDRESSTYPE_PRIMARY   AddressType = "primary"
	ADDRESSTYPE_SECONDARY AddressType = "secondary"
)

List of AddressType

type Amount 

type Amount struct {
	// A 3-letter ISO 4217 currency code
	Currency string `json:"currency"`
	// Quantity in the smallest unit of the specified currency. In USD this is cents, so $12.04 is 1204 and $0.99 would be 99.
	Value int32 `json:"value"`
}

Amount struct for Amount

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 CompleteAccountValidationOpts 

type CompleteAccountValidationOpts struct {
	XRequestID    optional.String
	XOrganization optional.String
}

CompleteAccountValidationOpts Optional parameters for the method 'CompleteAccountValidation'

type CompleteAccountValidationRequest 

type CompleteAccountValidationRequest struct {
	// key/value map of vendor specific params
	VendorRequest map[string]interface{} `json:"vendor_request"`
}

CompleteAccountValidationRequest struct for CompleteAccountValidationRequest

type CompleteAccountValidationResponse 

type CompleteAccountValidationResponse struct {
	// A unique identifier for the validation
	ValidationID string `json:"validationID,omitempty"`
	// Validation strategy
	Strategy string `json:"strategy,omitempty"`
	// Validation vendor
	Vendor string `json:"vendor,omitempty"`
	// Validation status
	Status    string    `json:"status,omitempty"`
	CreatedAt time.Time `json:"createdAt,omitempty"`
	UpdatedAt time.Time `json:"updatedAt,omitempty"`
	// key/value map of vendor specific params
	VendorResponse map[string]interface{} `json:"vendor_response,omitempty"`
}

CompleteAccountValidationResponse struct for CompleteAccountValidationResponse

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"`
	Debug         bool              `json:"debug,omitempty"`
	Servers       []ServerConfiguration
	HTTPClient    *http.Client
}

Configuration stores the configuration of the API client

func NewConfiguration 

func NewConfiguration() *Configuration

NewConfiguration returns a new Configuration object

func (*Configuration) AddDefaultHeader 

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

AddDefaultHeader adds a new HTTP header to the default header in the request

func (*Configuration) ServerUrl 

func (c *Configuration) ServerUrl(index int, variables map[string]string) (string, error)

ServerUrl returns URL based on server settings

type ConfigurationApiService 

type ConfigurationApiService service

ConfigurationApiService ConfigurationApi service

func (*ConfigurationApiService) GetOrganizationConfiguration 

func (a *ConfigurationApiService) GetOrganizationConfiguration(ctx _context.Context, localVarOptionals *GetOrganizationConfigurationOpts) (OrganizationConfiguration, *_nethttp.Response, error)

GetOrganizationConfiguration Get Organization Configuration Retrieve current configuration for the provided organization.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param optional nil or *GetOrganizationConfigurationOpts - Optional Parameters:
  • @param "XOrganization" (optional.String) - Value used to separate and identify models

@return OrganizationConfiguration 

func (a *ConfigurationApiService) GetOrganizationLogo(ctx _context.Context, xOrganization string) (*os.File, *_nethttp.Response, error)

GetOrganizationLogo Get Organization Logo Retrieve the organization's logo

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param xOrganization Value used to separate and identify models

@return *os.File

func (*ConfigurationApiService) UpdateOrganizationConfiguration 

func (a *ConfigurationApiService) UpdateOrganizationConfiguration(ctx _context.Context, organizationConfiguration OrganizationConfiguration, localVarOptionals *UpdateOrganizationConfigurationOpts) (OrganizationConfiguration, *_nethttp.Response, error)

UpdateOrganizationConfiguration Update Organization Configuration Update the configuration for the provided organization.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param organizationConfiguration
  • @param optional nil or *UpdateOrganizationConfigurationOpts - Optional Parameters:
  • @param "XOrganization" (optional.String) - Value used to separate and identify models

@return OrganizationConfiguration 

func (a *ConfigurationApiService) UploadOrganizationLogo(ctx _context.Context, xOrganization string, file *os.File) (OrganizationConfiguration, *_nethttp.Response, error)

UploadOrganizationLogo Update Organization Logo Upload an organization's logo, or update it if it already exists

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param xOrganization Value used to separate and identify models
  • @param file Logo image file to be uploaded

@return OrganizationConfiguration

type CreateAccount 

type CreateAccount struct {
	// Legal holder name on the account
	HolderName string `json:"holderName"`
	// The account number for the bank account
	AccountNumber string `json:"accountNumber"`
	// The ABA routing transit number for the bank account.
	RoutingNumber string      `json:"routingNumber"`
	Type          AccountType `json:"type"`
}

CreateAccount struct for CreateAccount

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"`
	Type   CustomerType `json:"type"`
	// Legal date of birth
	BirthDate string `json:"birthDate,omitempty"`
	// 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 []CreateCustomerAddress `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"`
}

CreateCustomer struct for CreateCustomer

type CreateCustomerAccountOpts 

type CreateCustomerAccountOpts struct {
	XRequestID    optional.String
	XOrganization optional.String
}

CreateCustomerAccountOpts Optional parameters for the method 'CreateCustomerAccount'

type CreateCustomerAddress 

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

CreateCustomerAddress struct for CreateCustomerAddress

type CreateCustomerOpts 

type CreateCustomerOpts struct {
	XRequestID    optional.String
	XOrganization optional.String
}

CreateCustomerOpts Optional parameters for the method 'CreateCustomer'

type CreatePhone 

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

CreatePhone struct for CreatePhone

type Customer 

type Customer struct {
	// The unique identifier for the customer who owns the account
	CustomerID string `json:"customerID"`
	// 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"`
	Type   CustomerType `json:"type"`
	// Legal date of birth
	BirthDate string         `json:"birthDate,omitempty"`
	Status    CustomerStatus `json:"status"`
	// Primary email address of customer name@domain.com
	Email     string            `json:"email"`
	Phones    []Phone           `json:"phones,omitempty"`
	Addresses []CustomerAddress `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"`
	// Last time the object was modified
	LastModified time.Time `json:"lastModified"`
}

Customer struct for Customer

type CustomerAddress 

type CustomerAddress struct {
	// Unique identifier for this Address
	AddressID string      `json:"addressID"`
	Type      AddressType `json:"type"`
	// First line of the address
	Address1 string `json:"address1"`
	// Second line of the address
	Address2 string `json:"address2,omitempty"`
	City     string `json:"city"`
	// two character code of a US state
	State      string `json:"state"`
	PostalCode string `json:"postalCode"`
	Country    string `json:"country"`
	// Address has been validated for customer
	Validated bool `json:"validated,omitempty"`
}

CustomerAddress struct for CustomerAddress

type CustomerMetadata 

type CustomerMetadata struct {
	// 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"`
}

CustomerMetadata struct for CustomerMetadata

type CustomerStatus 

type CustomerStatus string

CustomerStatus State of the customer 

const (
	CUSTOMERSTATUS_DECEASED     CustomerStatus = "Deceased"
	CUSTOMERSTATUS_REJECTED     CustomerStatus = "Rejected"
	CUSTOMERSTATUS_UNKNOWN      CustomerStatus = "Unknown"
	CUSTOMERSTATUS_RECEIVE_ONLY CustomerStatus = "ReceiveOnly"
	CUSTOMERSTATUS_VERIFIED     CustomerStatus = "Verified"
	CUSTOMERSTATUS_FROZEN       CustomerStatus = "Frozen"
)

List of CustomerStatus

type CustomerType 

type CustomerType string

CustomerType Note if this Customer represents an individual or business 

const (
	CUSTOMERTYPE_INDIVIDUAL CustomerType = "individual"
	CUSTOMERTYPE_BUSINESS   CustomerType = "business"
)

List of CustomerType

type CustomersApiService 

type CustomersApiService service

CustomersApiService CustomersApi service

func (*CustomersApiService) AddCustomerAddress 

func (a *CustomersApiService) AddCustomerAddress(ctx _context.Context, customerID string, createCustomerAddress CreateCustomerAddress, localVarOptionals *AddCustomerAddressOpts) (Customer, *_nethttp.Response, error)

AddCustomerAddress Add Customer Address Add an Address onto an existing Customer record

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param customerID customerID of the Customer to add the address onto
  • @param createCustomerAddress
  • @param optional nil or *AddCustomerAddressOpts - Optional Parameters:
  • @param "XRequestID" (optional.String) - Optional requestID allows application developer to trace requests through the systems logs
  • @param "XOrganization" (optional.String) - Value used to separate and identify models

@return Customer

func (*CustomersApiService) CreateCustomer 

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

CreateCustomer Create Customer Create a Customer object from the given details of a human or business

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param createCustomer
  • @param optional nil or *CreateCustomerOpts - Optional Parameters:
  • @param "XRequestID" (optional.String) - Optional requestID allows application developer to trace requests through the systems logs
  • @param "XOrganization" (optional.String) - Value used to separate and identify models

@return Customer

func (*CustomersApiService) DeleteCustomer 

func (a *CustomersApiService) DeleteCustomer(ctx _context.Context, customerID string, localVarOptionals *DeleteCustomerOpts) (*_nethttp.Response, error)

DeleteCustomer Delete Customer Remove a given Customer

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param customerID customerID of the Customer to be deleted
  • @param optional nil or *DeleteCustomerOpts - Optional Parameters:
  • @param "XRequestID" (optional.String) - Optional requestID allows application developer to trace requests through the systems logs
  • @param "XOrganization" (optional.String) - Value used to separate and identify models

func (*CustomersApiService) DeleteCustomerAddress 

func (a *CustomersApiService) DeleteCustomerAddress(ctx _context.Context, customerID string, addressID string) (*_nethttp.Response, error)

DeleteCustomerAddress Delete Customer Address Deletes a customer's address

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param customerID Customer ID
  • @param addressID Address ID

func (*CustomersApiService) GetCustomer 

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

GetCustomer Get Customer Retrieve the Customer object and metadata for the customerID.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param customerID customerID that identifies this Customer
  • @param optional nil or *GetCustomerOpts - Optional Parameters:
  • @param "XRequestID" (optional.String) - Optional requestID allows application developer to trace requests through the systems logs
  • @param "XOrganization" (optional.String) - Value used to separate and identify models

@return Customer

func (*CustomersApiService) GetLatestOFACSearch 

func (a *CustomersApiService) GetLatestOFACSearch(ctx _context.Context, customerID string, localVarOptionals *GetLatestOFACSearchOpts) (OfacSearch, *_nethttp.Response, error)

GetLatestOFACSearch Latest Customer OFAC search Get the latest OFAC search for a Customer

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param customerID customerID of the Customer to get latest OFAC search
  • @param optional nil or *GetLatestOFACSearchOpts - Optional Parameters:
  • @param "XRequestID" (optional.String) - Optional requestID allows application developer to trace requests through the systems logs
  • @param "XOrganization" (optional.String) - Value used to separate and identify models

@return OfacSearch

func (*CustomersApiService) Ping 

func (a *CustomersApiService) Ping(ctx _context.Context) (*_nethttp.Response, error)

Ping Ping Customers Service Check the Customers service to check if running

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().

func (*CustomersApiService) RefreshOFACSearch 

func (a *CustomersApiService) RefreshOFACSearch(ctx _context.Context, customerID string, localVarOptionals *RefreshOFACSearchOpts) (OfacSearch, *_nethttp.Response, error)

RefreshOFACSearch Refresh Customer OFAC search Refresh OFAC search for a given Customer

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param customerID customerID of the Customer to refresh OFAC search
  • @param optional nil or *RefreshOFACSearchOpts - Optional Parameters:
  • @param "XRequestID" (optional.String) - Optional requestID allows application developer to trace requests through the systems logs
  • @param "XOrganization" (optional.String) - Value used to separate and identify models

@return OfacSearch

func (*CustomersApiService) ReplaceCustomerMetadata 

func (a *CustomersApiService) ReplaceCustomerMetadata(ctx _context.Context, customerID string, customerMetadata CustomerMetadata, localVarOptionals *ReplaceCustomerMetadataOpts) (Customer, *_nethttp.Response, error)

ReplaceCustomerMetadata Update Customer Metadata Replace the metadata object for a customer. Metadata is a map of unique keys associated to values to act as foreign key relationships or arbitrary data associated to a Customer.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param customerID customerID of the Customer to add the metadata onto
  • @param customerMetadata
  • @param optional nil or *ReplaceCustomerMetadataOpts - Optional Parameters:
  • @param "XRequestID" (optional.String) - Optional requestID allows application developer to trace requests through the systems logs
  • @param "XOrganization" (optional.String) - Value used to separate and identify models

@return Customer

func (*CustomersApiService) SearchCustomers 

func (a *CustomersApiService) SearchCustomers(ctx _context.Context, localVarOptionals *SearchCustomersOpts) ([]Customer, *_nethttp.Response, error)

SearchCustomers Search Customers Search for customers using different filter parameters

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param optional nil or *SearchCustomersOpts - Optional Parameters:
  • @param "Query" (optional.String) - Optional parameter for searching by customer name
  • @param "Email" (optional.String) - Optional parameter for searching by customer email
  • @param "Status" (optional.String) - Optional parameter for searching by customer status
  • @param "Type_" (optional.String) - Optional parameter for searching by customer type
  • @param "Skip" (optional.String) - Optional parameter for searching for customers by skipping over an initial group
  • @param "Count" (optional.String) - Optional parameter for searching by specifying the amount to return
  • @param "CustomerIDs" (optional.String) - Optional parameter for searching by customers' IDs

@return []Customer

func (*CustomersApiService) UpdateCustomer 

func (a *CustomersApiService) UpdateCustomer(ctx _context.Context, customerID string, createCustomer CreateCustomer, localVarOptionals *UpdateCustomerOpts) (Customer, *_nethttp.Response, error)

UpdateCustomer Update Customer Update a Customer object

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param customerID customerID that identifies this Customer
  • @param createCustomer
  • @param optional nil or *UpdateCustomerOpts - Optional Parameters:
  • @param "XRequestID" (optional.String) - Optional requestID allows application developer to trace requests through the systems logs
  • @param "XOrganization" (optional.String) - Value used to separate and identify models

@return Customer

func (*CustomersApiService) UpdateCustomerAddress 

func (a *CustomersApiService) UpdateCustomerAddress(ctx _context.Context, customerID string, addressID string, updateCustomerAddress UpdateCustomerAddress) (*_nethttp.Response, error)

UpdateCustomerAddress Update Customer Address Updates the specified customer address

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param customerID Customer ID
  • @param addressID Address ID
  • @param updateCustomerAddress

func (*CustomersApiService) UpdateCustomerStatus 

func (a *CustomersApiService) UpdateCustomerStatus(ctx _context.Context, customerID string, updateCustomerStatus UpdateCustomerStatus, localVarOptionals *UpdateCustomerStatusOpts) (Customer, *_nethttp.Response, error)

UpdateCustomerStatus Update Customer Status Update the status for a customer, which can only be updated by authenticated users with permissions.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param customerID customerID of the Customer to update the CustomerStatus
  • @param updateCustomerStatus
  • @param optional nil or *UpdateCustomerStatusOpts - Optional Parameters:
  • @param "XRequestID" (optional.String) - Optional requestID allows application developer to trace requests through the systems logs
  • @param "XOrganization" (optional.String) - Value used to separate and identify models

@return Customer

type DecryptAccountNumberOpts 

type DecryptAccountNumberOpts struct {
	XRequestID    optional.String
	XOrganization optional.String
}

DecryptAccountNumberOpts Optional parameters for the method 'DecryptAccountNumber'

type DeleteCustomerAccountOpts 

type DeleteCustomerAccountOpts struct {
	XRequestID    optional.String
	XOrganization optional.String
}

DeleteCustomerAccountOpts Optional parameters for the method 'DeleteCustomerAccount'

type DeleteCustomerDocumentOpts 

type DeleteCustomerDocumentOpts struct {
	XRequestID optional.String
}

DeleteCustomerDocumentOpts Optional parameters for the method 'DeleteCustomerDocument'

type DeleteCustomerOpts 

type DeleteCustomerOpts struct {
	XRequestID    optional.String
	XOrganization optional.String
}

DeleteCustomerOpts Optional parameters for the method 'DeleteCustomer'

type Disclaimer 

type Disclaimer struct {
	// The unique identifier for this Disclaimer
	DisclaimerID string `json:"disclaimerID"`
	// Text that user must accept
	Text string `json:"text"`
	// Optional documentID which references a Document included in the disclaimer
	DocumentID string `json:"documentID,omitempty"`
	// Timestamp if disclaimer has been accepted, a timestamp before the year 2000 indicates no acceptance.
	AcceptedAt time.Time `json:"acceptedAt,omitempty"`
}

Disclaimer struct for Disclaimer

type DisclaimersApiService 

type DisclaimersApiService service

DisclaimersApiService DisclaimersApi service

func (*DisclaimersApiService) AcceptDisclaimer 

func (a *DisclaimersApiService) AcceptDisclaimer(ctx _context.Context, customerID string, disclaimerID string, localVarOptionals *AcceptDisclaimerOpts) (Disclaimer, *_nethttp.Response, error)

AcceptDisclaimer Accept Customer Disclaimer Accept a disclaimer for the given customer which could include a document also

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param customerID customerID of the Customer to accept a disclaimer
  • @param disclaimerID disclaimerID of the Disclaimer to accept
  • @param optional nil or *AcceptDisclaimerOpts - Optional Parameters:
  • @param "XRequestID" (optional.String) - Optional requestID allows application developer to trace requests through the systems logs
  • @param "XOrganization" (optional.String) - Value used to separate and identify models

@return Disclaimer

func (*DisclaimersApiService) GetCustomerDisclaimers 

func (a *DisclaimersApiService) GetCustomerDisclaimers(ctx _context.Context, customerID string, localVarOptionals *GetCustomerDisclaimersOpts) ([]Disclaimer, *_nethttp.Response, error)

GetCustomerDisclaimers Get Customer Disclaimers Get active disclaimers for the given customer

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param customerID customerID of the Customer to get disclaimers
  • @param optional nil or *GetCustomerDisclaimersOpts - Optional Parameters:
  • @param "XRequestID" (optional.String) - Optional requestID allows application developer to trace requests through the systems logs
  • @param "XOrganization" (optional.String) - Value used to separate and identify models

@return []Disclaimer

type Document 

type Document struct {
	// A unique identifier for this document
	DocumentID  string `json:"documentID"`
	Type        string `json:"type"`
	ContentType string `json:"contentType"`
	// Optional array of errors encountered dring automated parsing.
	ParseErrors []string  `json:"parseErrors,omitempty"`
	UploadedAt  time.Time `json:"uploadedAt"`
}

Document struct for Document

type DocumentsApiService 

type DocumentsApiService service

DocumentsApiService DocumentsApi service

func (*DocumentsApiService) DeleteCustomerDocument 

func (a *DocumentsApiService) DeleteCustomerDocument(ctx _context.Context, customerID string, documentID string, localVarOptionals *DeleteCustomerDocumentOpts) (*_nethttp.Response, error)

DeleteCustomerDocument Delete Customer Document Remove Customer Document

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param customerID ID of the customer that owns the document
  • @param documentID ID of the document
  • @param optional nil or *DeleteCustomerDocumentOpts - Optional Parameters:
  • @param "XRequestID" (optional.String) - Optional requestID allows application developer to trace requests through the systems logs

func (*DocumentsApiService) GetCustomerDocumentContents 

func (a *DocumentsApiService) GetCustomerDocumentContents(ctx _context.Context, customerID string, documentID string, localVarOptionals *GetCustomerDocumentContentsOpts) (*os.File, *_nethttp.Response, error)

GetCustomerDocumentContents Get Customer Document Retrieve the referenced document

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param customerID customerID of the Customer to get a Document
  • @param documentID documentID to identify a Document
  • @param optional nil or *GetCustomerDocumentContentsOpts - Optional Parameters:
  • @param "XRequestID" (optional.String) - Optional requestID allows application developer to trace requests through the systems logs
  • @param "XOrganization" (optional.String) - Value used to separate and identify models

@return *os.File

func (*DocumentsApiService) GetCustomerDocuments 

func (a *DocumentsApiService) GetCustomerDocuments(ctx _context.Context, customerID string, localVarOptionals *GetCustomerDocumentsOpts) ([]Document, *_nethttp.Response, error)

GetCustomerDocuments Get Customer Documents Get documents for a customer

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param customerID customerID of the Customer to get all Documents
  • @param optional nil or *GetCustomerDocumentsOpts - Optional Parameters:
  • @param "XRequestID" (optional.String) - Optional requestID allows application developer to trace requests through the systems logs
  • @param "XOrganization" (optional.String) - Value used to separate and identify models

@return []Document

func (*DocumentsApiService) UploadCustomerDocument 

func (a *DocumentsApiService) UploadCustomerDocument(ctx _context.Context, customerID string, type_ string, file *os.File, localVarOptionals *UploadCustomerDocumentOpts) (Document, *_nethttp.Response, error)

UploadCustomerDocument Upload Customer Document Upload a document for the given customer

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param customerID customerID of the Customer to add a document
  • @param type_ Document type (see Document type for values)
  • @param file Document to be uploaded
  • @param optional nil or *UploadCustomerDocumentOpts - Optional Parameters:
  • @param "XRequestID" (optional.String) - Optional requestID allows application developer to trace requests through the systems logs
  • @param "XOrganization" (optional.String) - Value used to separate and identify models

@return Document

type Error 

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

Error struct for 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 GetAccountValidationOpts 

type GetAccountValidationOpts struct {
	XRequestID    optional.String
	XOrganization optional.String
}

GetAccountValidationOpts Optional parameters for the method 'GetAccountValidation'

type GetCustomerAccountByIDOpts 

type GetCustomerAccountByIDOpts struct {
	XRequestID    optional.String
	XOrganization optional.String
}

GetCustomerAccountByIDOpts Optional parameters for the method 'GetCustomerAccountByID'

type GetCustomerAccountsOpts 

type GetCustomerAccountsOpts struct {
	XRequestID    optional.String
	XOrganization optional.String
}

GetCustomerAccountsOpts Optional parameters for the method 'GetCustomerAccounts'

type GetCustomerDisclaimersOpts 

type GetCustomerDisclaimersOpts struct {
	XRequestID    optional.String
	XOrganization optional.String
}

GetCustomerDisclaimersOpts Optional parameters for the method 'GetCustomerDisclaimers'

type GetCustomerDocumentContentsOpts 

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

GetCustomerDocumentContentsOpts Optional parameters for the method 'GetCustomerDocumentContents'

type GetCustomerDocumentsOpts 

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

GetCustomerDocumentsOpts Optional parameters for the method 'GetCustomerDocuments'

type GetCustomerOpts 

type GetCustomerOpts struct {
	XRequestID    optional.String
	XOrganization optional.String
}

GetCustomerOpts Optional parameters for the method 'GetCustomer'

type GetLatestAccountOFACSearchOpts 

type GetLatestAccountOFACSearchOpts struct {
	XRequestID    optional.String
	XOrganization optional.String
}

GetLatestAccountOFACSearchOpts Optional parameters for the method 'GetLatestAccountOFACSearch'

type GetLatestOFACSearchOpts 

type GetLatestOFACSearchOpts struct {
	XRequestID    optional.String
	XOrganization optional.String
}

GetLatestOFACSearchOpts Optional parameters for the method 'GetLatestOFACSearch'

type GetOrganizationConfigurationOpts 

type GetOrganizationConfigurationOpts struct {
	XOrganization optional.String
}

GetOrganizationConfigurationOpts Optional parameters for the method 'GetOrganizationConfiguration'

type GetReportOfCustomerAccountsOpts 

type GetReportOfCustomerAccountsOpts struct {
	XRequestID    optional.String
	XOrganization optional.String
	AccountIDs    optional.String
}

GetReportOfCustomerAccountsOpts Optional parameters for the method 'GetReportOfCustomerAccounts'

type InitAccountValidationOpts 

type InitAccountValidationOpts struct {
	XRequestID    optional.String
	XOrganization optional.String
}

InitAccountValidationOpts Optional parameters for the method 'InitAccountValidation'

type InitAccountValidationRequest 

type InitAccountValidationRequest struct {
	// Validation strategy to use for the account.  micro-deposits: Initiate two small credits to the account along with a later balancing debit.  instant: Initiate instant account validation with specified vendor (e.g. Plaid, MX).
	Strategy string `json:"strategy"`
	Vendor   string `json:"vendor,omitempty"`
}

InitAccountValidationRequest struct for InitAccountValidationRequest

type InitAccountValidationResponse 

type InitAccountValidationResponse struct {
	// A unique identifier for the validation
	ValidationID string `json:"validationID,omitempty"`
	// Validation strategy
	Strategy string `json:"strategy,omitempty"`
	// Validation vendor
	Vendor string `json:"vendor,omitempty"`
	// Validation status
	Status    string    `json:"status,omitempty"`
	CreatedAt time.Time `json:"createdAt,omitempty"`
	UpdatedAt time.Time `json:"updatedAt,omitempty"`
	// key/value map of vendor specific params
	VendorResponse map[string]interface{} `json:"vendor_response,omitempty"`
}

InitAccountValidationResponse struct for InitAccountValidationResponse

type InstitutionAddress 

type InstitutionAddress struct {
	Address1 string `json:"address1"`
	Address2 string `json:"address2,omitempty"`
	City     string `json:"city"`
	State    string `json:"state"`
	Zip      string `json:"zip"`
}

InstitutionAddress struct for InstitutionAddress

type InstitutionDetails 

type InstitutionDetails struct {
	Name          string             `json:"name"`
	RoutingNumber string             `json:"routingNumber"`
	PhoneNumber   string             `json:"phoneNumber,omitempty"`
	Address       InstitutionAddress `json:"address,omitempty"`
}

InstitutionDetails struct for InstitutionDetails

type OfacSearch 

type OfacSearch struct {
	// SDN EntityID of the Entity
	EntityID string `json:"entityID"`
	// If the search resulted in a positive match against a sanctions list and should be blocked from making transfers or other operations.
	Blocked bool `json:"blocked"`
	// Name of the SDN entity
	SdnName string `json:"sdnName"`
	// SDN entity type
	SdnType string `json:"sdnType"`
	// Percentage of similarity between the Customer name and this OFAC entity
	Match     float32   `json:"match"`
	CreatedAt time.Time `json:"createdAt"`
}

OfacSearch struct for OfacSearch

type OrganizationConfiguration 

type OrganizationConfiguration struct {
	// customerID of legal entity for this Organization
	LegalEntity string `json:"legalEntity"`
	// accountID of funding/source account for this Organization
	PrimaryAccount string `json:"primaryAccount"`
}

OrganizationConfiguration struct for OrganizationConfiguration

type Phone 

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

Phone struct for Phone

type PhoneType 

type PhoneType string

PhoneType phone type 

const (
	PHONETYPE_HOME   PhoneType = "home"
	PHONETYPE_MOBILE PhoneType = "mobile"
	PHONETYPE_WORK   PhoneType = "work"
)

List of PhoneType

type RefreshAccountOFACSearchOpts 

type RefreshAccountOFACSearchOpts struct {
	XRequestID    optional.String
	XOrganization optional.String
}

RefreshAccountOFACSearchOpts Optional parameters for the method 'RefreshAccountOFACSearch'

type RefreshOFACSearchOpts 

type RefreshOFACSearchOpts struct {
	XRequestID    optional.String
	XOrganization optional.String
}

RefreshOFACSearchOpts Optional parameters for the method 'RefreshOFACSearch'

type ReplaceCustomerMetadataOpts 

type ReplaceCustomerMetadataOpts struct {
	XRequestID    optional.String
	XOrganization optional.String
}

ReplaceCustomerMetadataOpts Optional parameters for the method 'ReplaceCustomerMetadata'

type ReportAccountResponse 

type ReportAccountResponse struct {
	Customer Customer `json:"Customer,omitempty"`
	Account  Account  `json:"Account,omitempty"`
}

ReportAccountResponse struct for ReportAccountResponse

type ReportsApiService 

type ReportsApiService service

ReportsApiService ReportsApi service

func (*ReportsApiService) GetReportOfCustomerAccounts 

func (a *ReportsApiService) GetReportOfCustomerAccounts(ctx _context.Context, localVarOptionals *GetReportOfCustomerAccountsOpts) ([]ReportAccountResponse, *_nethttp.Response, error)

GetReportOfCustomerAccounts Create Report of Accounts Retrieves a list of customer and account information.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param optional nil or *GetReportOfCustomerAccountsOpts - Optional Parameters:
  • @param "XRequestID" (optional.String) - Optional requestID allows application developer to trace requests through the systems logs
  • @param "XOrganization" (optional.String) - Value used to separate and identify models
  • @param "AccountIDs" (optional.String) - A list of customer account IDs with a limit of 25 IDs.

@return []ReportAccountResponse

type SearchCustomersOpts 

type SearchCustomersOpts struct {
	Query       optional.String
	Email       optional.String
	Status      optional.String
	Type_       optional.String
	Skip        optional.String
	Count       optional.String
	CustomerIDs optional.String
}

SearchCustomersOpts Optional parameters for the method 'SearchCustomers'

type ServerConfiguration 

type ServerConfiguration struct {
	Url         string
	Description string
	Variables   map[string]ServerVariable
}

ServerConfiguration stores the information about a server

type ServerVariable 

type ServerVariable struct {
	Description  string
	DefaultValue string
	EnumValues   []string
}

ServerVariable stores the information about a server variable

type TransitAccountNumber 

type TransitAccountNumber struct {
	// The base64 encoded encrypted account number for the bank account for transit across services. The symmetric key used is configured from TRANSIT_LOCAL_BASE64_KEY and callers of endpoints that respond with encrypted values need this same key to decrypt.
	AccountNumber string `json:"accountNumber,omitempty"`
}

TransitAccountNumber struct for TransitAccountNumber

type UpdateAccountStatus 

type UpdateAccountStatus struct {
	Status AccountStatus `json:"status"`
}

UpdateAccountStatus struct for UpdateAccountStatus

type UpdateCustomerAddress 

type UpdateCustomerAddress struct {
	// Attribute of address
	Type string `json:"type"`
	// If this address has been confirmed with the Customer
	Validated bool `json:"validated,omitempty"`
	// First line of the address
	Address1 string `json:"address1"`
	// Second line of the address
	Address2 string `json:"address2,omitempty"`
	City     string `json:"city"`
	// two character code of a US state
	State      string `json:"state"`
	PostalCode string `json:"postalCode"`
	Country    string `json:"country"`
}

UpdateCustomerAddress struct for UpdateCustomerAddress

type UpdateCustomerOpts 

type UpdateCustomerOpts struct {
	XRequestID    optional.String
	XOrganization optional.String
}

UpdateCustomerOpts Optional parameters for the method 'UpdateCustomer'

type UpdateCustomerStatus 

type UpdateCustomerStatus struct {
	// Free form comment about the customer status update
	Comment string         `json:"comment,omitempty"`
	Status  CustomerStatus `json:"status"`
}

UpdateCustomerStatus struct for UpdateCustomerStatus

type UpdateCustomerStatusOpts 

type UpdateCustomerStatusOpts struct {
	XRequestID    optional.String
	XOrganization optional.String
}

UpdateCustomerStatusOpts Optional parameters for the method 'UpdateCustomerStatus'

type UpdateOrganizationConfigurationOpts 

type UpdateOrganizationConfigurationOpts struct {
	XOrganization optional.String
}

UpdateOrganizationConfigurationOpts Optional parameters for the method 'UpdateOrganizationConfiguration'

type UpdateValidation 

type UpdateValidation struct {
	// Validation strategy to use for the account.  micro-deposits:   Initiate two small credits to the account along with a later balancing debit. Only provide amounts to attempt validation.
	Strategy      string   `json:"strategy"`
	MicroDeposits []Amount `json:"micro-deposits,omitempty"`
}

UpdateValidation struct for UpdateValidation

type UploadCustomerDocumentOpts 

type UploadCustomerDocumentOpts struct {
	XRequestID    optional.String
	XOrganization optional.String
}

UploadCustomerDocumentOpts Optional parameters for the method 'UploadCustomerDocument'

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.