Programs determine the compliance and commercial terms of Accounts. By default, you have a Commercial Banking program for managing your own funds. If you are lending or managing funds on behalf of your customers, or otherwise engaged in regulated activity, we will work together to create additional Programs for you.
See https://increase.com/documentation/api/programs for the full API reference for this resource.
Summary
Functions
@spec list(Increase.Client.t() | keyword() | nil, map() | keyword(), keyword()) :: {:ok, Increase.Page.t()} | {:error, Increase.Error.t()}
List Programs
Returns a %Increase.Page{} whose data is a list of %__MODULE__. Program{} structs. Page through results with
Increase.Page.auto_paging_stream/1 or Increase.Page.auto_paging_each/2.
GET /programs
@spec retrieve(Increase.Client.t() | keyword() | nil, String.t(), keyword()) :: {:ok, Increase.Programs.Program.t()} | {:error, Increase.Error.t()}
Retrieve a Program
GET /programs/{program_id}