Error Codes

Financial Institution ERRORS

Input Errors

πŸ“˜

These errors occur when you or your user have entered incorrect information. Please verify values in your request body and try again.

HTTP Status CodeErrorDescriptionHow to Handle
400BENEFICIARY_NAME_CHARACTER_LIMITThe user provided a beneficiary name that contains too many characters. This Financial Institution only supports x number of characters.Prompt your user to enter the beneficiary name again while limiting themselves to the required number of characters.
401INACTIVE_ACCOUNTProvided account number is incorrect or inactive.Verify that the request body contains valid values for request parameters or contact your Financial Institution.
401INVALID_CREDENTIALSYour user entered invalid login credentials.Prompt the user to try again.
401INVALID_MFAYour user has entered invalid MFA information (OTP, Secret Question, token).Prompt the user to try again.
404INVALID_ACCOUNT_IDProvided account ID is incorrect.Verify that the request body contains valid identifiers.
404INVALID_CARD_IDProvided card ID is incorrect.Verify that the request body contains valid identifiers.
400INVALID_DATE_RANGEProvided date range is not supported by the Financial Institution.Enter a date range of up to x days.
400PARAMETER_ERRORYour request body contains incorrect parameters.Verify that your request body is properly formatted in accordance to our endpoints.
422PARAMETER_MISSINGYour request body is missing necessary parameters.Verify that your request body is properly formatted in accordance to our endpoints.

Invalid Request Errors

πŸ“˜

These errors occur when the financial institution does not accept the requested operation. Please see error details below and attempt a different request.

HTTP Status CodeErrorDescriptionHow to Handle
401ACCOUNT_LOCKEDAccount locked out due to too many failed login attempts.Prompt the user to reset their password and try again.
401INACTIVE_ACCOUNTThis account has been deactivated.Prompt the user to contact their Financial Institution.
401ACCOUNT_FEATURE_LOCKEDThis operation is locked by the Financial Institution.Contact your Financial Institution.
500PRODUCT_NOT_SUPPORTEDThe endpoint you are trying to connect is currently not supported.Check api endpoint or Contact Brick

Retryable Errors

πŸ“˜

These errors are usually caused by a failed connection to the Financial Institution or our servers. Please try the request again.

HTTP Status CodeErrorDescriptionHow to Handle
400UNABLE_TO_CONNECT_TO_BANKFailed attempt to connect to the user's Financial Institution.Try again later.
500UNKNOWN_ERRORAn unknown interruption occurred while performing your request.Try again or contact Brick if problem persists
500SERVER_ERRORAn unknown interruption occurred while performing your request.Try again or contact Brick if problem persists
401SESSION_INVALIDATEDYour user's session has expired or been terminated by the Financial Institution.Retry the request.
400USER_ALREADY_LOGGED_INThis Financial Institution does not support concurrent login.Prompt the user to log in again or try again later.
503TEMPORARILY_UNAVAILABLEAn error occurred due to financial institution downtime.Try again.
404NOT_FOUNDThe endpoint you are trying to connect is currently not supported.Check the api endpoint or contact Brick.

Customized error codes and error messages

πŸ“˜

If you are getting an unsuccessful response, There may be many reasons. To understand the errors in the easiest way we have added two fields(ie: error_code and error_message) in the response.

"Error_code" is the unique code for any error and "error_message" is details about that error.

Below is a structure of Unsuccessful responses.

{
    "status": XXX,
    "error_code": "XXXX",
    "message": "Description of error",
    "error_message": "New description of error",
    "data": "Response data"
}

Explanation for every field.

Status - HTTP/HTTPS status code
error_code - Brick customized status code
message - Old description of the error
error_message - New description of the error
data - Relevant data as per the request.

πŸ“˜

Below is a list of possible "error_codes" that can be returned, along with "error_message" for better understanding the error.

Error_codeError_messageSolutions
0001Invalid public-access-tokenPlease use valid public access token
0002Invalid user-access-tokenPlease use valid user access token
0003Parameter from and to are mandatoryPlease provide from and to parameter while using brick products
0004Invalid date (invalid from date (from = 12 months back from present))It varies from a financial institution to another, Some institutions provide data from previous twelve months and some provide for previous six months, So please request brick products with Valid range.
0005Date parameter format is invalidDate format in not valid, Please use(DD-MM-YYYY)
0006An account is already logged in. Please try again in 10 minutesPlease wait and request after 10 minutes.
0007This account is dormant account. No data available from user accountPlease activate provided account number to use it properly.
0008Invalid AuthorizationPlease try with valid access tokens
0009From date is more than a certain periodIt varies from a financial institution to another, Some provide data from previous twelve months and some provide for previous six months, So please request API with valid date range.
0010A server crash or any unexpected behavior, Please try after some time.Please try after some time.
0011Call back is not availablePlease add callback URL through dashboard to use APIs.
0012Invalid sessionIdPlease recall the API to generate valid sessionId.
0013Invalid TokenPlease recall the API to generate valid token.
0014Missing sessionIdPlease add sessionId in request.
0015Missing tokenPlease add token in request.
0016Client not authorizedYou can not authorized to use this service. Please contact Brick sales team.
0017Data cannot be retrieved / Service unavailable / Element not foundPlease try after some time.
0018Account blockedPlease contact Institution and unblock the account before using Brick products.
0019Missing requestIdPlease use RequestId in API request
0020Invalid requestIdPlease use valid RequestId in API
0021Service unavailablePlease try after some time
0022Session expiredSession expire, Please try after some time
1002Invalid Bank account credentialPlease use valid bank credentials while requesting data from Brick products.
1003Missing parameter institutionIdPlease add InstitutionsId in request
1004Missing parameter usernamePlease add username in request
1005Missing parameter passwordPlease add password in request
1006Invalid institution idPlease use valid institutions ID in Request
1007Missing uniqueIdPlease add uniqueId in request
1008Missing sessionIdPlease add sessionId in request
1009Missing OTP tokenPlease add OTP token in request
1010Missing OTPPlease add OTP in request
1011Missing redirectRefIdPlease add Redirect Ref Id in request
1012Data cannot be retrieved / Service unavailable / Element not foundPlease try after some time.
1013Missing RefIdPlease add RefId in request
1014Missing deviceIdPlease add deviceId in request
1015Missing otpNumberPlease add otpNumber in request
1016Missing pinPlease add pin in request
1017Invalid OTPPlease use valid OTP that user got from institution
1018Invalid PINPlease use valid pin of institution
1019Invalid username (E-wallet)Please use valid username of institution
1020Invalid refIdPlease use valid refId
1021Invalid deviceIdPlease use valid deviceId, DeviceId in unique mobile Id.
1022Invalid uniqueIdPlease use valid unique Id of Institution
1023Invalid otpTokenPlease use OTP token that use got from Institution
1024Invalid / Wrong OTP codePlease use OTP that use got from Institution
1025Invalid phone number formatPlease use correct formatted phone number
1026Phone number is not registeredPlease use valid phone number that is connected with Institutions.
1027Invalid credentials with suggestionPlease follow the suggestions given in response message.
2002Parameter accountId is mandatoryPlease add accountId Id in request
2005Service is unavailable. Please try againPlease try after some time.
2006Account not foundPlease request with valid account number, Provided account number is not valid.
2008Account is not activatedPlease activated the account before using.
3005Service is unavailable. Please try againPlease try after some time.
3007Data is not available between given timeframePlease provide other timeframe to get the data from institutions

What’s Next