increase-test
POST/external_accounts

Create an external account

Creates an external account to store the details of an account held at another financial institution. Provide its routing number, account number, and a display description; funding defaults to checking when omitted.

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

5 body fields

Details for the external account to create.

account_holderstringoptional
The type of entity that owns the External Account.
Allowed:businessindividualunknown
account_numberstringrequired
The account number for the destination account.
descriptionstringrequired
The name you choose for the Account.
fundingstringoptional
The type of the destination account.
Allowed:checkingsavingsgeneral_ledgerotherDefault:checking
routing_numberstringrequired
The American Bankers' Association (ABA) Routing Transit Number (RTN) for the destination account.

3 status codes
200Returns the created external account object, including its identifier, description, routing and account numbers, funding type, and status.
account_holderstringrequired
The type of entity that owns the External Account.
Allowed:businessindividualunknown
account_numberstringrequired
The destination account number.
created_atstringrequired
The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which the External Account was created.
descriptionstringrequired
The External Account's description for display purposes.
fundingstringrequired
The type of the account to which the transfer will be sent.
Allowed:checkingsavingsgeneral_ledgerother
idstringrequired
The External Account's identifier.
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).
routing_numberstringrequired
The American Bankers' Association (ABA) Routing Transit Number (RTN).
statusstringrequired
The External Account's status.
Allowed:activearchived
typestringrequired
A constant representing the object's type. For this resource it will always be `external_account`.
Allowed:external_account
4XXReturned when the request cannot be processed because of a client-side error.
5XXReturned when the service encounters a server-side error.

Error handling

The routing_number, account_number, and description fields are required. routing_number must contain exactly 9 digits, account_number must be 1 to 17 alphanumeric characters, and description must be 1 to 200 characters.