Ibanity.Sandbox.FinancialInstitutionHolding (ibanity v0.12.0)
Financial institution holding API wrapper
Link to this section Summary
Functions
Convenience function to create a new financial institution holding.
Lists holdings linked to a financial institution user account
List holdings linked to a financial institution user account
Link to this section Functions
Link to this function
create(request)
Creates a new financial institution holding.
Returns {:ok, holding} if successful, {:error, reason} otherwise
Link to this function
create(request, financial_institution_id, financial_institution_user_id, financial_institution_account_id, attributes)
Convenience function to create a new financial institution holding.
See create/1
example
Example
iex> attributes = [
...> last_valuation_currency: "USD",
...> last_valuation: 105.5,
...> last_valuation_date: "2020-01-01",
...> total_valuation_currency: "USD",
...> total_valuation: 1055,
...> ...
...> ]
...> FinancialInstitutionHolding.create(
...> "ad6fa583-2616-4a11-8b8d-eb98c53e2905",
...> "740b6ae8-a631-4a32-9afc-a5548ab99d7e",
...> "d9d60751-b741-4fa6-8524-8f9a066ca037",
...> attributes
...> )
{:ok, %Ibanity.FinancialInstitutionHolding{id: "44cd2dc8-163a-4dbe-b544-869e5f84ea54", ...}}
Link to this function
delete(request)
Returns {:ok, holding} if successful, {:error, reason} otherwise
example
Example
iex> %Request{}
...> |> Request.id(:financial_institution_id, "ad6fa583-2616-4a11-8b8d-eb98c53e2905")
...> |> Request.id(:financial_institution_user_id, "740b6ae8-a631-4a32-9afc-a5548ab99d7e")
...> |> Request.id(:financial_institution_account_id, "d9d60751-b741-4fa6-8524-8f9a066ca037")
...> |> Request.id("83e440d7-6bfa-4b08-92b7-c2ae7fc5c0e9")
...> |> FinancialInstitutionHolding.delete
%{:ok, Ibanity.FinancialInstitutionHolding{id: "44cd2dc8-163a-4dbe-b544-869e5f84ea54", ...}}
Link to this function
delete(request, financial_institution_id, financial_institution_user_id, financial_institution_account_id, financial_institution_holding_id)
See delete/1
example
Example
iex> %Request{}
...> |> FinancialInstitutionHolding.delete(
...> "ad6fa583-2616-4a11-8b8d-eb98c53e2905",
...> "740b6ae8-a631-4a32-9afc-a5548ab99d7e",
...> "d9d60751-b741-4fa6-8524-8f9a066ca037",
...> "83e440d7-6bfa-4b08-92b7-c2ae7fc5c0e9 "
...> )
%{:ok, Ibanity.FinancialInstitutionHolding{id: "44cd2dc8-163a-4dbe-b544-869e5f84ea54", ...}}
Link to this function
find(request)
Returns {:ok, holding} if successful, {:error, reason} otherwise
example
Example
iex> %Request{}
...> |> Request.id(:financial_institution_id, "ad6fa583-2616-4a11-8b8d-eb98c53e2905")
...> |> Request.id(:financial_institution_user_id, "740b6ae8-a631-4a32-9afc-a5548ab99d7e")
...> |> Request.id(:financial_institution_account_id, "d9d60751-b741-4fa6-8524-8f9a066ca037")
...> |> Request.id("83e440d7-6bfa-4b08-92b7-c2ae7fc5c0e9")
...> |> FinancialInstitutionHolding.find
%{:ok, Ibanity.FinancialInstitutionHolding{id: "44cd2dc8-163a-4dbe-b544-869e5f84ea54", ...}}
Link to this function
find(request, financial_institution_id, financial_institution_user_id, financial_institution_account_id, financial_institution_holding_id)
See find/1
example
Example
iex> %Request{}
...> |> FinancialInstitutionHolding.find(
...> "ad6fa583-2616-4a11-8b8d-eb98c53e2905",
...> "740b6ae8-a631-4a32-9afc-a5548ab99d7e",
...> "d9d60751-b741-4fa6-8524-8f9a066ca037",
...> "44cd2dc8-163a-4dbe-b544-869e5f84ea54"
...> )
%{:ok, Ibanity.FinancialInstitutionHolding{id: "44cd2dc8-163a-4dbe-b544-869e5f84ea54", ...}}
Link to this function
list(request)
Lists holdings linked to a financial institution user account
example
Example
iex> %Request{}
...> |> Request.id(:financial_institution_id, "ad6fa583-2616-4a11-8b8d-eb98c53e2905")
...> |> Request.id(:financial_institution_user_id, "740b6ae8-a631-4a32-9afc-a5548ab99d7e")
...> |> Request.id(:financial_institution_account_id, "d9d60751-b741-4fa6-8524-8f9a066ca037")
...> |> FinancialInstitutionHolding.list
%Ibanity.Collection[items: [Ibanity.FinancialInstitutionHolding{id: "44cd2dc8-163a-4dbe-b544-869e5f84ea54", ...}], ...]
Link to this function
list(request, financial_institution_id, financial_institution_user_id, financial_institution_account_id)
List holdings linked to a financial institution user account
## Example
iex> FinancialInstitutionHolding.list(
...> "ad6fa583-2616-4a11-8b8d-eb98c53e2905",
...> "740b6ae8-a631-4a32-9afc-a5548ab99d7e",
...> "d9d60751-b741-4fa6-8524-8f9a066ca037"
...> )
%Ibanity.Collection[items: [Ibanity.FinancialInstitutionHolding{id: "44cd2dc8-163a-4dbe-b544-869e5f84ea54", ...}], ...]