API Response Codes
Error Codes Table
API Response Codes
API responses with 400+ HTTP Status codes return response code, response message and description in the response body providing additional information about the error.
Common API Responses
Common API Response Codes are applicable for all APIs. Associated response messages, descriptions and more information/resolution are provided below.
Common 401 Responses
| Response Code | Response Message | Description | More Information / Resolution |
|---|---|---|---|
| 401 | Unauthorized | This server could not verify that you are authorized to access the URL. | Invalid access token was passed in the Authorization header. |
| 401 | Unauthorized | Invalid client id or secret | Invalid client id was passed in x-ibm-client-id header parameter. |
| 401 | Unauthorized | Invalid Scope | Invalid scope passed in OAuth API. |
| 401 | Unauthorized | client_id unauthorized | Invalid client id or secret was passed in Basic Authentication for Oauth token endpoint. |
| 401 | Unauthorized | Not registered to plan | Check if you have subscribed to the API Product. |
| 401001 | Unauthorized | Invalid OAuth metadata | Check if the account id/emirates id/cif id passed in the API request matches the oauth metadata value passed while generating Oauth token. |
Common 403 Responses
| Response Code | Response Message | Description | More Information / Resolution |
|---|---|---|---|
| 403 | Forbidden | Unauthorized | Invalid client id passed to OAuth Authorize endpoint. |
Common 422 Responses
| Response Code | Response Message | Description | More Information / Resolution |
|---|---|---|---|
| 422001 | Property missing | Invalid object: the property '<property name>' is missing. | The mandatory or conditional mandatory property was missing in the request body. Use the property_name field to identify the missing property. |
| 422002 | Parameter missing | Invalid header: the parameter '<property name>' is missing. | The mandatory or conditional mandatory parameter was missing in the request header. Use the property_name field to identify the missing parameter. |
| 422002 | Parameter missing | Invalid path: the parameter '<property name>' is missing. | The mandatory or conditional mandatory parameter was missing in the request path. Use the property_name field to identify the missing parameter. |
| 422003 | Min Length Error | Invalid string: the minimum length must be at least (got only ). | Check that each field passed in the request path or body have atleast the minimum length value for that field. |
| 422004 | Max Length Error | Invalid string: the string maximum length must be at most (got ). | Check that each field passed in the request path or body are within the allowed max length value for that field. |
| 422005 | Invalid value | Invalid value: the '<property name>' is not among the permitted values. | Check the allowed values provided for the field on the API Reference Data page. |
| 422005 | Invalid value | Invalid value: the value is not among the permitted enumerated values. | Check the allowed enum values provided for the field in the spec and correct the value. |
| 422006 | Invalid/Invalid Request | Invalid value type 'string'. | Ensure that request passed is as per API spec. |
| 422010 | Record Not Found | <property name> not found | No records found with the mentioned property value. |
API Specific Response Codes for Business Exceptions
Business exception response codes and descriptions specific to each API are provided below.
RAKMoneyTransfer Beneficiary Banks Response Codes
RAKMoneyTransfer Beneficiary Banks
API Operation: Get Other Bank Params
| Response Code | Description |
|---|---|
| 20012 | SEARCH PARAMS NOT FOUND |
API Operation: Get Other Banks List
| Response Code | Description |
|---|---|
| 20012 | SEARCH PARAMS NOT FOUND |
| 20013 | FAILED MANDATE REQUIREMENTS |
| 20014 | BANKLIST NOT FOUND |
Partner Beneficiary Management Response Codes
Partner Beneficiary Management
API Operation: Create Beneficiary, Update Beneficiary By Id
| Response Code | Description |
|---|---|
| 20001 | Bene Bank details are either incomplete / improper (IFSC / Routing / Bank / BranchCode) |
| 20003 | Currency is not Defined |
| 20011 | Restricted Customer or Beneficiary Nationality |
Partner Beneficiary Management Response Codes
Partner RAKMoneyTransfer
API Operation: Create Transaction By Id
| Response Code | Description |
|---|---|
| 20005 | TRANSACTION_LIMIT_EXCEEDED(DYNAMIC) |
| 20011 | Restricted Customer or Beneficiary Nationality |
| 20003 | Currency is not Defined |
| 20007 | Customer is blocked |
| 20008 | No debit account found for specified card_bin |
| 20010 | Beneficiary Bank currently Not Supported. |
| 20025 | Beneficiary's details should be updated with IBAN. IBAN to be <A> alphanumeric characters prefixed with country code <B> |
| 20026 | TRANSACTION AMOUNT IS LESS THAN <MIN AMOUNT> AED |
Digital Banking Beneficiaries Response Codes
RAKBANK Digital Banking Beneficiaries
API Operation: Get Beneficiaries, Get Beneficiary By Id
| Response Code | Description |
|---|---|
| 21300 | No beneficiaries found for the given search criteria |
| 21301 | RAKToken has been disabled as you have exceeded the maximum no. of entry attempts. Please call 042130000 to activate RAKToken. |
Partner Retail Account Applications Response Codes
Partner Retail Account Applications
API Operation: Create Retail Account Application
| Response Code | Description |
|---|---|
| 20601 | Application id : {IncidentId} already exists for same IBAN. |
API Operation: Update Retail Account Application
| Response Code | Description |
|---|---|
| 20602 | Application cannot be updated as it is Rejected |
| 20603 | Application cannot be updated as it is Processed |
| 20604 | Application cannot be updated as it is Under Processing |
| 20605 | Application cannot be updated as additional information was not requested |
| 20606 | Industry Sub Segment is mandatory, if employment type is Self employed or A (Salaried and self-employed) |
| 20607 | Document type 'VISA' is mandatory for Non GCC applicants |
| 20608 | Document type 'VISAUID' is mandatory for Non GCC applicants |
| 20609 | Issue Date for document type 'VISA' is mandatory for Non GCC applicants |
API Operation: Update Retail Account Application Status
| Response Code | Description |
|---|---|
| 20602 | Application cannot be updated as it is Rejected |
| 20603 | Application cannot be updated as it is Processed |
| 20604 | Application cannot be updated as it is Under Processing |
| 20605 | Application cannot be updated as additional information was not requested |
Partner Customer Profile Update Response Codes
Partner Customer Profile Update
API Operation: Update Customer By Id
| Response Code | Description |
|---|---|
| 20504 | Multiple Preferred Address are not Allowed |
| 20505 | Record is Locked |
| 20508 | Customer is under verification |
| 20509 | Permitted Number of updates exceeded |
| 20510 | Customer is not a NTB customer |
| 20511 | Update allowed only for retail customers |
Card Payments Response Codes
Card Payments
API Operation: Create Card Payment
| Response Code | Description |
|---|---|
| 20200 | The part transaction is already posted. |
| 20201 | The transaction is not balanced. |
| 20202 | The postdated transactions cannot be posted. |
| 20203 | The postdated transactions are not allowed beyond today. |
| 20204 | The part transaction is deleted. |
| 20205 | CROSS CURRENCY CONVERSION FAILED |
| 20206 | The transaction is not balanced value date wise. |
| 20207 | The transaction is not balanced for this transaction ID[%s]. |
| 20208 | The account [%s] is closed. |
| 20209 | The currency code [%s] is invalid. |
| 20209 | The currency code [%s] is invalid. |
| 20210 | The entered rate is not the current rate. |
| 20211 | The currency code is invalid. |
| 20212 | The transaction amount for the transaction ID [%s] is less than zero. |
| 20213 | The transaction and account currency are different. |
| 20214 | Value Date of Part Tran can not be lesser than [%s] days |
| 20214 | This date cannot be prior to [%s]. |
| 20215 | Rate cannot be negative |
| 20216 | The branch or the bank and branch combination is invalid. |
| 20217 | INSUFFICIENT AVAIL BALEXCP |
| 20218 | LINKED OPERATIVE A/C IS DORMANT OR INACTIVE |
| 20218 | LINKED OPERATIVE A/C IS DORMANT OR INACTIVE |
| 20219 | INSUFFICIENT BALANCE IN OPERATIVE A/C |
| 20219 | INSUFFICIENT BALANCE IN OPERATIVE A/C |
| 20219 | INSUFFICIENT BALANCE IN OPERATIVE A/C |
| 20222 | OPERATIVE A/C IS FROZEN |
| 20222 | OPERATIVE A/C IS FROZEN |
| 20222 | OPERATIVE A/C IS FROZEN |
| 20222 | OPERATIVE A/C IS FROZEN |
| 20225 | OPERATIVE A/C IS DORMANT OR INACTIVE |
| 20225 | OPERATIVE A/C IS DORMANT OR INACTIVE |
| 20225 | OPERATIVE A/C IS DORMANT OR INACTIVE |
| 20239 | Please check From or To Account Number |
| 20240 | Selected/entered account has been closed |
| 20239 | Please check From or To Account Number |
| 20239 | Please check From or To Account Number |
| 20243 | Selected/entered customer is inactive |
| 20243 | Selected/entered customer is inactive |
| 20239 | Please check From or To Account Number |
| 20246 | Payment not allowed for back dated transactions. |
| 21500 | Duplicate transmission |
| 21501 | Approved for partial amount |
| 21502 | Invalid transaction |
| 21503 | Invalid amount |
| 21504 | Card number does not exist |
| 21506 | Customer cancellation |
| 21507 | Re-enter transaction |
| 21508 | Expired card |
| 21509 | Not sufficient funds |
| 21510 | Expired card |
| 21511 | No card record |
| 21512 | Transaction not permitted to card |
| 21513 | Transaction not permitted to card |
| 21514 | Exceeds withdrawal limit |
| 21515 | Request in progress |
| 21516 | Response received too late |
Forex Rate and Charges Response Codes
Forex Rate & Charges
API Operation: GetFxRate
| Response Code | Description |
|---|---|
| 422011 | Invalid value: the from_currency_code is invalid |
| 422012 | Invalid value: the transaction amount is invalid |
| 422013 | Invalid value: the to_currency_code is invalid |
| 422014 | Invalid value: the currency code provided in "value.currency" is invalid |
| 20001 | Bene Bank details are either incomplete / improper (IFSC / Routing / Bank / BranchCode) |
| 20005 | Same as received from backend |
| 20012 | Currency combination is invalid |
| 20013 | Exchange rate is not available for currency pair |
| 20015 | Invalid Account Id |
| 20100 | The account is frozen. |
| 20101 | INVALID BANK ID AND BRANCH ID COMBINATION |
| 20102 | Invalid Currency Code |
| 20103 | The amount cannot be less than zero. |
| 20104 | The entered amount must be greater than zero. |
| 20105 | Entered BIC [%s] not found in Network Directory. |
| 20107 | Currency is closed on the Value Date. |
| 20109 | The account is frozen for debit. |
| 20110 | The account is frozen for credit. |
| 20113 | Debit Account has insufficient balance |
| 20114 | ACCOUNT IS DORMANT |
| 20115 | CLOSED ACCOUNT |
| 20116 | MAIL RETURNED |
| 20117 | DEBIT ACCOUNT IS FROZEN |
| 20118 | Invalid From or To Account Number |
| 20122 | Either BIC or Bank / Branch Code is to be entered. |
| 20123 | Message can not be sent now as allowed transaction time has not yet started. |
| 20124 | Message can not be sent today as Cut Off time Exceeded. |
| 20125 | Please enter valid value(s). |
Partner External Bank Transfers Response Codes
Partner External Bank Transfers
API Operation: Create transaction, get transaction By Id
| Response Code | Description |
|---|---|
| 20102 | Invalid Currency Code |
| 20103 | The amount cannot be less than zero |
| 20104 | The entered amount must be greater than zero |
| 20122 | Either BIC or Bank / Branch Code is to be entered |
| 20123 | Message can not be sent now as allowed transaction time has not yet started |
| 20124 | Message can not be sent today as Cut Off time Exceeded |
| 20126 | Credit Value Date cannot be less than Debit Value Date |
| 20127 | Invalid purpose_code |
| 20128 | MANDATORY FIELD CANNOT BE NULL-Exchange Rate |
| 20130 | REMITTANCE NOT ALLOWED ON A HOLIDAY |
| 20131 | to.address.line_1 must be passed in the request if beneficiary country of residence or incorporation is Canada |
Partner Notification Update AWB Response Codes
Partner Notification Update AWB
API Operation: Update AWB
| Response Code | Description |
|---|---|
| 21600 | AWB status cannot be updated as it is Rejected |
| 21601 | AWB status cannot be updated as it is Processed |
| 21602 | AWB status cannot be updated as it is Under Processing |
| 21603 | AWB status cannot be updated as additional information was requested |
Partner Internal Bank Transfers
Partner Internal Bank Transfers
API Operation: Create Transaction
| Response Code | Description |
|---|---|
| 20239 | Please check From or To Account Number |
OTP Request Response Codes
OTP Request
API Operation: Validate OTP
| Response Code | Description |
|---|---|
| 21404 | OTP Expired |
| 21403 | No matching OTP Request found |
Partner Advance Against Salary Response Codes
Advance Against Salary
API Operation: Check Eligibility
| Response Code | Description |
|---|---|
| 20052 | Loan already exists for the emirates ID. |
| 20050 | Duplicate Request Sent. |
Account Transactions API Response Codes
Account Transactions
API Operation: GetAccountTransactions
| Response Code | Description |
|---|---|
| 21106 | No transactions for the given Account Number |
Partner Account Liens Reponse Codes
Partner Account Liens
API Operation: CreateAccountLienById
| Response Code | Description |
|---|---|
| 20405 | Duplicate Transaction |
| 20404 | Invalid Amount |
RAKBANK Digital Banking Transfers Response Codes
RAKBANK Digital Banking Transfers
API Operation: CreateTransferById, ValidateTransferById
| Response Code | Description |
|---|---|
| 21205 | The transaction currency must be the same as the debit or credit account currency. |
| 21239 | Please enter a valid Beneficiary Account Number. |