Why Go
- Case Studies
  
  Common problems companies solve with Go
- Use Cases
  
  Stories about how and why companies use Go
- Security Policy
  
  How Go can help keep you secure by default
Learn
Docs
- Effective Go
  
  Tips for writing clear, performant, and idiomatic Go code
- Go User Manual
  
  A complete introduction to building software with Go
- Standard library
  
  Reference documentation for Go's standard library
- Release Notes
  
  Learn what's new in each Go release
Packages
Community
- Recorded Talks
  
  Videos from prior events
- Meetups
  
  Meet other local Go developers
- Conferences
  
  Learn and network with Go developers from around the world
- Go blog
  
  The Go project's official blog.
- Go project
  
  Get help and stay informed from Go
- Get connected

atrium

package

Go to main page

Versions in this module

v3

v3.0.3

May 28, 2020

Changes in this version

type ConnectWidgetRequestBody

+ WaitForFullAggregation bool

v3.0.2

Apr 26, 2020

v3.0.1

Apr 26, 2020

Changes in this version

+ var ContextAPIKey = contextKey("apikey")

+ var ContextAccessToken = contextKey("accesstoken")

+ var ContextBasicAuth = contextKey("basic")

+ var ContextOAuth2 = contextKey("token")

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

+ type APIClient struct

+ Accounts *AccountsApiService

+ ConnectWidget *ConnectWidgetApiService

+ Holdings *HoldingsApiService

+ Identity *IdentityApiService

+ Institutions *InstitutionsApiService

+ Members *MembersApiService

+ Merchants *MerchantsApiService

+ Statements *StatementsApiService

+ Transactions *TransactionsApiService

+ Users *UsersApiService

+ Verification *VerificationApiService

+ func AtriumClient(apiKey, clientId string) *APIClient

+ func AtriumClientWithConfiguration(apiKey, clientId string, config *Configuration) *APIClient

+ func (c *APIClient) ChangeBasePath(path string)

+ type APIKey struct

+ Key string

+ Prefix string

+ type APIResponse struct

+ Message string

+ Method string

+ Operation string

+ Payload []byte

+ RequestURL string

+ func NewAPIResponse(r *http.Response) *APIResponse

+ func NewAPIResponseWithError(errorMessage string) *APIResponse

+ type Account struct

+ AccountNumber string

+ Apr float32

+ Apy float32

+ AvailableBalance float32

+ AvailableCredit float32

+ Balance float32

+ CashBalance float32

+ CashSurrenderValue float32

+ CreatedAt string

+ CreditLimit float32

+ CurrencyCode string

+ DayPaymentIsDue int32

+ DeathBenefit float32

+ GUID string

+ HoldingsValue float32

+ InstitutionCode string

+ InterestRate float32

+ IsClosed bool

+ LastPayment float32

+ LoanAmount float32

+ MaturesOn string

+ MemberGUID string

+ MinimumBalance float32

+ MinimumPayment float32

+ Name string

+ OriginalBalance float32

+ PaymentDueAt string

+ PayoffBalance float32

+ StartedOn string

+ Subtype string

+ TotalAccountValue float32

+ Type_ string

+ UpdatedAt string

+ UserGUID string

+ type AccountNumber struct

+ AccountGUID string

+ AccountNumber string

+ MemberGUID string

+ RoutingNumber string

+ UserGUID string

+ type AccountNumbersResponseBody struct

+ AccountNumbers []AccountNumber

+ type AccountOwner struct

+ AccountGUID string

+ Address string

+ City string

+ Country string

+ Email string

+ GUID string

+ MemberGUID string

+ OwnerName string

+ PostalCode string

+ State string

+ UserGUID string

+ type AccountOwnersResponseBody struct

+ AccountOwners []AccountOwner

+ type AccountResponseBody struct

+ Account *Account

+ type AccountsApiService service

+ func (a *AccountsApiService) ListAccountTransactions(ctx context.Context, accountGUID string, userGUID string, ...) (atrium.TransactionsResponseBody, *http.Response, error)

+ func (a *AccountsApiService) ListUserAccounts(ctx context.Context, userGUID string, localVarOptionals *ListUserAccountsOpts) (atrium.AccountsResponseBody, *http.Response, error)

+ func (a *AccountsApiService) ReadAccount(ctx context.Context, accountGUID string, userGUID string) (atrium.AccountResponseBody, *http.Response, error)

+ func (a *AccountsApiService) ReadAccountByMemberGUID(ctx context.Context, accountGUID string, memberGUID string, userGUID string) (atrium.AccountResponseBody, *http.Response, error)

+ type AccountsResponseBody struct

+ Accounts []Account

+ Pagination *Pagination

+ type BasicAuth struct

+ Password string

+ UserName string

+ type Challenge struct

+ FieldName string

+ GUID string

+ ImageData string

+ ImageOptions []ChallengeImageOption

+ Label string

+ Options []ChallengeOption

+ Type_ string

+ type ChallengeImageOption struct

+ DataUri string

+ Label string

+ Value string

+ type ChallengeOption struct

+ Label string

+ Value string

+ type ChallengesResponseBody struct

+ Challenges []Challenge

+ type Configuration struct

+ BasePath string

+ DefaultHeader map[string]string

+ HTTPClient *http.Client

+ Host string

+ Scheme string

+ UserAgent string

+ func NewConfiguration() *Configuration

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

+ type ConnectWidget struct

+ ConnectWidgetURL string

+ GUID string

+ type ConnectWidgetApiService service

+ func (a *ConnectWidgetApiService) GetConnectWidget(ctx context.Context, userGUID string, body atrium.ConnectWidgetRequestBody) (atrium.ConnectWidgetResponseBody, *http.Response, error)

+ type ConnectWidgetRequestBody struct

+ CurrentInstitutionCode string

+ CurrentMemberGUID string

+ DisableInstitutionSearch bool

+ IsMobileWebview bool

+ Mode string

+ UiMessageVersion float32

+ UpdateCredentials bool

+ type ConnectWidgetResponseBody struct

+ User *ConnectWidget

+ type CredentialOption struct

+ Label string

+ Value string

+ type CredentialRequest struct

+ GUID string

+ Value string

+ type CredentialResponse struct

+ FieldName string

+ GUID string

+ Label string

+ Options []CredentialOption

+ Type_ string

+ type CredentialsResponseBody struct

+ Credentials []CredentialResponse

+ type GenericError struct

+ func (e GenericError) Body() []byte

+ func (e GenericError) Error() string

+ func (e GenericError) Model() interface{}

+ type Holding struct

+ AccountGUID string

+ CostBasis float32

+ CreatedAt string

+ CurrencyCode string

+ Cusip string

+ DailyChange float32

+ Description string

+ GUID string

+ HoldingType string

+ MarketValue float32

+ MemberGUID string

+ PurchasePrice float32

+ Shares float32

+ Symbol string

+ UpdatedAt string

+ UserGUID string

+ type HoldingResponseBody struct

+ Holding *Holding

+ type HoldingsApiService service

+ func (a *HoldingsApiService) ListHoldings(ctx context.Context, userGUID string) (atrium.HoldingsResponseBody, *http.Response, error)

+ func (a *HoldingsApiService) ListHoldingsByAccount(ctx context.Context, accountGUID string, userGUID string) (atrium.HoldingsResponseBody, *http.Response, error)

+ func (a *HoldingsApiService) ListHoldingsByMember(ctx context.Context, memberGUID string, userGUID string) (atrium.HoldingsResponseBody, *http.Response, error)

+ func (a *HoldingsApiService) ReadHolding(ctx context.Context, holdingGUID string, userGUID string) (atrium.HoldingResponseBody, *http.Response, error)

+ type HoldingsResponseBody struct

+ Holdings []Holding

+ Pagination *Pagination

+ type IdentityApiService service

+ func (a *IdentityApiService) IdentifyMember(ctx context.Context, memberGUID string, userGUID string) (atrium.MemberResponseBody, *http.Response, error)

+ func (a *IdentityApiService) ListAccountOwners(ctx context.Context, memberGUID string, userGUID string) (atrium.AccountOwnersResponseBody, *http.Response, error)

+ type Institution struct

+ Code string

+ MediumLogoURL string

+ Name string

+ SmallLogoURL string

+ SupportsAccountIdentification bool

+ SupportsAccountStatement bool

+ SupportsAccountVerification bool

+ SupportsTransactionHistory bool

+ URL string

+ type InstitutionResponseBody struct

+ Institution *Institution

+ type InstitutionsApiService service

+ func (a *InstitutionsApiService) ListInstitutions(ctx context.Context, localVarOptionals *ListInstitutionsOpts) (atrium.InstitutionsResponseBody, *http.Response, error)

+ func (a *InstitutionsApiService) ReadInstitution(ctx context.Context, institutionCode string) (atrium.InstitutionResponseBody, *http.Response, error)

+ func (a *InstitutionsApiService) ReadInstitutionCredentials(ctx context.Context, institutionCode string) (atrium.CredentialsResponseBody, *http.Response, error)

+ type InstitutionsResponseBody struct

+ Institutions []Institution

+ Pagination *Pagination

+ type ListAccountTransactionsOpts struct

+ FromDate optional.String

+ Page optional.Int32

+ RecordsPerPage optional.Int32

+ ToDate optional.String

+ type ListInstitutionsOpts struct

+ Name optional.String

+ Page optional.Int32

+ RecordsPerPage optional.Int32

+ SupportsAccountIdentification optional.Bool

+ SupportsAccountStatement optional.Bool

+ SupportsAccountVerification optional.Bool

+ SupportsTransactionHistory optional.Bool

+ type ListMemberAccountsOpts struct

+ Page optional.Int32

+ RecordsPerPage optional.Int32

+ type ListMemberStatementsOpts struct

+ Page optional.Int32

+ RecordsPerPage optional.Int32

+ type ListMemberTransactionsOpts struct

+ FromDate optional.String

+ Page optional.Int32

+ RecordsPerPage optional.Int32

+ ToDate optional.String

+ type ListMembersOpts struct

+ Page optional.Int32

+ RecordsPerPage optional.Int32

+ type ListUserAccountsOpts struct

+ Page optional.Int32

+ RecordsPerPage optional.Int32

+ type ListUserTransactionsOpts struct

+ FromDate optional.String

+ Page optional.Int32

+ RecordsPerPage optional.Int32

+ ToDate optional.String

+ type ListUsersOpts struct

+ Page optional.Int32

+ RecordsPerPage optional.Int32

+ type Member struct

+ AggregatedAt string

+ ConnectionStatus string

+ GUID string

+ Identifier string

+ InstitutionCode string

+ IsBeingAggregated bool

+ Metadata string

+ Name string

+ Status string

+ SuccessfullyAggregatedAt string

+ UserGUID string

+ type MemberConnectionStatus struct

+ AggregatedAt string

+ Challenges []Challenge

+ ConnectionStatus string

+ GUID string

+ HasProcessedAccounts bool

+ HasProcessedTransactions bool

+ IsAuthenticated bool

+ IsBeingAggregated bool

+ Status string

+ SuccessfullyAggregatedAt string

+ type MemberConnectionStatusResponseBody struct

+ Member *MemberConnectionStatus

+ type MemberCreateRequest struct

+ Credentials []CredentialRequest

+ Identifier string

+ InstitutionCode string

+ Metadata string

+ SkipAggregation bool

+ type MemberCreateRequestBody struct

+ Member *MemberCreateRequest

+ type MemberResponseBody struct

+ Member *Member

+ type MemberResumeRequest struct

+ Challenges []CredentialRequest

+ type MemberResumeRequestBody struct

+ Member *MemberResumeRequest

+ type MemberUpdateRequest struct

+ Credentials []CredentialRequest

+ Identifier string

+ Metadata string

+ type MemberUpdateRequestBody struct

+ Member *MemberUpdateRequest

+ type MembersApiService service

+ func (a *MembersApiService) AggregateMember(ctx context.Context, memberGUID string, userGUID string) (atrium.MemberResponseBody, *http.Response, error)

+ func (a *MembersApiService) AggregateMemberBalances(ctx context.Context, memberGUID string, userGUID string) (atrium.MemberResponseBody, *http.Response, error)

+ func (a *MembersApiService) CreateMember(ctx context.Context, userGUID string, body atrium.MemberCreateRequestBody) (atrium.MemberResponseBody, *http.Response, error)

+ func (a *MembersApiService) DeleteMember(ctx context.Context, memberGUID string, userGUID string) (*http.Response, error)

+ func (a *MembersApiService) ExtendHistory(ctx context.Context, memberGUID string, userGUID string) (atrium.MemberResponseBody, *http.Response, error)

+ func (a *MembersApiService) ListMemberAccounts(ctx context.Context, memberGUID string, userGUID string, ...) (atrium.AccountsResponseBody, *http.Response, error)

+ func (a *MembersApiService) ListMemberCredentials(ctx context.Context, memberGUID string, userGUID string) (atrium.CredentialsResponseBody, *http.Response, error)

+ func (a *MembersApiService) ListMemberMFAChallenges(ctx context.Context, memberGUID string, userGUID string) (atrium.ChallengesResponseBody, *http.Response, error)

+ func (a *MembersApiService) ListMemberTransactions(ctx context.Context, memberGUID string, userGUID string, ...) (atrium.TransactionsResponseBody, *http.Response, error)

+ func (a *MembersApiService) ListMembers(ctx context.Context, userGUID string, localVarOptionals *ListMembersOpts) (atrium.MembersResponseBody, *http.Response, error)

+ func (a *MembersApiService) ReadMember(ctx context.Context, memberGUID string, userGUID string) (atrium.MemberResponseBody, *http.Response, error)

+ func (a *MembersApiService) ReadMemberStatus(ctx context.Context, memberGUID string, userGUID string) (atrium.MemberConnectionStatusResponseBody, *http.Response, error)

+ func (a *MembersApiService) ResumeMember(ctx context.Context, memberGUID string, userGUID string, ...) (atrium.MemberResponseBody, *http.Response, error)

+ func (a *MembersApiService) UpdateMember(ctx context.Context, memberGUID string, userGUID string, ...) (atrium.MemberResponseBody, *http.Response, error)

+ type MembersResponseBody struct

+ Members []Member

+ Pagination *Pagination

+ type Merchant struct

+ CreatedAt string

+ GUID string

+ LogoURL string

+ Name string

+ UpdatedAt string

+ WebsiteURL string

+ type MerchantResponseBody struct

+ Merchant *Merchant

+ type MerchantsApiService service

+ func (a *MerchantsApiService) ReadMerchant(ctx context.Context, merchantGUID string) (atrium.MerchantResponseBody, *http.Response, error)

+ type Pagination struct

+ CurrentPage int32

+ PerPage int32

+ TotalEntries int32

+ TotalPages int32

+ type Statement struct

+ AccountGUID string

+ ContentHash string

+ CreatedAt string

+ GUID string

+ MemberGUID string

+ UpdatedAt string

+ Uri string

+ UserGUID string

+ type StatementResponseBody struct

+ User *Statement

+ type StatementsApiService service

+ func (a *StatementsApiService) DownloadStatementPdf(ctx context.Context, memberGUID string, userGUID string, statementGUID string) (*os.File, *http.Response, error)

+ func (a *StatementsApiService) FetchStatements(ctx context.Context, memberGUID string, userGUID string) (atrium.MemberResponseBody, *http.Response, error)

+ func (a *StatementsApiService) ListMemberStatements(ctx context.Context, memberGUID string, userGUID string, ...) (atrium.StatementsResponseBody, *http.Response, error)

+ func (a *StatementsApiService) ReadMemberStatement(ctx context.Context, memberGUID string, userGUID string, statementGUID string) (atrium.StatementResponseBody, *http.Response, error)

+ type StatementsResponseBody struct

+ Pagination *Pagination

+ Statements []Statement

+ type Transaction struct

+ AccountGUID string

+ Amount float32

+ Category string

+ CheckNumber int32

+ CheckNumberString string

+ CreatedAt string

+ CurrencyCode string

+ Date string

+ Description string

+ GUID string

+ IsBillPay bool

+ IsDirectDeposit bool

+ IsExpense bool

+ IsFee bool

+ IsIncome bool

+ IsInternational bool

+ IsOverdraftFee bool

+ IsPayrollAdvance bool

+ Latitude float32

+ Longitude float32

+ MemberGUID string

+ Memo string

+ MerchantCategoryCode int32

+ MerchantGUID string

+ OriginalDescription string

+ PostedAt string

+ Status string

+ TopLevelCategory string

+ TransactedAt string

+ Type_ string

+ UpdatedAt string

+ UserGUID string

+ type TransactionCleanseAndCategorizeRequest struct

+ Amount float32

+ Description string

+ Identifier string

+ MerchantCategoryCode float32

+ Type_ string

+ type TransactionCleanseAndCategorizeResponse struct

+ Amount float32

+ Category string

+ Description string

+ Identifier string

+ IsBillPay bool

+ IsDirectDeposit bool

+ IsExpense bool

+ IsFee bool

+ IsIncome bool

+ IsInternational bool

+ IsOverdraftFee bool

+ IsPayrollAdvance bool

+ MerchantCategoryCode float32

+ MerchantGUID string

+ OriginalDescription string

+ Type_ string

+ type TransactionResponseBody struct

+ Transaction *Transaction

+ type TransactionsApiService service

+ func (a *TransactionsApiService) CleanseAndCategorizeTransactions(ctx context.Context, body atrium.TransactionsCleanseAndCategorizeRequestBody) (atrium.TransactionsCleanseAndCategorizeResponseBody, *http.Response, error)

+ func (a *TransactionsApiService) ListUserTransactions(ctx context.Context, userGUID string, ...) (atrium.TransactionsResponseBody, *http.Response, error)

+ func (a *TransactionsApiService) ReadTransaction(ctx context.Context, transactionGUID string, userGUID string) (atrium.TransactionResponseBody, *http.Response, error)

+ type TransactionsCleanseAndCategorizeRequestBody struct

+ Transactions []TransactionCleanseAndCategorizeRequest

+ type TransactionsCleanseAndCategorizeResponseBody struct

+ Transactions []TransactionCleanseAndCategorizeResponse

+ type TransactionsResponseBody struct

+ Pagination *Pagination

+ Transactions []Transaction

+ type UpdateMemberOpts struct

+ Body optional.Interface

+ type UpdateUserOpts struct

+ Body optional.Interface

+ type User struct

+ GUID string

+ Identifier string

+ IsDisabled bool

+ Metadata string

+ type UserCreateRequestBody struct

+ User *User

+ type UserResponseBody struct

+ User *User

+ type UserUpdateRequestBody struct

+ User *User

+ type UsersApiService service

+ func (a *UsersApiService) CreateUser(ctx context.Context, body atrium.UserCreateRequestBody) (atrium.UserResponseBody, *http.Response, error)

+ func (a *UsersApiService) DeleteUser(ctx context.Context, userGUID string) (*http.Response, error)

+ func (a *UsersApiService) ListUsers(ctx context.Context, localVarOptionals *ListUsersOpts) (atrium.UsersResponseBody, *http.Response, error)

+ func (a *UsersApiService) ReadUser(ctx context.Context, userGUID string) (atrium.UserResponseBody, *http.Response, error)

+ func (a *UsersApiService) UpdateUser(ctx context.Context, userGUID string, localVarOptionals *UpdateUserOpts) (atrium.UserResponseBody, *http.Response, error)

+ type UsersResponseBody struct

+ Pagination *Pagination

+ Users []User

+ type VerificationApiService service

+ func (a *VerificationApiService) ListAccountNumbers(ctx context.Context, memberGUID string, userGUID string) (atrium.AccountNumbersResponseBody, *http.Response, error)

+ func (a *VerificationApiService) ListAccountNumbersByAccount(ctx context.Context, accountGUID string, userGUID string) (atrium.AccountNumbersResponseBody, *http.Response, error)

+ func (a *VerificationApiService) VerifyMember(ctx context.Context, memberGUID string, userGUID string) (atrium.MemberResponseBody, *http.Response, error)