README
¶
fastconnect
THIS IST WIP!!!
[x] createUser
[x] deleteUser
[x] loginUser
[x] addBankCredentials
[x] getAllBankAccounts
[x] removeBankAccount from figo-Account
[x] getTransactions
[x] request task state
Documentation
¶
Index ¶
- Variables
- func CreateUser(connection fiGo.IConnection, figoUser FigoUser) (string, error)
- func DeleteUser(connection fiGo.IConnection, accessToken string) error
- func LoginUser(connection fiGo.IConnection, figoUser FigoUser) (string, error)
- func RemoveBankAccount(connection fiGo.IConnection, accessToken string, bankAccountID string) error
- func RetrieveAllBankAccounts(connection fiGo.IConnection, accessToken string, cents bool) (interface{}, error)
- func RetrieveAllTransactions(connection fiGo.IConnection, accessToken string, ...) ([]interface{}, error)
- func RetrieveSpecificTransactions(connection fiGo.IConnection, accessToken string) ([]interface{}, error)
- func RetrieveStandingOrders(connection fiGo.IConnection, accessToken string, ...) ([]interface{}, error)
- func SetupNewBankAccount(connection fiGo.IConnection, accessToken string, ...) (string, error)
- type BankCredentials
- type CatalogEntry
- type FigoUser
- type Task
Constants ¶
This section is empty.
Variables ¶
View Source
var ( // ErrRecoveryPassword cant find a "recovery_password" in JSON ErrRecoveryPassword = errors.New("figo-fastconnect: extract recovery password failed") )
Functions ¶
func CreateUser ¶
func CreateUser(connection fiGo.IConnection, figoUser FigoUser) (string, error)
CreateUser creates a user on figo-side -> return a recovery-password
func DeleteUser ¶
func DeleteUser(connection fiGo.IConnection, accessToken string) error
DeleteUser deletes a user on figo-side
func LoginUser ¶
func LoginUser(connection fiGo.IConnection, figoUser FigoUser) (string, error)
LoginUser logs a user in -> returns the accessToken
func RemoveBankAccount ¶
func RemoveBankAccount(connection fiGo.IConnection, accessToken string, bankAccountID string) error
RemoveBankAccount removes a bankAccount from a user on figo-side
func RetrieveAllBankAccounts ¶
func RetrieveAllBankAccounts(connection fiGo.IConnection, accessToken string, cents bool) (interface{}, error)
RetrieveAllBankAccounts retrieves all bankAccounts
func RetrieveAllTransactions ¶
func RetrieveAllTransactions(connection fiGo.IConnection, accessToken string, options ...fiGo.TransactionOption) ([]interface{}, error)
RetrieveAllTransactions retrieves all transacions of all accounts
func RetrieveSpecificTransactions ¶
func RetrieveSpecificTransactions(connection fiGo.IConnection, accessToken string) ([]interface{}, error)
RetrieveSpecificTransactions retrieves a specific transaction
func RetrieveStandingOrders ¶
func RetrieveStandingOrders(connection fiGo.IConnection, accessToken string, options ...fiGo.TransactionOption) ([]interface{}, error)
RetrieveStandingOrders retrieves all standing orders of all accounts
func SetupNewBankAccount ¶
func SetupNewBankAccount(connection fiGo.IConnection, accessToken string, bankCredentials BankCredentials, savePin bool) (string, error)
SetupNewBankAccount add a bankAccount to an existing figoAccount -> returns a taskToken
Types ¶
type BankCredentials ¶
type BankCredentials struct {
BankCode string `json:"bankCode,omitempty" bson:"bankCode,omitempty"`
Country string `json:"country,omitempty" bson:"country,omitempty"`
Credentials []string `json:"credentials,omitempty" bson:"credentials,omitempty"`
}
BankCredentials represent the BankCredentials
type CatalogEntry ¶
type CatalogEntry struct {
Name string `json:"name"`
BankCode string `json:"bank_code"`
Icon string `json:"icon"`
AdditionalIcons struct {
Four8X48 string `json:"48x48"`
Six0X60 string `json:"60x60"`
Seven2X72 string `json:"72x72"`
Eight4X84 string `json:"84x84"`
Nine6X96 string `json:"96x96"`
One20X120 string `json:"120x120"`
One44X144 string `json:"144x144"`
One92X192 string `json:"192x192"`
Two56X256 string `json:"256x256"`
} `json:"additional_icons"`
Credentials []struct {
Label string `json:"label"`
Masked bool `json:"masked"`
} `json:"credentials"`
Advice string `json:"advice"`
}
func ReadIndividualCatalogEntry ¶
func ReadIndividualCatalogEntry(connection fiGo.IConnection, accessToken string, catalogCategory string, countryCode string, serviceID string) (CatalogEntry, error)
ReadIndividualCatalogEntry returns catlo entry for serviceID
type FigoUser ¶
type FigoUser struct {
Email string `json:"email,omitempty" bson:"email,omitempty"`
Username string `json:"username,omitempty" bson:"username,omitempty"`
Password string `json:"password,omitempty" bson:"password,omitempty"`
}
FigoUser represent a user
type Task ¶
type Task struct {
AccountID string `json:"account_id,omitempty"`
IsEnded bool `json:"is_ended,omitempty"`
IsErroneous bool `json:"is_erroneous,omitempty"`
IsWaitingForPin bool `json:"is_waiting_for_pin,omitempty"`
IsWaitingForResponse bool `json:"is_waiting_for_response,omitempty"`
Message string `json:"message,omitempty"`
}
func RequestTask ¶
func RequestTask(connection fiGo.IConnection, accessToken, taskToken string) (Task, error)
RequestTask check the status of a task token
func RequestTaskWithPinChallenge ¶
func RequestTaskWithPinChallenge(connection fiGo.IConnection, accessToken, taskToken, pin string, savePin bool) (Task, error)
RequestTaskWithPinChallenge can respond to a pin challenge
Source Files
¶
Click to show internal directories.
Click to hide internal directories.