API Reference — Increase

Certain institutions may be excluded per Entity when sweeping funds into the IntraFi network. This is useful when an Entity already has deposits at a particular bank, and does not want to sweep additional funds to it. It may take 5 business days for an exclusion to be processed.

The IntraFi Exclusion object

{
  "bank_name": "Example Bank",
  "created_at": "2020-01-31T23:59:59Z",
  "entity_id": "entity_n8y8tnk2p9339ti393yi",
  "excluded_at": "2020-02-01T23:59:59+00:00",
  "fdic_certificate_number": "314159",
  "id": "intrafi_exclusion_ygfqduuzpau3jqof6jyh",
  "idempotency_key": null,
  "status": "completed",
  "submitted_at": "2020-02-01T00:59:59+00:00",
  "type": "intrafi_exclusion"
}

Attributes

bank_name

string

The name of the excluded institution.

created_at

string

The ISO 8601 date and time at which the exclusion was created.

entity_id

string

The entity for which this institution is excluded.

excluded_at

string

Nullable

When this was exclusion was confirmed by IntraFi.

fdic_certificate_number

string

Nullable

The Federal Deposit Insurance Corporation's certificate number for the institution.

string

The identifier of this exclusion request.

idempotency_key

string

Nullable

The idempotency key you chose for this object. This value is unique across Increase and is used to ensure that a request is only processed once. Learn more about idempotency.

status

enum

The status of the exclusion request.

submitted_at

string

Nullable

When this was exclusion was submitted to IntraFi by Increase.

type

string

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

List IntraFi Exclusions

curl \
  --url "${INCREASE_URL}/intrafi_exclusions?entity_id=entity_n8y8tnk2p9339ti393yi" \
  -H "Authorization: Bearer ${INCREASE_API_KEY}"

Parameters

cursor

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.

entity_id

string

Filter IntraFi Exclusions for those belonging to the specified Entity.

idempotency_key

string

Filter records to the one with the specified idempotency_key you chose for that object. This value is unique across Increase and is used to ensure that a request is only processed once. Learn more about idempotency.

200 character maximum

Create an IntraFi Exclusion

curl -X "POST" \
  --url "${INCREASE_URL}/intrafi_exclusions" \
  -H "Authorization: Bearer ${INCREASE_API_KEY}" \
  -H "Content-Type: application/json" \
  -d $'{
    "bank_name": "Example Bank",
    "entity_id": "entity_n8y8tnk2p9339ti393yi"
  }'

Parameters

bank_name

string

Required

The name of the financial institution to be excluded.

200 character maximum

entity_id

string

Required

The identifier of the Entity whose deposits will be excluded.

Get an IntraFi Exclusion

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

Parameters

intrafi_exclusion_id

string

Required

The identifier of the IntraFi Exclusion to retrieve.

Archive an IntraFi Exclusion

curl -X "POST" \
  --url "${INCREASE_URL}/intrafi_exclusions/intrafi_exclusion_ygfqduuzpau3jqof6jyh/archive" \
  -H "Authorization: Bearer ${INCREASE_API_KEY}"

Parameters

intrafi_exclusion_id

string

Required

The identifier of the IntraFi Exclusion request to archive. It may take 5 business days for an exclusion removal to be processed. Removing an exclusion does not guarantee that funds will be swept to the previously-excluded bank.