post https://uat-api.synapsefi.com/v3.1/users//nodes
Create an ACH-US node with Bank Login information
Request Body
| Key | Type | Description |
|---|---|---|
| type | string | [Required] Type of node. Set as ACH-US |
| info.bank_id | string | [Required] User's encrypted bank login username. See Encrypting Sensitive Information |
| info.bank_pw | string | [Required] User's encrypted bank login password. See Encrypting Sensitive Information |
| info.bank_name | string | [Required] This is the bank_code (i.e. "capone" for Capital One). See View All Institutions for a list of supported banks and their respective bank codes |
Timeout
Bank logins may take a while. This is why most bank login interfaces are interactive to keep people engaged. We recommend a timeout window of 100 seconds.
Sandbox Test Values
Login Credentials
Account Aggregation Sandbox Values
Bank Login Errors
Sync Errors
| Username | Bank Name | HTTP Code | Error Code |
|---|---|---|---|
synapse_no_accounts | fake | 402 | 460 |
synapse_bank_request | fake | 402 | 500 |
synapse_maintenance | fake | 503 | 503 |
Force Refresh
When submitting a new bank login, append any of these values to the end of the password. When doing a force_refresh on the node, it will trigger the corresponding responses:
| Append | Result |
|---|---|
_sync_balance_higher | Balance updated to amount between $800-$1500 |
_sync_balance_lower | Balance updated to amount between $10-$50 |
Common Errors
Authentication Errors
| HTTP Code | Error Code | Description |
|---|---|---|
| 400 | 200 | Triggered when something is not correct at the payload level. Mostly always for bad user credentials. But can also be triggered when payload is not formatted correctly or the institution is not supported. |
| 402 | 460 | No ACH capable account found |
| 402 | 500 | Either the account is locked or the bank is requesting user's attention (because they are not set up completely or set up or for some other reason). |
| 503 | 503 | Service unavailable due to Bank or Synapse maintenance. |
Sync Errors
| HTTP Code | Error Code | Description |
|---|---|---|
| 400 | 410 | Refresh not allowed: Refresh is not supported for the selected bank (e.g. Ally). |
| 401 | 110 | Bad credentials: Update the user's credentials by re-linking the account via bank logins. |
| 500 | 500 | Unknown refresh error: Not to be confused with a general server error or unknown login error. |
| 50503 | Refresh temporarily unavailable: This account is eligible for refresh but a temporary error (e.g. bank maintenance) caused it to fail. Try again later. |