increase-test
POST/intrafi_exclusions/{intrafi_exclusion_id}/archive

Archive an IntraFi exclusion

Archives an IntraFi exclusion request, removing the exclusion for the specified entity and institution. Use intrafi_exclusion_id to identify the request; processing the removal may take 5 business days, and removing an exclusion does not guarantee funds will be swept to the previously excluded bank.

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

1 parameter
intrafi_exclusion_idstringrequired
The identifier of the IntraFi exclusion request to archive.

3 status codes
200Returns the updated IntraFi exclusion object, including its status.
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 processed because of a client-side error.
5XXReturned when the request cannot be completed because of a server-side error.

Error handling

The intrafi_exclusion_id path parameter must identify an existing IntraFi exclusion request. Removing the exclusion may take 5 business days to process and does not guarantee that funds will be swept to the previously excluded bank.