increase-test
POST/intrafi_exclusions

Create an IntraFi exclusion

Creates an IntraFi exclusion for a financial institution and an entity. Supply the entity_id and the institution's fdic_certificate_number; the certificate number must be between 1 and 200 characters. Processing an exclusion may take 5 business days.

  • IdempotentThe SDK sends Idempotency-Key, so a retried request is only applied once.

2 body fields

Entity and financial institution details for the IntraFi exclusion.

entity_idstringrequired
The identifier of the Entity whose deposits will be excluded.
fdic_certificate_numberstringrequired
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](https://banks.data.fdic.gov/bankfind-suite/bankfind).

3 status codes
200Returns the created IntraFi exclusion, including its identifier, entity, status, creation time, and institution details.
bank_namestringrequired
The name of the excluded institution.
created_atstringrequired
The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which the exclusion was created.
entity_idstringrequired
The entity for which this institution is excluded.
excluded_atstringrequired
When this exclusion was confirmed by IntraFi.
fdic_certificate_numberstringrequired
The Federal Deposit Insurance Corporation's certificate number for the institution.
idstringrequired
The identifier of this exclusion request.
idempotency_keystringrequired
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](https://increase.com/documentation/idempotency-keys).
statusstringrequired
The status of the exclusion request.
Allowed:pendingcompletedarchivedineligible
submitted_atstringrequired
When this exclusion was submitted to IntraFi by Increase.
typestringrequired
A constant representing the object's type. For this resource it will always be `intrafi_exclusion`.
Allowed:intrafi_exclusion
4XXReturned when the request cannot be completed because of a client-side error.
5XXReturned when the request cannot be completed because of a server-side error.

Error handling

entity_id and fdic_certificate_number are required. fdic_certificate_number must be between 1 and 200 characters and identifies the financial institution to exclude.