Sandbox: Create a Program

Changed on

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.

post/simulations/programs

Request

  • Base URL
    https://api.increase.com
  • URL
    https://api.increase.com/simulations/programs
  • Auth
    HTTP bearer

Request body

bank'core_bank' | 'first_internet_bank' | 'grasshopper_bank' | 'increase_bank'

The bank for the program's accounts, defaults to Increase Bank.

lending_maximum_extendable_creditinteger

The maximum extendable credit of the program being added.

loan_accounts_require_loan_offersboolean

Whether opening a loan Account under this Program requires an accepted Loan Offer. Requires lending_maximum_extendable_credit. Defaults to false.

namestring required

The name of the program being added.

reserve_account_idstring

The identifier of the Account the Program should be added to.

Example request

{
  "name": "For Benefit Of"
}

Response

Program

bank'core_bank' | 'first_internet_bank' | 'grasshopper_bank' | 'increase_bank' required

The Bank the Program is with.

billing_account_idstring nullable required

The Program billing account.

created_atstring date-time required

The ISO 8601 time at which the Program was created.

default_digital_card_profile_idstring nullable required

The default configuration for digital cards attached to this Program.

idstring required

The Program identifier.

interest_ratestring required

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".

namestring required

The name of the Program.

type'program' required

A constant representing the object's type. For this resource it will always be program.

updated_atstring date-time required

The ISO 8601 time at which the Program was last updated.

Example response

{
  "bank": "first_internet_bank",
  "billing_account_id": null,
  "created_at": "2020-01-31T23:59:59Z",
  "default_digital_card_profile_id": null,
  "id": "program_i2v2os4mwza1oetokh9i",
  "interest_rate": "0.01",
  "lending": null,
  "name": "Commercial Banking",
  "type": "program",
  "updated_at": "2020-01-31T23:59:59Z"
}

Changes

  • b963d699f11fRevision changes
    • info

      added the new optional request property

  • df2b1ead4c49Revision changes
    • warning

      added the new increase_bank enum value to the response property for the response status

    • info

      added the new increase_bank enum value to the request property