increase-test
POST/intrafi_account_enrollments

Enroll an account in the IntraFi deposit sweep network

Creates an enrollment that adds an account to the IntraFi deposit sweep network. Provide the account's account_id and the account owner's email_address; the email address must be valid and between 1 and 50 characters. Enrollment can take about one business day to move from pending_enrolling to enrolled.

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

2 body fields

Account and contact details for the IntraFi account enrollment.

account_idstringrequired
The identifier for the account to be added to IntraFi.
email_addressstringrequired
The contact email for the account owner, to be shared with IntraFi.

3 status codes
200Returns the created IntraFi account enrollment, including its identifier, account, status, creation time, IntraFi identifier, and contact email address.
account_idstringrequired
The identifier of the Increase Account being swept into the network.
created_atstringrequired
The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which the enrollment was created.
email_addressstringrequired
The contact email for the account owner, to be shared with IntraFi.
idstringrequired
The identifier of this enrollment at IntraFi.
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).
intrafi_idstringrequired
The identifier of the account in IntraFi's system. This identifier will be printed on any IntraFi statements or documents.
statusstringrequired
The status of the account in the network. An account takes about one business day to go from `pending_enrolling` to `enrolled`.
Allowed:pending_enrollingenrolledpending_unenrollingunenrolledrequires_attention
typestringrequired
A constant representing the object's type. For this resource it will always be `intrafi_account_enrollment`.
Allowed:intrafi_account_enrollment
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

account_id and email_address are required. email_address must use a valid email format and be between 1 and 50 characters.