Ibanity.Sandbox.FinancialInstitutionTransaction (ibanity v0.12.0)
Financial institution transaction API wrapper
Link to this section Summary
Functions
Convenience function to create a new financial institution transaction.
Lists transactions linked to a financial institution user account
List transactions linked to a financial institution user account
Link to this section Functions
Link to this function
create(request)
Creates a new financial institution transaction.
Returns {:ok, transaction} 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 transaction.
See create/1
example
Example
iex> attributes = [
...> value_date: "2017-05-22T00:00:00Z",
...> execution_date: "2017-05-25T00:00:00Z",
...> amount: 84.42,
...> remittance_information_type: "NEW SHOES",
...> remittance_information: "unstructured",
...> ...
...> ]
...> FinancialInstitutionTransaction.create(
...> "ad6fa583-2616-4a11-8b8d-eb98c53e2905",
...> "740b6ae8-a631-4a32-9afc-a5548ab99d7e",
...> "d9d60751-b741-4fa6-8524-8f9a066ca037",
...> attributes
...> )
{:ok, %Ibanity.FinancialInstitutionTransaction{id: "44cd2dc8-163a-4dbe-b544-869e5f84ea54", ...}}
Link to this function
delete(request)
Returns {:ok, transaction} 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")
...> |> FinancialInstitutionTransaction.delete
%{:ok, Ibanity.FinancialInstitutionTransaction{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_transaction_id)
See delete/1
example
Example
iex> %Request{}
...> |> FinancialInstitutionTransaction.delete(
...> "ad6fa583-2616-4a11-8b8d-eb98c53e2905",
...> "740b6ae8-a631-4a32-9afc-a5548ab99d7e",
...> "d9d60751-b741-4fa6-8524-8f9a066ca037",
...> "83e440d7-6bfa-4b08-92b7-c2ae7fc5c0e9 "
...> )
%{:ok, Ibanity.FinancialInstitutionTransaction{id: "44cd2dc8-163a-4dbe-b544-869e5f84ea54", ...}}
Link to this function
find(request)
Returns {:ok, transaction} 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")
...> |> FinancialInstitutionTransaction.find
%{:ok, Ibanity.FinancialInstitutionTransaction{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_transaction_id)
See find/1
example
Example
iex> %Request{}
...> |> FinancialInstitutionTransaction.find(
...> "ad6fa583-2616-4a11-8b8d-eb98c53e2905",
...> "740b6ae8-a631-4a32-9afc-a5548ab99d7e",
...> "d9d60751-b741-4fa6-8524-8f9a066ca037"
...> )
%{:ok, Ibanity.FinancialInstitutionTransaction{id: "44cd2dc8-163a-4dbe-b544-869e5f84ea54", ...}}
Link to this function
list(request)
Lists transactions 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")
...> |> FinancialInstitutionTransaction.list
%Ibanity.Collection[items: [Ibanity.FinancialInstitutionTransaction{id: "44cd2dc8-163a-4dbe-b544-869e5f84ea54", ...}], ...]
Link to this function
list(request, financial_institution_id, financial_institution_user_id, financial_institution_account_id)
List transactions linked to a financial institution user account
## Example
iex> FinancialInstitutionTransaction.list(
...> "ad6fa583-2616-4a11-8b8d-eb98c53e2905",
...> "740b6ae8-a631-4a32-9afc-a5548ab99d7e",
...> "d9d60751-b741-4fa6-8524-8f9a066ca037"
...> )
%Ibanity.Collection[items: [Ibanity.FinancialInstitutionTransaction{id: "44cd2dc8-163a-4dbe-b544-869e5f84ea54", ...}], ...]
Link to this function
update(request)
Updates an existing financial institution transaction.
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(:financial_institution_transaction_id, "83e440d7-6bfa-4b08-92b7-c2ae7fc5c0e9")
...> |> FinancialInstitutionTransaction.updateReturns {:ok, transaction} if successful, {:error, reason} otherwise
Link to this function
update(request, financial_institution_id, financial_institution_user_id, financial_institution_account_id, financial_institution_transaction_id, attributes)
See update/1
example
Example
iex> attributes = [
...> value_date: "2017-05-22T00:00:00Z",
...> execution_date: "2017-05-25T00:00:00Z",
...> amount: 84.42,
...> remittance_information_type: "NEW SHOES",
...> remittance_information: "unstructured",
...> ...
...> ]
...> FinancialInstitutionTransaction.update(
...> "ad6fa583-2616-4a11-8b8d-eb98c53e2905",
...> "740b6ae8-a631-4a32-9afc-a5548ab99d7e",
...> "d9d60751-b741-4fa6-8524-8f9a066ca037",
...> "b59c4b50-3188-41df-9f69-92777a056fe6",
...> attributes
...> )
{:ok, %Ibanity.FinancialInstitutionTransaction{id: "44cd2dc8-163a-4dbe-b544-869e5f84ea54", ...}}