IntraFi Account Enrollments

IntraFi is a network of financial institutions that allows Increase users to sweep funds to multiple banks. This enables accounts to become eligible for additional Federal Deposit Insurance Corporation (FDIC) insurance. An IntraFi Account Enrollment object represents the status of an account in the network. Sweeping an account to IntraFi doesn't affect funds availability.

The IntraFi Account Enrollment object
{ "account_id": "account_in71c4amph0vgo2qllky", "created_at": "2020-01-31T23:59:59Z", "id": "intrafi_account_enrollment_w8l97znzreopkwf2tg75", "idempotency_key": null, "intrafi_id": "01234abcd", "status": "pending_enrolling", "type": "intrafi_account_enrollment" }
Attributes
account_id
string

The identifier of the Increase Account being swept into the network.

created_at
string

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

id
string

The identifier of this enrollment at IntraFi.

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.

intrafi_id
string

The identifier of the account in IntraFi's system. This identifier will be printed on any IntraFi statements or documents.

status
enum

The status of the account in the network. An account takes about one business day to go from pending_enrolling to enrolled.

type
string

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

List IntraFi Account Enrollments
curl \ --url "${INCREASE_URL}/intrafi_account_enrollments?account_id=account_in71c4amph0vgo2qllky" \ -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.

account_id
string

Filter IntraFi Account Enrollments to the one belonging to an account.

status.in
array of strings

Filter IntraFi Account Enrollments for those with the specified status or statuses. For GET requests, this should be encoded as a comma-delimited string, such as ?in=one,two,three.

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
Enroll an account in the IntraFi deposit sweep network
curl -X "POST" \ --url "${INCREASE_URL}/intrafi_account_enrollments" \ -H "Authorization: Bearer ${INCREASE_API_KEY}" \ -H "Content-Type: application/json" \ -d $'{ "account_id": "account_in71c4amph0vgo2qllky", "email_address": "user@example.com" }'
Parameters
account_id
string
Required

The identifier for the account to be added to IntraFi.

email_address
string
Required

The contact email for the account owner, to be shared with IntraFi.

200 character maximum
Get an IntraFi Account Enrollment
curl \ --url "${INCREASE_URL}/intrafi_account_enrollments/intrafi_account_enrollment_w8l97znzreopkwf2tg75" \ -H "Authorization: Bearer ${INCREASE_API_KEY}"
Parameters
intrafi_account_enrollment_id
string
Required

The identifier of the IntraFi Account Enrollment to retrieve.

Unenroll an account from IntraFi
curl -X "POST" \ --url "${INCREASE_URL}/intrafi_account_enrollments/intrafi_account_enrollment_w8l97znzreopkwf2tg75/unenroll" \ -H "Authorization: Bearer ${INCREASE_API_KEY}"
Parameters
intrafi_account_enrollment_id
string
Required

The Identifier of the IntraFi Account Enrollment to remove from IntraFi.