v1

latestOpenAPI 3.1.02026-07-26457177.8 KB
Accounts

Create Account by Account and Routing

📘

You can place the bearer access_token for a specific user into the Authentication section of this documentation 👉.

This endpoint will create an Account for a User based on an account and routing number.

❗️ This resource requires the use of the secure endpoint.

🚧

Your Institution ID in Sandbox may be different than your Institution ID in Production. Please check the Client Details section of your Astra Dashboard to confirm.

🚧

If you are creating an account in Sandbox, the Routing number must be a real-world Routing number. Account numbers in Sandbox should not be real-world. If you do not have a Routing number readily available, you can use 222222226.

🚧

Account numbers must be at minimum 7 digits and no greater than 17. For account numbers less than 7 digits, you must prepend zeros to the beginning of the account number. For example: an account number of 12345 should be registered as 0012345.

📘

Although required, the Name field is internal facing, and isn’t available for your Users to see unless you explicitly make this field visible to them through your application. The Name field also doesn’t appear on Bank Statements. This field was primarily designed for internal tracking of accounts.

post/v1/accounts/create

Request body

institution_idstring required

The Institution ID given to you by Astra, which can be found in the Client Details section of your Astra Dashboard

namestring required

The name for the Account

bank_account_typestring required

The type of bank account (checking or savings)

account_numberstring required

The bank account number

routing_numberstring required

The bank routing number

Response

Successful response

idstring

Unique ID of the account

official_namestring

Official name of the account

namestring

Name of the account

maskstring

Masked account number

institution_namestring

Institution name of the account

institution_logostring

Logo of the institution

typestring

Type of the account

subtypestring

Subtype of the account

connection_statusstring

Connection status of the account