Sign in

v4

OpenAPI 3.1.02026-08-012402353.8 MB

Enroll an account in the IntraFi deposit sweep network

post/intrafi_account_enrollments

Request body

account_idstring required

The identifier for the account to be added to IntraFi.

email_addressstring email required

The contact email for the account owner, to be shared with IntraFi.

Example request

{
  "account_id": "account_in71c4amph0vgo2qllky",
  "email_address": "user@example.com"
}

Response

IntraFi Account Enrollment

account_idstring required

The identifier of the Increase Account being swept into the network.

created_atstring date-time required

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

email_addressstring nullable required

The contact email for the account owner, to be shared with IntraFi.

idstring required

The identifier of this enrollment at IntraFi.

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.

intrafi_idstring required

The identifier of the account in IntraFi's system. This identifier will be printed on any IntraFi statements or documents.

status'pending_enrolling' | 'enrolled' | 'pending_unenrolling' | 'unenrolled' | 'requires_attention' required

The status of the account in the network. An account takes about one business day to go from pending_enrolling to enrolled.

type'intrafi_account_enrollment' required

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

Example response

{
  "account_id": "account_in71c4amph0vgo2qllky",
  "created_at": "2020-01-31T23:59:59Z",
  "email_address": null,
  "id": "intrafi_account_enrollment_w8l97znzreopkwf2tg75",
  "idempotency_key": null,
  "intrafi_id": "01234abcd",
  "status": "pending_enrolling",
  "type": "intrafi_account_enrollment"
}