Get an IntraFi Balance

Changed on

Returns the IntraFi balance for the given account. IntraFi may sweep funds to multiple banks. This endpoint will include both the total balance and the amount swept to each institution.

get/accounts/{account_id}/intrafi_balance

Request

  • Base URL
    https://api.increase.com
  • URL
    https://api.increase.com/accounts/{account_id}/intrafi_balance
  • Auth
    HTTP bearer

Path parameters

account_idstring required

The identifier of the Account to get balances for.

Response

IntraFi Balance

currency'USD' required

The ISO 4217 code for the account currency.

effective_datestring date required

The date this balance reflects.

total_balanceinteger required

The total balance, in minor units of currency. Increase reports this balance to IntraFi daily.

type'intrafi_balance' required

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

Example response

{
  "balances": [
    {
      "balance": 1750,
      "bank": "Example Bank",
      "bank_location": {
        "city": "New York",
        "state": "NY"
      },
      "fdic_certificate_number": "314159"
    }
  ],
  "currency": "USD",
  "effective_date": "2020-01-31",
  "total_balance": 1750,
  "type": "intrafi_balance"
}

Changes

  • d410a6abb15dRevision changes
    • info

      api operation id get_intrafi_balance removed and replaced with get_an_intrafi_balance

  • 64a92a8cc343Revision changes
    • info

      added subschema #8 subschema #10 to the /// response property anyOf list for the response status

    • info

      added subschema #8 subschema #10 to the /// response property anyOf list for the response status

    • info

      removed subschema #8 subschema #10 from the /// response property anyOf list for the response status

    • info

      removed subschema #8 subschema #10 from the /// response property anyOf list for the response status