Documentation
Sign UpLog In

Error Codes

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
0023Missing security questionPlease add security questions in request
0024Missing security answerPlease add security answer in request
0025Invalid security questionPlease use valid security question in request
0026Invalid security answerPlease use valid security answer in request
0027Reset PasswordPlease reset the password before using the APIs
0028Invalid clientIdPlease generate new clientId
0029Invalid Institution EligibilityThis API is not available for requested instituions
0030Feature not availableRequested feature is not available
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
3008Request in progressPlease try after sometime

Updated almost 3 years ago