View Source Nordigen (nordigen v0.1.2)

Documentation for Nordigen.

Summary

Functions

Get Access Token Returns {:ok, [%Binance.HistoricalTrade{}]} or {:error, reason}.

List account transactions by account_id

Returns account information by requisition_id

List all Banks by country code.

Build Authentication Link Returns {:ok, [%Binance.HistoricalTrade{}]} or {:error, reason}.

Functions

Get Access Token Returns {:ok, [%Binance.HistoricalTrade{}]} or {:error, reason}.

Example

Link to this function

get_account_balances(account_id, token)

View Source

List account balances

Returns {:ok, list} or {:error, reason}.

Example

{:ok, %Nordigen.Balance{ balances: [ %Nordigen.Balance.Balances{

 balanceAmount: %Nordigen.Balance.Balances.BalanceAmount{
   amount: "1913.12",
   currency: "EUR"
 },
 balanceType: "expected",
 creditLimitIncluded: nil,
 lastChangeDateTime: nil,
 lastCommittedTransaction: nil,
 referenceDate: "2022-07-14"

},...]}

Link to this function

get_account_details(account_id, token)

View Source
Link to this function

list_account_transactions(account_id, token)

View Source

List account transactions by account_id

Returns {:ok, list} or {:error, reason}.

Example

[{:ok, %Nordigen.Transactions.Booked{ additionalInformation: nil, balanceAfterTransaction: nil, bankTransactionCode: "PMNT", bookingDate: "2022-07-12", bookingDateTime: nil, checkId: nil, creditorAccount: nil, creditorAgent: nil, creditorId: nil, creditorName: nil, currencyExchange: nil, debtorAccount: nil, debtorAgent: nil, debtorName: nil, endToEndId: nil, entryReference: nil, mandateId: nil, proprietaryBankTransactionCode: nil, purposeCode: nil, remittanceInformationStructured: nil, remittanceInformationStructuredArray: nil, remittanceInformationUnstructured: "PAYMENT Alderaan Coffe", remittanceInformationUnstructuredArray: nil, transactionAmount: %Nordigen.Transactions.TransactionAmount{

amount: "-15.00",
currency: "EUR"

}, transactionId: "2022071201721808-1", ultimateCreditor: nil, ultimateDebtor: nil, valueDate: "2022-07-12" },..]

Link to this function

list_accounts(requisition_id, token)

View Source

Returns account information by requisition_id

Returns {:ok, list} or {:error, reason}.

Example

{:ok, %Nordigen.Account{ account_selection: false, accounts: ["7e944232-bda9-40bc-b784-660c7ab5fe78", "99a0bfe2-0bef-46df-bff2-e9ae0c6c5838"], agreement: "13c51d1e-5133-4d70-8093-f53caa8dac13", created: "2022-07-14T10:47:39.912391Z", id: "61bbe16d-875c-4d26-bd1c-091fb1cd79fb", institution_id: "SANDBOXFINANCE_SFIN0000", link: "https://bankaccountdata.gocardless.com/psd2/start/61bbe16d-875c-4d26-bd1c-091fb1cd79fb/SANDBOXFINANCE_SFIN0000", redirect: "http://localhost:4000/wallets/50", redirect_immediate: false, reference: "619db4fc-0362-11ed-87dd-1e00e2346e69", ssn: nil, status: "LN", user_languages: nil }}

List all Banks by country code.

Returns {:ok, list} or {:error, reason}.

Example

{:ok, [ %Nordigen.Bank{ bic: "AIPTAU32", countries: ["NO", "SE", "FI", "DK", "EE", "LV", "LT", "GB", "NL", "CZ",

"ES", "PL", "BE", "DE", "AT", "BG", "HR", "CY", "FR", "GR", "HU", "IS",
"IE", "IT", "LI", "LU", "MT", "PT", "RO", "SK", "SI"],

id: "AIRWALLEX_AIPTAU32", logo: "https://cdn.nordigen.com/ais/AIRWALLEX_AIPTAU32_1.png", name: "Airwallex", transaction_total_days: "730" },...]}

Link to this function

requisition_link(redirect, institution_id, token, language_iso \\ "EN")

View Source

Build Authentication Link Returns {:ok, [%Binance.HistoricalTrade{}]} or {:error, reason}.

Example

{:ok, %Nordigen.Link{ account_selection: false, accounts: [], agreement: "", created: "2022-07-14T10:47:39.912391Z", id: "61bbe16d-875c-4d26-bd1c-091fb1cd79fb", institution_id: "SANDBOXFINANCE_SFIN0000", link: "https://bankaccountdata.gocardless.com/psd2/start/61bbe16d-875c-4d26-bd1c-091fb1cd79fb/SANDBOXFINANCE_SFIN0000", redirect: "http://localhost:4000/wallets/50", redirect_immediate: false, reference: "619db4fc-0362-11ed-87dd-1e00e2346e69", ssn: nil, status: "CR", user_language: "EN" }}