Private API Reference

Intuit Accounts

An account at Increase that the end user has authorized your application to access. The shape mirrors the Financial Data Exchange (FDX) deposit account descriptor. Balances are not included here; use the get-account endpoint for those.

List Intuit accounts

List the accounts that the end user has authorized your application to access. Each entry is an IntuitAccount carrying the account’s display number, status, type, and currency. Use the returned accountId to fetch balances, transactions, contact information, or payment networks for an individual account.

curl \
  --url "${INCREASE_URL}/fdx/intuit/accounts?offset=qwer123454q2f&limit=100" \
  -H "Authorization: Bearer ${INCREASE_API_KEY}"

Parameters

offset

string

Return the page of entries after this one.

limit

integer

Limit the size of the list that is returned. The default (and maximum) is 100 objects.

Get Intuit account

Retrieve a single authorized account along with its current and available balances. The response includes the same descriptor fields returned by the list endpoint plus currentBalance and availableBalance, both denominated in the account’s currency.

curl \
  --url "${INCREASE_URL}/fdx/intuit/accounts/account_in71c4amph0vgo2qllky" \
  -H "Authorization: Bearer ${INCREASE_API_KEY}"

Returns a Intuit Account Balance object:

{
  "accountCategory": "DEPOSIT_ACCOUNT",
  "accountId": "account_in71c4amph0vgo2qllky",
  "accountNumberDisplay": "0000",
  "accountType": "CHECKING",
  "availableBalance": 100,
  "balanceAsOf": "2020-01-31T23:59:59Z",
  "balanceType": "ASSET",
  "currency": {
    "currencyCode": "USD"
  },
  "currentBalance": 100,
  "description": "",
  "lineOfBusiness": "",
  "nickname": "My Checking Account",
  "productName": "Checking",
  "routingTransitNumber": "021000021",
  "status": "OPEN"
}

Parameters

account_id

string

Required

The identifier of the Account to retrieve.

More about Accounts.

Get Intuit account contact

Return the contact information associated with an account: legal holders (with their name and relationship to the account), mailing addresses, telephone numbers, and email addresses. Joint accounts have multiple holders; business accounts have a single holder with relationship of BUSINESS.

curl \
  --url "${INCREASE_URL}/fdx/intuit/accounts/account_in71c4amph0vgo2qllky/contact" \
  -H "Authorization: Bearer ${INCREASE_API_KEY}"

Returns a Intuit Account Contact Information object:

{
  "addresses": [
    {
      "city": "New York",
      "country": "US",
      "line1": "33 Liberty Street",
      "postalCode": "10045",
      "region": "NY"
    }
  ],
  "emails": [
    "support@increase.com"
  ],
  "holders": [
    {
      "name": {
        "first": "Jane",
        "last": "Doe"
      },
      "relationship": "PRIMARY"
    }
  ],
  "telephones": [
    {
      "country": "1",
      "number": "8882988865",
      "type": "BUSINESS"
    }
  ]
}

Parameters

account_id

string

Required

The identifier of the Account to retrieve.

More about Accounts.

List Intuit payment networks for an account

List the payment networks the account is reachable on along with the routing number (bankId) and account number (identifier) to use for each. The end user must have granted account-number access for any results to be returned. Each entry indicates whether credits (transferIn) and debits (transferOut) are supported today.

curl \
  --url "${INCREASE_URL}/fdx/intuit/accounts/account_in71c4amph0vgo2qllky/payment-networks?offset=qwer123454q2f&limit=100" \
  -H "Authorization: Bearer ${INCREASE_API_KEY}"

Parameters

account_id

string

Required

The identifier of the Account to retrieve.

More about Accounts.

offset

string

Return the page of entries after this one.

limit

integer

Limit the size of the list that is returned. The default (and maximum) is 100 objects.