Ibanity.PontoConnect.FinancialInstitution (ibanity v1.0.0)
Link to this section Summary
Link to this section Functions
Link to this function
find_organization(request_or_token, id)
Find organization's financial institution by id
Takes a Ibanity.PontoConnect.Token
, or a Ibanity.Request
with set :token
as first argument, and a Financial Institution
ID as second argument.
examples
Examples
With token
iex> token
...> |> Ibanity.PontoConnect.FinancialInstitution.find_organization("953934eb-229a-4fd2-8675-07794078cc7d")
{:ok, %Ibanity.PontoConnect.FinancialInstitution{id: "953934eb-229a-4fd2-8675-07794078cc7d", name: "Fake Bank"}}
With request
iex> token
...> |> Ibanity.Request.token()
...> |> Ibanity.Request.application(:my_application)
...> |> Ibanity.PontoConnect.FinancialInstitution.find_organization("953934eb-229a-4fd2-8675-07794078cc7d")
{:ok, %Ibanity.PontoConnect.FinancialInstitution{id: "953934eb-229a-4fd2-8675-07794078cc7d", name: "Fake Bank"}}
Error
iex> token
...> |> Ibanity.PontoConnect.FinancialInstitution.find_organization("does-not-exist")
{:error,
[
%{
"code" => "resourceNotFound",
"detail" => "The requested resource was not found.",
"meta" => %{
"requestId" => "00077F00000184847F0000011F4066E44223327005A",
"resource" => "financialInstitution"
}
}
]}
Link to this function
find_public(request \\ %Request{}, id)
Find public financial institution by id
examples
Examples
For :default
application
iex> Ibanity.PontoConnect.FinancialInstitution.find_public("953934eb-229a-4fd2-8675-07794078cc7d")
{:ok,
%Ibanity.PontoConnect.FinancialInstitution{
id: "953934eb-229a-4fd2-8675-07794078cc7d",
name: "Fake Bank",
status: "stable",
deprecated: nil,
country: "BE",
bic: "NBBEBEBB203",
bulk_payments_enabled: nil,
bulk_payments_product_types: nil,
future_dated_payments_allowed: nil,
logo_url: nil,
maintenance_from: nil,
maintenance_to: nil,
maintenance_type: nil,
payments_enabled: nil,
payments_product_types: nil,
periodic_payments_enabled: nil,
periodic_payments_product_types: nil,
primary_color: nil,
secondary_color: nil,
shared_brand_name: nil,
shared_brand_reference: nil,
time_zone: nil
}}
With request
iex> Ibanity.Request.id("953934eb-229a-4fd2-8675-07794078cc7d")
...> Ibanity.Request.application(:my_application)
...> |> Ibanity.PontoConnect.FinancialInstitution.find_public()
{:ok,
%Ibanity.PontoConnect.FinancialInstitution{
id: "953934eb-229a-4fd2-8675-07794078cc7d",
name: "Fake Bank",
status: "stable",
deprecated: nil,
country: "BE",
bic: "NBBEBEBB203",
bulk_payments_enabled: nil,
bulk_payments_product_types: nil,
future_dated_payments_allowed: nil,
logo_url: nil,
maintenance_from: nil,
maintenance_to: nil,
maintenance_type: nil,
payments_enabled: nil,
payments_product_types: nil,
periodic_payments_enabled: nil,
periodic_payments_product_types: nil,
primary_color: nil,
secondary_color: nil,
shared_brand_name: nil,
shared_brand_reference: nil,
time_zone: nil
}}
Link to this function
list_organization(request)
List organization's financial institutions
Takes a Ibanity.PontoConnect.Token
, or a Ibanity.Request
with set :token
as argument.
examples
Examples
With token
iex> token |> Ibanity.PontoConnect.FinancialInstitution.list_organization()
{:ok, %Ibanity.Collection{
items: [%Ibanity.PontoConnect.FinancialInstitution{}]
}}
With request
iex> token
...> |> Ibanity.Request.token()
...> |> Ibanity.PontoConnect.FinancialInstitutions.list_organizations()
{:ok, %Ibanity.Collection{
items: [%Ibanity.PontoConnect.FinancialInstitution{}]
}}
Error
iex> invalid_token |> Ibanity.PontoConnect.FinancialInstitution.list_organization()
{:error,
[
%{
"code" => "invalidAccessToken",
"detail" => "Your access token is invalid.",
"meta" => %{"requestId" => "00077F000001D3A87F0000011F4066E43AFD1900051"}
}
]}
Link to this function
list_public(request \\ %Request{})
List public financial institutions
examples
Examples
For :default
application
iex> Ibanity.PontoConnect.FinancialInstitution.list_public()
%Ibanity.Collection{
items: [
%Ibanity.PontoConnect.FinancialInstitution{},
%Ibanity.PontoConnect.FinancialInstitution{},
%Ibanity.PontoConnect.FinancialInstitution{},
%Ibanity.PontoConnect.FinancialInstitution{}
]
}
With request
iex> Ibanity.Request.limit(1)
...> |> Ibanity.Request.application(:my_application)
...> |> Ibanity.PontoConnect.FinancialInstitution.list_public()
%Ibanity.Collection{
items: [
%Ibanity.PontoConnect.FinancialInstitution{}
],
page_limit: 1,
after_cursor: "953934eb-229a-4fd2-8675-07794078cc7d",
first_link: "https://api.ibanity.com/ponto-connect/financial-institutions?page[limit]=1",
next_link: "https://api.ibanity.com/ponto-connect/financial-institutions?page[after]=953934eb-229a-4fd2-8675-07794078cc7d&page[limit]=1",
}