ais

Documentation

Index

• func CreateAccount(c *nordeago.Client, request CreateAccountRequest) (bool, error)
• func CreateAccountTransaction(c *nordeago.Client, accountID string, request Transaction) (bool, error)
• func DeleteAccount(c *nordeago.Client, accountID string) (string, error)
• type Account
• type AccountDetailed
  • func GetAccountDetails(c *nordeago.Client, accountID string) (*AccountDetailed, error)
• type AccountNumber
• type Bank
• type CreateAccountRequest
• type GetAccountTransactionsRequest
• type GetAccountTransactionsResponse
  • func GetAccountTransactions(c *nordeago.Client, accountID string, request GetAccountTransactionsRequest) (*GetAccountTransactionsResponse, error)
• type ListAccountsResponse
  • func ListAccounts(c *nordeago.Client) (ListAccountsResponse, error)
• type Transaction

Functions

func CreateAccount

func CreateAccount(c *nordeago.Client, request CreateAccountRequest) (bool, error)

CreateAccount for sandbox environment

API Documentation: https://developer.nordeaopenbanking.com/app/documentation?api=Accounts%20API&version=2.3#createAccountV2

func CreateAccountTransaction

func CreateAccountTransaction(c *nordeago.Client, accountID string, request Transaction) (bool, error)

CreateAccountTransaction creates a transaction

API Documentation: https://developer.nordeaopenbanking.com/app/documentation?api=Accounts%20API&version=2.3#createTransaction

func DeleteAccount

func DeleteAccount(c *nordeago.Client, accountID string) (string, error)

DeleteAccount for sandbox environment

API Documentation: https://developer.nordeaopenbanking.com/app/documentation?api=Accounts%20API&version=2.3#deleteUserDefinedAccount

Types

type Account

type Account struct {
	AccountID     string `json:"AccountId"`
	AccountNumber string `json:"AccountNumber"`
	Currency      string `json:"Currency"`
}

Account is part of the Response and represents a users accounts

type AccountDetailed

type AccountDetailed struct {
	AccountName                  string          `json:"accountName"`
	AccountNumber                AccountNumber   `json:"accountNumber,omitempty"`
	AccountNumbers               []AccountNumber `json:"accountNumbers,omitempty"`
	ID                           string          `json:"_id,omitempty"`
	Links                        []nordeago.Link `json:"_links,omitempty"`
	AccountType                  string          `json:"accountType"` // Always Current
	AvailableBalance             string          `json:"availableBalance"`
	Bank                         Bank            `json:"bank"`
	BookedBalance                string          `json:"bookedBalance"`
	Country                      string          `json:"country,omitempty"`
	CreditLimit                  string          `json:"creditLimit,omitempty"`
	Currency                     string          `json:"currency"`
	LatestTransactionBookingDate string          `json:"latestTransactionBookingDate,omitempty"`
	OwnerName                    string          `json:"ownerName,omitempty"`
	Product                      string          `json:"product"`
	Status                       string          `json:"status"`
	ValueDatedBalance            string          `json:"valueDatedBalance,omitempty"`
}

AccountDetailed is returned as part of the ListAccountsResponse when fetching account details

func GetAccountDetails

func GetAccountDetails(c *nordeago.Client, accountID string) (*AccountDetailed, error)

GetAccountDetails gets account details for the specified account

API Documentation: https://developer.nordeaopenbanking.com/app/documentation?api=Accounts%20API&version=2.3#accountDetails

type AccountNumber

type AccountNumber struct {
	Type  string `json:"_type"` //IBAN or BBAN_SE
	Value string `json:"value,omitempty"`
}

AccountNumber represents an account number

type Bank

type Bank struct {
	BIC     string `json:"bic"`
	Country string `json:"country"`
	Name    string `json:"name"`
}

Bank represents a bank entity in request and response types

type CreateAccountRequest

type CreateAccountRequest struct {
	ID                           string          `json:"_id"`
	Links                        []nordeago.Link `json:"_links"`
	AccountName                  string          `json:"accountName"`
	AccountNumber                AccountNumber   `json:"accountNumber"`
	AccountNumbers               []AccountNumber `json:"accountNumbers"`
	AccountType                  string          `json:"accountType"` // Always 'Current'
	AvailableBalance             string          `json:"availableBalance"`
	Bank                         Bank            `json:"bank"`
	BookedBalance                string          `json:"bookedBalance"`
	Country                      string          `json:"country,omitempty"`
	Created                      string          `json:"created"`
	CreditLimit                  string          `json:"creditLimit,omitempty"`
	Currency                     string          `json:"currency"` // Currency code according to ISO 4217
	LatestTransactionBookingDate string          `json:"latestTransactionBookingDate,omitempty"`
	OwnerName                    string          `json:"ownerName"`
	Product                      string          `json:"product"`
	Status                       string          `json:"status"` // OPEN or CLOSED
	ValueDatedBalance            string          `json:"valueDatedBalance,omitempty"`
}

CreateAccountRequest is used with the CreateAccount method to create an account

type GetAccountTransactionsRequest

type GetAccountTransactionsRequest struct {
	FromDate        string `json:"fromDate"`
	ToDate          string `json:"toDate"`
	Language        string `json:"language"`
	ContinuationKey string `json:"continuationKey"`
}

GetAccountTransactionsRequest is used with the GetAccountTransactions method to list transactions for the specified account id

type GetAccountTransactionsResponse

type GetAccountTransactionsResponse struct {
	ContinuationKey string          `json:"continuationKey"`
	Links           []nordeago.Link `json:"links"`
	Transactions    []Transaction   `json:"transactions"`
}

GetAccountTransactionsResponse represents returned data from GetAccountTransactions and is part of the GetAccountTransactionsResult object

func GetAccountTransactions

func GetAccountTransactions(c *nordeago.Client, accountID string, request GetAccountTransactionsRequest) (*GetAccountTransactionsResponse, error)

GetAccountTransactions gets the transactions for the specified account

API Documentation: https://developer.nordeaopenbanking.com/app/documentation?api=Accounts%20API&version=2.3#transactionsList

type ListAccountsResponse

type ListAccountsResponse struct {
	Accounts []AccountDetailed `json:"accounts"`
}

ListAccountsResponse contains a list of AccountDetailed types

func ListAccounts

func ListAccounts(c *nordeago.Client) (ListAccountsResponse, error)

ListAccounts lists the accounts for the user

API Documentation: https://developer.nordeaopenbanking.com/app/documentation?api=Accounts%20API&version=2.3#accountList

type Transaction

type Transaction struct {
	Type                    string `json:"_type"` // CreditTransaction or DebitTransaction
	Amount                  string `json:"amount,omitempty"`
	BalanceAfterTransaction string `json:"balanceAfterTransaction,omitempty"`
	BookingDate             string `json:"bookingDate"`
	CardNumber              string `json:"cardNumber,omitempty"`
	CounterpartyName        string `json:"counterpartName,omitempty"`
	Currency                string `json:"currency"`
	CurrencyRate            string `json:"currencyRate,omitempty"`
	Message                 string `json:"message,omitempty"`
	Narrative               string `json:"narrative,omitempty"`
	OriginalCurrency        string `json:"originalCurrency,omitempty"`
	OriginalCurrencyAmount  string `json:"originalCurrencyAmount,omitempty"`
	OwnMessage              string `json:"ownMessage,omitempty"`
	PaymentDate             string `json:"paymentDate,omitempty"`
	Reference               string `json:"reference,omitempty"`
	Status                  string `json:"status"`
	TransactionDate         string `json:"transactionDate,omitempty"`
	TransactionID           string `json:"transactionId"`
	TypeDescription         string `json:"typeDescription,omitempty"`
	ValueDate               string `json:"valueDate,omitempty"`
}

Transaction is used to create or return a transaction