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.

Events

Your application can listen to webhooks about this resource. The events about IntraFi Account Enrollments will have the categories "intrafi_account_enrollment.created" or "intrafi_account_enrollment.updated" .

The IntraFi Account Enrollment object

{
  "account_id": "account_in71c4amph0vgo2qllky",
  "created_at": "2020-01-31T23:59:59Z",
  "email_address": null,
  "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.

More about Accounts.

created_at

string

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

email_address

string

Nullable

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

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

import Increase from 'increase';

const client = new Increase({
  apiKey: process.env['INCREASE_API_KEY'], // This is the default and can be omitted
});

// Automatically fetches more pages as needed.
for await (const intrafiAccountEnrollment of client.intrafiAccountEnrollments.list()) {
  console.log(intrafiAccountEnrollment.id);
}

import os
from increase import Increase

client = Increase(
    api_key=os.environ.get("INCREASE_API_KEY"),  # This is the default and can be omitted
)
page = client.intrafi_account_enrollments.list()
page = page.data[0]
print(page.id)

require "increase"

increase = Increase::Client.new(
  api_key: ENV["INCREASE_API_KEY"] # This is the default and can be omitted
)

page = increase.intrafi_account_enrollments.list

puts(page)

package main

import (
	"context"
	"fmt"
	"os"

	"github.com/Increase/increase-go"
	"github.com/Increase/increase-go/option"
)

func main() {
	client := increase.NewClient(
		option.WithAPIKey(os.Getenv("INCREASE_API_KEY")), // This is the default and can be omitted
	)
	page, err := client.IntrafiAccountEnrollments.List(context.TODO(), increase.IntrafiAccountEnrollmentListParams{})
	if err != nil {
		panic(err.Error())
	}
	fmt.Printf("%+v\n", page)
}

package com.increase.api.example;

import com.increase.api.client.IncreaseClient;
import com.increase.api.client.okhttp.IncreaseOkHttpClient;
import com.increase.api.models.intrafiaccountenrollments.IntrafiAccountEnrollmentListPage;
import com.increase.api.models.intrafiaccountenrollments.IntrafiAccountEnrollmentListParams;

public final class Main {
    private Main() {}

    public static void main(String[] args) {
        IncreaseClient client = IncreaseOkHttpClient.fromEnv();

        IntrafiAccountEnrollmentListPage page = client.intrafiAccountEnrollments().list();
    }
}

package com.increase.api.example

import com.increase.api.client.IncreaseClient
import com.increase.api.client.okhttp.IncreaseOkHttpClient
import com.increase.api.models.intrafiaccountenrollments.IntrafiAccountEnrollmentListPage
import com.increase.api.models.intrafiaccountenrollments.IntrafiAccountEnrollmentListParams

fun main() {
    val client: IncreaseClient = IncreaseOkHttpClient.fromEnv()

    val page: IntrafiAccountEnrollmentListPage = client.intrafiAccountEnrollments().list()
}

<?php

require_once dirname(__DIR__) . '/vendor/autoload.php';

use Increase\Client;
use Increase\Core\Exceptions\APIException;

$client = new Client(apiKey: getenv('INCREASE_API_KEY'));

try {
  $page = $client->intrafiAccountEnrollments->list(
    accountID: 'account_id',
    cursor: 'cursor',
    idempotencyKey: 'x',
    limit: 1,
    status: ['in' => ['pending_enrolling']],
  );

  var_dump($page);
} catch (APIException $e) {
  echo $e->getMessage();
}

using System;
using Increase.Api;
using Increase.Api.Models.IntrafiAccountEnrollments;

IncreaseClient client = new();

IntrafiAccountEnrollmentListParams parameters = new();

var page = await client.IntrafiAccountEnrollments.List(parameters);
await foreach (var item in page.Paginate())
{
    Console.WriteLine(item);
}

Returns a list response :

{
  "data": [
    { /* IntraFi Account Enrollment object */ },
    { /* IntraFi Account Enrollment object */ }
    /* ... */
  ],
  "next_cursor": "v57w5d",
}

Parameters

account_id

string

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

More about Accounts.

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.

Between 1 and 200 characters

cursor

string

limit

integer

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"
  }'

import Increase from 'increase';

const client = new Increase({
  apiKey: process.env['INCREASE_API_KEY'], // This is the default and can be omitted
});

const intrafiAccountEnrollment = await client.intrafiAccountEnrollments.create({
  account_id: 'account_in71c4amph0vgo2qllky',
  email_address: 'user@example.com',
});

console.log(intrafiAccountEnrollment.id);

import os
from increase import Increase

client = Increase(
    api_key=os.environ.get("INCREASE_API_KEY"),  # This is the default and can be omitted
)
intrafi_account_enrollment = client.intrafi_account_enrollments.create(
    account_id="account_in71c4amph0vgo2qllky",
    email_address="user@example.com",
)
print(intrafi_account_enrollment.id)

require "increase"

increase = Increase::Client.new(
  api_key: ENV["INCREASE_API_KEY"] # This is the default and can be omitted
)

intrafi_account_enrollment = increase.intrafi_account_enrollments.create(
  account_id: "account_in71c4amph0vgo2qllky",
  email_address: "user@example.com"
)

puts(intrafi_account_enrollment)

package main

import (
	"context"
	"fmt"
	"os"

	"github.com/Increase/increase-go"
	"github.com/Increase/increase-go/option"
)

func main() {
	client := increase.NewClient(
		option.WithAPIKey(os.Getenv("INCREASE_API_KEY")), // This is the default and can be omitted
	)
	intrafiAccountEnrollment, err := client.IntrafiAccountEnrollments.New(context.TODO(), increase.IntrafiAccountEnrollmentNewParams{
		AccountID:    increase.F("account_in71c4amph0vgo2qllky"),
		EmailAddress: increase.F("user@example.com"),
	})
	if err != nil {
		panic(err.Error())
	}
	fmt.Printf("%+v\n", intrafiAccountEnrollment.ID)
}

package com.increase.api.example;

import com.increase.api.client.IncreaseClient;
import com.increase.api.client.okhttp.IncreaseOkHttpClient;
import com.increase.api.models.intrafiaccountenrollments.IntrafiAccountEnrollment;
import com.increase.api.models.intrafiaccountenrollments.IntrafiAccountEnrollmentCreateParams;

public final class Main {
    private Main() {}

    public static void main(String[] args) {
        IncreaseClient client = IncreaseOkHttpClient.fromEnv();

        IntrafiAccountEnrollmentCreateParams params = IntrafiAccountEnrollmentCreateParams.builder()
            .accountId("account_in71c4amph0vgo2qllky")
            .emailAddress("user@example.com")
            .build();
        IntrafiAccountEnrollment intrafiAccountEnrollment = client.intrafiAccountEnrollments().create(params);
    }
}

package com.increase.api.example

import com.increase.api.client.IncreaseClient
import com.increase.api.client.okhttp.IncreaseOkHttpClient
import com.increase.api.models.intrafiaccountenrollments.IntrafiAccountEnrollment
import com.increase.api.models.intrafiaccountenrollments.IntrafiAccountEnrollmentCreateParams

fun main() {
    val client: IncreaseClient = IncreaseOkHttpClient.fromEnv()

    val params: IntrafiAccountEnrollmentCreateParams = IntrafiAccountEnrollmentCreateParams.builder()
        .accountId("account_in71c4amph0vgo2qllky")
        .emailAddress("user@example.com")
        .build()
    val intrafiAccountEnrollment: IntrafiAccountEnrollment = client.intrafiAccountEnrollments().create(params)
}

<?php

require_once dirname(__DIR__) . '/vendor/autoload.php';

use Increase\Client;
use Increase\Core\Exceptions\APIException;

$client = new Client(apiKey: getenv('INCREASE_API_KEY'));

try {
  $intrafiAccountEnrollment = $client->intrafiAccountEnrollments->create(
    accountID: 'account_in71c4amph0vgo2qllky', emailAddress: 'user@example.com'
  );

  var_dump($intrafiAccountEnrollment);
} catch (APIException $e) {
  echo $e->getMessage();
}

using System;
using Increase.Api;
using Increase.Api.Models.IntrafiAccountEnrollments;

IncreaseClient client = new();

IntrafiAccountEnrollmentCreateParams parameters = new()
{
    AccountID = "account_in71c4amph0vgo2qllky",
    EmailAddress = "user@example.com",
};

var intrafiAccountEnrollment = await client.IntrafiAccountEnrollments.Create(parameters);

Console.WriteLine(intrafiAccountEnrollment);

Parameters

account_id

string

Required

The identifier for the account to be added to IntraFi.

More about Accounts.

email_address

string

Required

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

Between 1 and 50 characters

Get an IntraFi Account Enrollment

curl \
  --url "${INCREASE_URL}/intrafi_account_enrollments/intrafi_account_enrollment_w8l97znzreopkwf2tg75" \
  -H "Authorization: Bearer ${INCREASE_API_KEY}"

import Increase from 'increase';

const client = new Increase({
  apiKey: process.env['INCREASE_API_KEY'], // This is the default and can be omitted
});

const intrafiAccountEnrollment = await client.intrafiAccountEnrollments.retrieve(
  'intrafi_account_enrollment_w8l97znzreopkwf2tg75',
);

console.log(intrafiAccountEnrollment.id);

import os
from increase import Increase

client = Increase(
    api_key=os.environ.get("INCREASE_API_KEY"),  # This is the default and can be omitted
)
intrafi_account_enrollment = client.intrafi_account_enrollments.retrieve(
    "intrafi_account_enrollment_w8l97znzreopkwf2tg75",
)
print(intrafi_account_enrollment.id)

require "increase"

increase = Increase::Client.new(
  api_key: ENV["INCREASE_API_KEY"] # This is the default and can be omitted
)

intrafi_account_enrollment = increase.intrafi_account_enrollments.retrieve("intrafi_account_enrollment_w8l97znzreopkwf2tg75")

puts(intrafi_account_enrollment)

package main

import (
	"context"
	"fmt"
	"os"

	"github.com/Increase/increase-go"
	"github.com/Increase/increase-go/option"
)

func main() {
	client := increase.NewClient(
		option.WithAPIKey(os.Getenv("INCREASE_API_KEY")), // This is the default and can be omitted
	)
	intrafiAccountEnrollment, err := client.IntrafiAccountEnrollments.Get(context.TODO(), "intrafi_account_enrollment_w8l97znzreopkwf2tg75")
	if err != nil {
		panic(err.Error())
	}
	fmt.Printf("%+v\n", intrafiAccountEnrollment.ID)
}

package com.increase.api.example;

import com.increase.api.client.IncreaseClient;
import com.increase.api.client.okhttp.IncreaseOkHttpClient;
import com.increase.api.models.intrafiaccountenrollments.IntrafiAccountEnrollment;
import com.increase.api.models.intrafiaccountenrollments.IntrafiAccountEnrollmentRetrieveParams;

public final class Main {
    private Main() {}

    public static void main(String[] args) {
        IncreaseClient client = IncreaseOkHttpClient.fromEnv();

        IntrafiAccountEnrollment intrafiAccountEnrollment = client.intrafiAccountEnrollments().retrieve("intrafi_account_enrollment_w8l97znzreopkwf2tg75");
    }
}

package com.increase.api.example

import com.increase.api.client.IncreaseClient
import com.increase.api.client.okhttp.IncreaseOkHttpClient
import com.increase.api.models.intrafiaccountenrollments.IntrafiAccountEnrollment
import com.increase.api.models.intrafiaccountenrollments.IntrafiAccountEnrollmentRetrieveParams

fun main() {
    val client: IncreaseClient = IncreaseOkHttpClient.fromEnv()

    val intrafiAccountEnrollment: IntrafiAccountEnrollment = client.intrafiAccountEnrollments().retrieve("intrafi_account_enrollment_w8l97znzreopkwf2tg75")
}

<?php

require_once dirname(__DIR__) . '/vendor/autoload.php';

use Increase\Client;
use Increase\Core\Exceptions\APIException;

$client = new Client(apiKey: getenv('INCREASE_API_KEY'));

try {
  $intrafiAccountEnrollment = $client->intrafiAccountEnrollments->retrieve(
    'intrafi_account_enrollment_w8l97znzreopkwf2tg75'
  );

  var_dump($intrafiAccountEnrollment);
} catch (APIException $e) {
  echo $e->getMessage();
}

using System;
using Increase.Api;
using Increase.Api.Models.IntrafiAccountEnrollments;

IncreaseClient client = new();

IntrafiAccountEnrollmentRetrieveParams parameters = new()
{
    IntrafiAccountEnrollmentID = "intrafi_account_enrollment_w8l97znzreopkwf2tg75",
};

var intrafiAccountEnrollment = await client.IntrafiAccountEnrollments.Retrieve(parameters);

Console.WriteLine(intrafiAccountEnrollment);

Parameters

intrafi_account_enrollment_id

string

Required

The identifier of the IntraFi Account Enrollment to retrieve.

More about IntraFi Account Enrollments.

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

import Increase from 'increase';

const client = new Increase({
  apiKey: process.env['INCREASE_API_KEY'], // This is the default and can be omitted
});

const intrafiAccountEnrollment = await client.intrafiAccountEnrollments.unenroll(
  'intrafi_account_enrollment_w8l97znzreopkwf2tg75',
);

console.log(intrafiAccountEnrollment.id);

import os
from increase import Increase

client = Increase(
    api_key=os.environ.get("INCREASE_API_KEY"),  # This is the default and can be omitted
)
intrafi_account_enrollment = client.intrafi_account_enrollments.unenroll(
    "intrafi_account_enrollment_w8l97znzreopkwf2tg75",
)
print(intrafi_account_enrollment.id)

require "increase"

increase = Increase::Client.new(
  api_key: ENV["INCREASE_API_KEY"] # This is the default and can be omitted
)

intrafi_account_enrollment = increase.intrafi_account_enrollments.unenroll("intrafi_account_enrollment_w8l97znzreopkwf2tg75")

puts(intrafi_account_enrollment)

package main

import (
	"context"
	"fmt"
	"os"

	"github.com/Increase/increase-go"
	"github.com/Increase/increase-go/option"
)

func main() {
	client := increase.NewClient(
		option.WithAPIKey(os.Getenv("INCREASE_API_KEY")), // This is the default and can be omitted
	)
	intrafiAccountEnrollment, err := client.IntrafiAccountEnrollments.Unenroll(context.TODO(), "intrafi_account_enrollment_w8l97znzreopkwf2tg75")
	if err != nil {
		panic(err.Error())
	}
	fmt.Printf("%+v\n", intrafiAccountEnrollment.ID)
}

package com.increase.api.example;

import com.increase.api.client.IncreaseClient;
import com.increase.api.client.okhttp.IncreaseOkHttpClient;
import com.increase.api.models.intrafiaccountenrollments.IntrafiAccountEnrollment;
import com.increase.api.models.intrafiaccountenrollments.IntrafiAccountEnrollmentUnenrollParams;

public final class Main {
    private Main() {}

    public static void main(String[] args) {
        IncreaseClient client = IncreaseOkHttpClient.fromEnv();

        IntrafiAccountEnrollment intrafiAccountEnrollment = client.intrafiAccountEnrollments().unenroll("intrafi_account_enrollment_w8l97znzreopkwf2tg75");
    }
}

package com.increase.api.example

import com.increase.api.client.IncreaseClient
import com.increase.api.client.okhttp.IncreaseOkHttpClient
import com.increase.api.models.intrafiaccountenrollments.IntrafiAccountEnrollment
import com.increase.api.models.intrafiaccountenrollments.IntrafiAccountEnrollmentUnenrollParams

fun main() {
    val client: IncreaseClient = IncreaseOkHttpClient.fromEnv()

    val intrafiAccountEnrollment: IntrafiAccountEnrollment = client.intrafiAccountEnrollments().unenroll("intrafi_account_enrollment_w8l97znzreopkwf2tg75")
}

<?php

require_once dirname(__DIR__) . '/vendor/autoload.php';

use Increase\Client;
use Increase\Core\Exceptions\APIException;

$client = new Client(apiKey: getenv('INCREASE_API_KEY'));

try {
  $intrafiAccountEnrollment = $client->intrafiAccountEnrollments->unenroll(
    'intrafi_account_enrollment_w8l97znzreopkwf2tg75'
  );

  var_dump($intrafiAccountEnrollment);
} catch (APIException $e) {
  echo $e->getMessage();
}

using System;
using Increase.Api;
using Increase.Api.Models.IntrafiAccountEnrollments;

IncreaseClient client = new();

IntrafiAccountEnrollmentUnenrollParams parameters = new()
{
    IntrafiAccountEnrollmentID = "intrafi_account_enrollment_w8l97znzreopkwf2tg75",
};

var intrafiAccountEnrollment = await client.IntrafiAccountEnrollments.Unenroll(parameters);

Console.WriteLine(intrafiAccountEnrollment);

Parameters

intrafi_account_enrollment_id

string

Required

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

More about IntraFi Account Enrollments.