increase-test
POST/simulations/programs

Sandbox: Create a Program

Simulates a Program being created in your group. By default, your group has one program called Commercial Banking. Note that when your group operates more than one program, program_id is a required field when creating accounts.

  • IdempotentThe SDK sends Idempotency-Key, so a retried request is only applied once.

5 body fields
bankstringoptional
The bank for the program's accounts, defaults to First Internet Bank.
Allowed:core_bankfirst_internet_bankgrasshopper_bankincrease_bank
lending_maximum_extendable_creditintegeroptional
The maximum extendable credit of the program being added.
loan_accounts_require_loan_offersbooleanoptional
Whether opening a loan Account under this Program requires an accepted Loan Offer. Requires `lending_maximum_extendable_credit`. Defaults to `false`.
namestringrequired
The name of the program being added.
reserve_account_idstringoptional
The identifier of the Account the Program should be added to.

3 status codes
200Program
bankstringrequired
The Bank the Program is with.
Allowed:core_bankfirst_internet_bankgrasshopper_bankincrease_bank
billing_account_idstringrequired
The Program billing account.
created_atstringrequired
The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) time at which the Program was created.
default_digital_card_profile_idstringrequired
The default configuration for digital cards attached to this Program.
idstringrequired
The Program identifier.
interest_ratestringrequired
The Interest Rate currently being earned on the accounts in this program, as a string containing a decimal number. For example, a 1% interest rate would be represented as "0.01".
lendingobjectrequired
The lending details for the program.
namestringrequired
The name of the Program.
typestringrequired
A constant representing the object's type. For this resource it will always be `program`.
Allowed:program
updated_atstringrequired
The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) time at which the Program was last updated.
4XXError
5XXError