Archive an IntraFi Exclusion

Changed on
post/intrafi_exclusions/{intrafi_exclusion_id}/archive

Request

  • Base URL
    https://api.increase.com
  • URL
    https://api.increase.com/intrafi_exclusions/{intrafi_exclusion_id}/archive
  • Auth
    HTTP bearer

Path parameters

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

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 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 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:59Z",
  "fdic_certificate_number": "314159",
  "id": "intrafi_exclusion_ygfqduuzpau3jqof6jyh",
  "idempotency_key": null,
  "status": "completed",
  "submitted_at": "2020-02-01T00:59:59Z",
  "type": "intrafi_exclusion"
}

Changes

  • 64a92a8cc343Revision changes
    • info

      added subschema #8 subschema #10 to the /// response property anyOf list for the response status

    • info

      added subschema #8 subschema #10 to the /// response property anyOf list for the response status

    • info

      removed subschema #8 subschema #10 from the /// response property anyOf list for the response status

    • info

      removed subschema #8 subschema #10 from the /// response property anyOf list for the response status