ClearBank.EmbeddedBanking.Interest (ClearBank v1.0.0)

Interest product configuration for embedded banking savings accounts.

Configure which interest product applies to a savings account, and retrieve available products to display rates to your customers.

Examples

{:ok, products} = ClearBank.EmbeddedBanking.Interest.list_products(client)

{:ok, _} = ClearBank.EmbeddedBanking.Interest.configure(client, "savings-acct-uuid", %{
  product_id: "prod-uuid"
})

Summary

Functions

configure(client, account_id, params)

Configures an interest product for a savings account.

list_products(client)

Returns all available interest products configured for your institution.

Functions

configure(client, account_id, params)

@spec configure(ClearBank.Client.t(), String.t(), map()) :: ClearBank.HTTP.result()

Configures an interest product for a savings account.

Required params

:product_id - UUID of the interest product to apply

list_products(client)

@spec list_products(ClearBank.Client.t()) :: ClearBank.HTTP.result()

Returns all available interest products configured for your institution.