Sign in

v4

OpenAPI 3.1.02026-08-012402353.8 MB

Create an IntraFi Exclusion

post/intrafi_exclusions

Request body

entity_idstring required

The identifier of the Entity whose deposits will be excluded.

fdic_certificate_numberstring 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.

Example request

{
  "entity_id": "entity_n8y8tnk2p9339ti393yi",
  "fdic_certificate_number": "314159"
}

Response

IntraFi Exclusion

bank_namestring nullable required

The name of the excluded institution.

created_atstring date-time required

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

entity_idstring required

The entity for which this institution is excluded.

excluded_atstring date-time nullable required

When this was exclusion was confirmed by IntraFi.

fdic_certificate_numberstring nullable required

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

idstring required

The identifier of this exclusion request.

idempotency_keystring nullable required

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'pending' | 'completed' | 'archived' | 'ineligible' required

The status of the exclusion request.

submitted_atstring date-time nullable required

When this was exclusion was submitted to IntraFi by Increase.

type'intrafi_exclusion' required

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

Example response

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