API Error Handling
Overview
The AeroSync API provides error codes with their respective messaging indicating why an error ocurred during processing time.
The Basics
The error codes are sent as part of the response body indicating an error from status code and body. The code will always start with AC
followed by a designated 3 digit number depending on the error, followed by a message describing the error.
{
"error": {
"code": "AC-204",
"message": "No account information available, please select another bank."
}
}
Errors by Endpoint
POST /token
HTTP Status | Aerosync ErrorCode | ErrorMessage | Description |
---|---|---|---|
400 Bad Request | AC-100 | Required attributes are missing or not in a valid format. | The request body contains bad syntax or is incomplete. Check your request to ensure proper format |
401 Forbidden | AC-101 | Invalid API key and secret. | The supplied credentials are not authorized for this resource. Check your key and secret again. |
GET /accounts/{user_id}
HTTP Status | Aerosync ErrorCode | ErrorMessage | Description |
---|---|---|---|
400 Bad Request | AC-100 | Required attributes are missing or not in a valid format. | The request body contains bad syntax or is incomplete. Check your request to ensure proper format |
403 Forbidden | AC-001 | Invalid API key and secret. | The supplied credentials are not authorized for this resource. Check your key and secret again |
404 Not Found | AC-102 | "User {user_id} not found" | An invalid user_id was input in path parameter |
400 Bad Request | AC-103 | "The FI failed to send account number, routing number, or balance" | There are missing values coming in from FI. |
400 Bad Request | AC-104 | "We are having issues connecting to your bank. Reconnect your bank or reach out to [email protected] to resolve the issue." | There are connection issues currently with the FI. |
GET /accounts/{user_id}/balance
HTTP Status | Aerosync ErrorCode | Error Message | Description |
---|---|---|---|
400 Bad Request | AC-100 | "Missing required request parameters: [user_id]" | The request body contains bad syntax or is incomplete. Check your request to ensure proper format |
403 Forbidden | AC-001 | Invalid API key and secret. | The supplied credentials are not authorized for this resource. Check your key and secret again. |
400 Bad Request | AC-104 | "We are having issues connecting to your bank. Reconnect your bank or reach out to [email protected] to resolve the issue." | There are connection issues currently with the FI. |
405 Forbidden | AC-105 | "Balance check not available for manually linked users" | Balance checks for manually linked users is unavailable currently. |
400 Bad Request | AC-106 | "For security purposes, the FI has paused sharing account information for this user. To continue, the user can reconnect to the FI" | The connection to the FI has been removed. User has to reconnect to their FI to provide information. |
POST /accounts/{user_id}/refresh
HTTP Status | Aerosync ErrorCode | ErrorMessage | Description |
---|---|---|---|
400 Bad Request | AC-100 | "Missing required request parameters: [user_id]" | The request body contains bad syntax or is incomplete. Check your request to ensure proper format |
403 Forbidden | AC-001 | Invalid API key and secret. | The supplied credentials are not authorized for this resource. Check your key and secret again. |
400 Bad Request | AC-102 | "User {user_id} not found" | An invalid user_id was input in path parameter |
400 Bad Request | AC-104 | "We are having issues connecting to your bank. Reconnect your bank or reach out to [email protected] to resolve the issue." | There are connection issues currently with the FI. |
405 Forbidden | AC-107 | "Balance refresh not available for manually linked users" | Balance refresh for manually linked users is unavailable currently. |
429 Too Many Requests | AC-108 | "Account has been temporarily blockd due to too many incorrect MFA attempts" | User incorrectly answered MFA too many times |
POST /accounts/{user_id}/mfa/{job_id}
HTTP Status | Aerosync ErrorCode | ErrorMessage | Description |
---|---|---|---|
400 Bad Request | AC-100 | "Missing required request parameters: [user_id]" | The request body contains bad syntax or is incomplete. Check your request to ensure proper format |
403 Forbidden | AC-001 | Invalid API key and secret. | The supplied credentials are not authorized for this resource. Check your key and secret again. |
404 Not Found | AC-102 | "User {user_id} not found" | An invalid user_id was input in path parameter |
400 Bad Request | AC-104 | "We are having issues connecting to your bank. Reconnect your bank or reach out to [email protected] to resolve the issue." | There are connection issues currently with the FI. |
404 Not Found | AC-109 | "Job {job_id} not found" | An invalid job_id was input in path parameter |
POST /accounts/{user_id}/mfa/{job_id}/resolve
HTTP Status | Aerosync ErrorCode | ErrorMessage | Description |
---|---|---|---|
400 Bad Request | AC-100 | "Missing required request parameters: [user_id]" | The request body contains bad syntax or is incomplete. Check your request to ensure proper format |
403 Forbidden | AC-001 | Invalid API key and secret. | The supplied credentials are not authorized for this resource. Check your key and secret again. |
404 Not Found | AC-102 | "User {user_id} not found" | An invalid user_id was input in path parameter |
400 Bad Request | AC-104 | "We are having issues connecting to your bank. Reconnect your bank or reach out to [email protected] to resolve the issue." | There are connection issues currently with the FI. |
405 Method Not Allowed | AC-110 | "Your MFA session has expired. Please reauthenticate to continue" | Client took too long to answer MFA and session has expired. |
POST /accounts/{user_id}/identity
HTTP Status | Aerosync ErrorCode | ErrorMessage | Description |
---|---|---|---|
400 Bad Request | AC-100 | "Missing required request parameters: [user_id]" | The request body contains bad syntax or is incomplete. Check your request to ensure proper format |
403 Forbidden | AC-001 | Invalid API key and secret. | The supplied credentials are not authorized for this resource. Check your key and secret again. |
404 Not Found | AC-102 | "User {user_id} not found" | An invalid user_id was input in path parameter |
400 Bad Request | AC-104 | "We are having issues connecting to your bank. Reconnect your bank or reach out to [email protected] to resolve the issue." | There are connection issues currently with the FI. |
405 Method Not Allowed | AC-111 | "Identity jobs are not available for manually linked users" | Identity jobs for manually linked users is unavailable currently. |
409 Conflict | AC-112 | "Conflict - another job currently in progress" | Attempted to initiate an identity job when there is already one currently in progress. |
GET /accounts/{user_id}/identity
HTTP Status | Aerosync ErrorCode | ErrorMessage | Description |
---|---|---|---|
400 Bad Request | AC-100 | "Missing required request parameters: [user_id]" | The request body contains bad syntax or is incomplete. Check your request to ensure proper format |
403 Forbidden | AC-001 | Invalid API key and secret. | The supplied credentials are not authorized for this resource. Check your key and secret again. |
404 Not Found | AC-102 | "User {user_id} not found" | An invalid user_id was input in path parameter |
400 Bad Request | AC-104 | "We are having issues connecting to your bank. Reconnect your bank or reach out to [email protected] to resolve the issue." | There are connection issues currently with the FI. |
400 Bad Request | AC-113 | "For security purposes, the FI has paused sharing account information for this user. To continue, the user can reconnect to the FI" | Authentication has failed for expected user. |
POST /accounts/{user_id}/transactions
HTTP Status | Aerosync ErrorCode | ErrorMessage | Description |
---|---|---|---|
400 Bad Request | AC-100 | "Missing required request parameters: [user_id]" | The request body contains bad syntax or is incomplete. Check your request to ensure proper format |
403 Forbidden | AC-001 | Invalid API key and secret. | The supplied credentials are not authorized for this resource. Check your key and secret again. |
404 Not Found | AC-102 | "User {user_id} not found" | An invalid user_id was input in path parameter |
400 Bad Request | AC-104 | "We are having issues connecting to your bank. Reconnect your bank or reach out to [email protected] to resolve the issue." | There are connection issues currently with the FI. |
409 Conflict | AC-112 | "Conflict - another job currently in progress" | Attempted to initiate an transaction job when there is already one currently in progress. |
405 Method Not Allowed | AC-114 | "Transaction jobs are not available for manually linked users" | Transaction jobs for manually linked users is unavailable currently. |
GET /accounts/{user_id}/transactions
HTTP Status | Aerosync ErrorCode | ErrorMessage | Description |
---|---|---|---|
400 Bad Request | AC-100 | "Missing required request parameters: [user_id]" | The request body contains bad syntax or is incomplete. Check your request to ensure proper format |
403 Forbidden | AC-001 | Invalid API key and secret. | The supplied credentials are not authorized for this resource. Check your key and secret again. |
404 Not Found | AC-102 | "User {user_id} not found" | An invalid user_id was input in path parameter |
400 Bad Request | AC-104 | "We are having issues connecting to your bank. Reconnect your bank or reach out to [email protected] to resolve the issue." | There are connection issues currently with the FI. |
405 Method Not Allowed | AC-115 | "Transaction data not available for manually linked users" | Transaction jobs for manually linked users is unavailable currently. |
GET /accounts/{user_id}/job/{job_id}
HTTP Status | Aerosync ErrorCode | ErrorMessage | Description |
---|---|---|---|
400 Bad Request | AC-100 | "Missing required request parameters: [user_id]" | The request body contains bad syntax or is incomplete. Check your request to ensure proper format |
403 Forbidden | AC-001 | Invalid API key and secret. | The supplied credentials are not authorized for this resource. Check your key and secret again. |
404 Not Found | AC-102 | "User {user_id} not found" | An invalid user_id was input in path parameter |
400 Bad Request | AC-104 | "We are having issues connecting to your bank. Reconnect your bank or reach out to [email protected] to resolve the issue." | There are connection issues currently with the FI. |
404 Not Found | AC-109 | "Balance refresh job for {user_id} not found" | An invalid job_id was input in path parameter |
Updated about 1 month ago