IntraFi Exclusions

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.

Events

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

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

Nullable

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.

More about Entities.

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

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 intrafiExclusion of client.intrafiExclusions.list()) {
  console.log(intrafiExclusion.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_exclusions.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_exclusions.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.IntrafiExclusions.List(context.TODO(), increase.IntrafiExclusionListParams{})
	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.intrafiexclusions.IntrafiExclusionListPage;
import com.increase.api.models.intrafiexclusions.IntrafiExclusionListParams;

public final class Main {
    private Main() {}

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

        IntrafiExclusionListPage page = client.intrafiExclusions().list();
    }
}

package com.increase.api.example

import com.increase.api.client.IncreaseClient
import com.increase.api.client.okhttp.IncreaseOkHttpClient
import com.increase.api.models.intrafiexclusions.IntrafiExclusionListPage
import com.increase.api.models.intrafiexclusions.IntrafiExclusionListParams

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

    val page: IntrafiExclusionListPage = client.intrafiExclusions().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->intrafiExclusions->list(
    cursor: 'cursor', entityID: 'entity_id', idempotencyKey: 'x', limit: 1
  );

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

using System;
using Increase.Api;
using Increase.Api.Models.IntrafiExclusions;

IncreaseClient client = new();

IntrafiExclusionListParams parameters = new();

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

Returns a list response :

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

Parameters

entity_id

string

Filter IntraFi Exclusions for those belonging to the specified Entity.

More about Entities.

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

Create an IntraFi Exclusion

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

import Increase from 'increase';

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

const intrafiExclusion = await client.intrafiExclusions.create({
  entity_id: 'entity_n8y8tnk2p9339ti393yi',
  fdic_certificate_number: '314159',
});

console.log(intrafiExclusion.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_exclusion = client.intrafi_exclusions.create(
    entity_id="entity_n8y8tnk2p9339ti393yi",
    fdic_certificate_number="314159",
)
print(intrafi_exclusion.id)

require "increase"

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

intrafi_exclusion = increase.intrafi_exclusions.create(
  entity_id: "entity_n8y8tnk2p9339ti393yi",
  fdic_certificate_number: "314159"
)

puts(intrafi_exclusion)

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
	)
	intrafiExclusion, err := client.IntrafiExclusions.New(context.TODO(), increase.IntrafiExclusionNewParams{
		EntityID:              increase.F("entity_n8y8tnk2p9339ti393yi"),
		FdicCertificateNumber: increase.F("314159"),
	})
	if err != nil {
		panic(err.Error())
	}
	fmt.Printf("%+v\n", intrafiExclusion.ID)
}

package com.increase.api.example;

import com.increase.api.client.IncreaseClient;
import com.increase.api.client.okhttp.IncreaseOkHttpClient;
import com.increase.api.models.intrafiexclusions.IntrafiExclusion;
import com.increase.api.models.intrafiexclusions.IntrafiExclusionCreateParams;

public final class Main {
    private Main() {}

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

        IntrafiExclusionCreateParams params = IntrafiExclusionCreateParams.builder()
            .entityId("entity_n8y8tnk2p9339ti393yi")
            .fdicCertificateNumber("314159")
            .build();
        IntrafiExclusion intrafiExclusion = client.intrafiExclusions().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.intrafiexclusions.IntrafiExclusion
import com.increase.api.models.intrafiexclusions.IntrafiExclusionCreateParams

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

    val params: IntrafiExclusionCreateParams = IntrafiExclusionCreateParams.builder()
        .entityId("entity_n8y8tnk2p9339ti393yi")
        .fdicCertificateNumber("314159")
        .build()
    val intrafiExclusion: IntrafiExclusion = client.intrafiExclusions().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 {
  $intrafiExclusion = $client->intrafiExclusions->create(
    entityID: 'entity_n8y8tnk2p9339ti393yi', fdicCertificateNumber: '314159'
  );

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

using System;
using Increase.Api;
using Increase.Api.Models.IntrafiExclusions;

IncreaseClient client = new();

IntrafiExclusionCreateParams parameters = new()
{
    EntityID = "entity_n8y8tnk2p9339ti393yi",
    FdicCertificateNumber = "314159",
};

var intrafiExclusion = await client.IntrafiExclusions.Create(parameters);

Console.WriteLine(intrafiExclusion);

Parameters

entity_id

string

Required

The identifier of the Entity whose deposits will be excluded.

More about Entities.

fdic_certificate_number

string

Required

The FDIC certificate number of the financial institution to be excluded. An FDIC certificate number uniquely identifies a financial institution, and is different than a routing number. To find one, we recommend searching by Bank Name using the FDIC’s bankfind tool.

Between 1 and 200 characters

Get an IntraFi Exclusion

curl \
  --url "${INCREASE_URL}/intrafi_exclusions/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
});

const intrafiExclusion = await client.intrafiExclusions.retrieve('account_in71c4amph0vgo2qllky');

console.log(intrafiExclusion.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_exclusion = client.intrafi_exclusions.retrieve(
    "account_in71c4amph0vgo2qllky",
)
print(intrafi_exclusion.id)

require "increase"

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

intrafi_exclusion = increase.intrafi_exclusions.retrieve("account_in71c4amph0vgo2qllky")

puts(intrafi_exclusion)

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
	)
	intrafiExclusion, err := client.IntrafiExclusions.Get(context.TODO(), "account_in71c4amph0vgo2qllky")
	if err != nil {
		panic(err.Error())
	}
	fmt.Printf("%+v\n", intrafiExclusion.ID)
}

package com.increase.api.example;

import com.increase.api.client.IncreaseClient;
import com.increase.api.client.okhttp.IncreaseOkHttpClient;
import com.increase.api.models.intrafiexclusions.IntrafiExclusion;
import com.increase.api.models.intrafiexclusions.IntrafiExclusionRetrieveParams;

public final class Main {
    private Main() {}

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

        IntrafiExclusion intrafiExclusion = client.intrafiExclusions().retrieve("account_in71c4amph0vgo2qllky");
    }
}

package com.increase.api.example

import com.increase.api.client.IncreaseClient
import com.increase.api.client.okhttp.IncreaseOkHttpClient
import com.increase.api.models.intrafiexclusions.IntrafiExclusion
import com.increase.api.models.intrafiexclusions.IntrafiExclusionRetrieveParams

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

    val intrafiExclusion: IntrafiExclusion = client.intrafiExclusions().retrieve("account_in71c4amph0vgo2qllky")
}

<?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 {
  $intrafiExclusion = $client->intrafiExclusions->retrieve(
    'account_in71c4amph0vgo2qllky'
  );

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

using System;
using Increase.Api;
using Increase.Api.Models.IntrafiExclusions;

IncreaseClient client = new();

IntrafiExclusionRetrieveParams parameters = new()
{
    IntrafiExclusionID = "account_in71c4amph0vgo2qllky"
};

var intrafiExclusion = await client.IntrafiExclusions.Retrieve(parameters);

Console.WriteLine(intrafiExclusion);

Parameters

intrafi_exclusion_id

string

Required

The identifier of the IntraFi Exclusion to retrieve.

More about IntraFi Exclusions.

Archive an IntraFi Exclusion

curl -X "POST" \
  --url "${INCREASE_URL}/intrafi_exclusions/intrafi_exclusion_ygfqduuzpau3jqof6jyh/archive" \
  -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 intrafiExclusion = await client.intrafiExclusions.archive(
  'intrafi_exclusion_ygfqduuzpau3jqof6jyh',
);

console.log(intrafiExclusion.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_exclusion = client.intrafi_exclusions.archive(
    "intrafi_exclusion_ygfqduuzpau3jqof6jyh",
)
print(intrafi_exclusion.id)

require "increase"

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

intrafi_exclusion = increase.intrafi_exclusions.archive("intrafi_exclusion_ygfqduuzpau3jqof6jyh")

puts(intrafi_exclusion)

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
	)
	intrafiExclusion, err := client.IntrafiExclusions.Archive(context.TODO(), "intrafi_exclusion_ygfqduuzpau3jqof6jyh")
	if err != nil {
		panic(err.Error())
	}
	fmt.Printf("%+v\n", intrafiExclusion.ID)
}

package com.increase.api.example;

import com.increase.api.client.IncreaseClient;
import com.increase.api.client.okhttp.IncreaseOkHttpClient;
import com.increase.api.models.intrafiexclusions.IntrafiExclusion;
import com.increase.api.models.intrafiexclusions.IntrafiExclusionArchiveParams;

public final class Main {
    private Main() {}

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

        IntrafiExclusion intrafiExclusion = client.intrafiExclusions().archive("intrafi_exclusion_ygfqduuzpau3jqof6jyh");
    }
}

package com.increase.api.example

import com.increase.api.client.IncreaseClient
import com.increase.api.client.okhttp.IncreaseOkHttpClient
import com.increase.api.models.intrafiexclusions.IntrafiExclusion
import com.increase.api.models.intrafiexclusions.IntrafiExclusionArchiveParams

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

    val intrafiExclusion: IntrafiExclusion = client.intrafiExclusions().archive("intrafi_exclusion_ygfqduuzpau3jqof6jyh")
}

<?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 {
  $intrafiExclusion = $client->intrafiExclusions->archive(
    'intrafi_exclusion_ygfqduuzpau3jqof6jyh'
  );

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

using System;
using Increase.Api;
using Increase.Api.Models.IntrafiExclusions;

IncreaseClient client = new();

IntrafiExclusionArchiveParams parameters = new()
{
    IntrafiExclusionID = "intrafi_exclusion_ygfqduuzpau3jqof6jyh"
};

var intrafiExclusion = await client.IntrafiExclusions.Archive(parameters);

Console.WriteLine(intrafiExclusion);

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.

More about IntraFi Exclusions.