Skip to main content
☰
 

Account Balance

APIGap MARKETPLACE

Login

  • Log in
  • Register for access
Back
Corporate APIs
Utility Bill Payment
Collections - Direct Debits
Account Balance
Credit-Debit Notification
IBAN Title Verification
Payment Initiation
Statements
Virtual Account Entry Update
Virtual Account Management
Account Balance API
Flow chart
initiateAccountBalance
Request Headers Request Parameters Response Parameters Status Code Info
accountBalanceInquiry
Request Headers Request Parameters Response Parameters Status Code Info
Important Notes
Corporate
Account Balance
Account Balance

Description

These APIs offer corporate customers real-time access to their current and available account balances, enabling automated reconciliation, enhanced cash visibility, and proactive liquidity management.

In order to subscribe, Please
Register for acces or Sign in

Select plan
Default Plan

Default Plan

Default Plan

Select

100 calls per hour

APIs

Title Version Type Rate limits
Account Balance API 1.0.1 REST 100 calls per hour
POST /initiateAccountBalance 100 calls per hour
GET /enquiry 100 calls per hour
  • Overview
  • APIs Offered
    Account Balance API

    This API provides customers with real-time information on their current and available account balances. It improves cash visibility, automates reconciliation, and enhances the efficiency of financial operations.

    Account Balance API
    View API Specifications

    This API provides customers with real-time information on their current and available account balances. It improves cash visibility, automates reconciliation, and enhances the efficiency of financial operations.

    NOTE:

    • Applications must get the token using the “Get Token API," which will provide the access token details. This token must be used for the subsequent interactions of RESTful APIs. Tokens will be valid for 180s

    Flow Chart

    Image
    Flow Chart Account Balance API

    What operations can be performed?

    1. initiateAccountBalance: This POST method allows the customer to retrieve the current and available account balance.

    Request Headers:

    Fields
    Description
    Mandatory/Optional
    Data Type
    Length
    Sample Value
    clientId
    Unique client ID provided by Mashreq to corporate.
    Mandatory
    STRING
     
     
    Authorization
    Bearer Token received from get token API with respect to Scope
    Mandatory
    STRING
     
     

    Request Parameters:

    Fields
    Description
    Mandatory\Optional
    Data Type
    Length
    Sample Value
    batchId
    Unique batch Id passed by the corporate\client.
    Mandatory
    STRING
    Max 16
    UAT2705001
    cif
    Unique CIF number
    Mandatory
    STRING
    Max 9
    123456789
    cifList
    Contains the block of CIFs.
    Optional
    ARRAY
     
    [{"cif": "123456789", "accountnumberList": ["123456789012","AE220330000010493112345"]}]
    accountnumberList
    Contains account number.
    Mandatory
    ARRAY
     
    ["123456789012","AE220330000010493112345"]

    Response Parameters:

    Fields
    Description
    Mandatory\Optional
    Data Type
    Length
    Sample Value
    status
    Shows the status of the request
    Mandatory
    STRING
    Max 20
    Request Initiated
    statusCode
    http status code.
    Mandatory
    STRING
     
    201
    statusDescription
    Narrative status of the request.
    Mandatory
    STRING
     
    Request Initiated. Please try enquiry after some time with "MsBatchReferenceNumber"/ "batchId" or "MsBatchReferenceNumber" and "msTxnReferenceNumber" or "batchId" and "msTxnReferenceNumber"
    batchId
    Unique batch Id passed by the corporate\client.
    Mandatory
    STRING
    Max 16
    UAT2705001
    msBatchReferenceNumber
    Once bank receives the batch request transaction it assigns or generate a batch number to the request.
    Mandatory
    STRING
    Max 16
    Mb5b20f20c
    data
    Prefix of the block starts with this value.
    Mandatory
    ARRAY
     
     
    accountbalanceinquiryrequestdtos
    Prefix start for the block.
    Mandatory
    ARRAY
     
     
    reqType
    Constant value will always be "accountbalanceinquiry"
    Mandatory
    STRING
     
    accountbalanceinquiry
    cifList
    Contains the block of CIFs
    Mandatory
    STRING
     
     
    cif
    Unique CIF number of corporate
    Mandatory
    STRING
    Max 9
    123456789
    msTxnReferenceNumber
    Unique reference number of request at each account level provided by the bank
    Mandatory
    STRING
    Max 16
    Ms118ae0f8
    accountnumberList
    Account number to tr
    Mandatory
    ARRAY
     
    10150935
    status
    Status of the request. Success or Reject
    Mandatory
    STRING
    Max 20
    Success
    statusCode
    Status of the request. Success or Reject
    Mandatory
    STRING
     
    201
    statusDescription
    Initial request status.
    Mandatory
    STRING
     
    Request Initiated

    Status Code Information:

    Status
    Status Code
    Description
    Success
    200
    Request completed successfully
     
    200
    Balance fetched successfully
     
    201
    Request Initiated
    Rejected
    400
    CIF is mandatory
     
    400
    Account max length is 12 digits
     
    400
    Allowed value of Account should be Numeric
     
    400
    Account number or IBAN is mandatory
     
    400
    Account_number not valid/not exist
     
    400
    Account_number is not Authorized to view Balance details
     
    400
    IBAN Max length is 23 digits
     
    400
    Allowed value of IBAN should be Alphanumeric
     
    400
    IBAN_number not valid
     
    400
    User is not authorized to view balance details for IBAN_number
     
    400
    Account is not valid or not mapped to specific CIF
     
    400
    Mentioned CIF "CIF no" is not mapped to GCIF "GCIF no".
     
    401
    Multiple Client Ids found
     
    401
    Invalid client id or secret code
     
    401
    Unauthorized CIF - "CIF_Number"
     
    401
    API_BANKING_DISABLED for CIF - "CIF_Number"
    Failed
    500
    Due technical error

    2. accountBalanceInquiry: This GET service enables the customer to make an inquiry about the status of initiated request to fetch current and available account balance.

    Request Headers:

    Fields
    Description
    Mandatory/Optional
    Data Type
    Length
    Sample Value
    clientId
    Unique client ID provided by Mashreq to corporate.
    Mandatory
    STRING
     
     
    Authorization
    Bearer Token received from get token API with respect to Scope
    Mandatory
    STRING
     
     

    Request Parameters:

    Fields
    Description
    Mandatory\Optional
    Data Type
    Length
    Sample Value
    batchId
    Unique batch Id passed by the corporate\client.
    Mandatory
    STRING
    Max 16
    UAT2705001
    msBatchReferenceNumber
    Unique CIF number
    Mandatory
    STRING
    Max 16
    Mb5b20f20c
    msTxnReferenceNumber
    Contains the block of CIFs.
    Mandatory
    STRING
    Max 16
    Msfc3bfcc2

    Response Parameters:

    Fields
    Description
    Mandatory\Optional
    Data Type
    Length
    Sample Value
    status
    Shows the status of the request
    Mandatory
    STRING
    Max 20
    SUCCESS
    statusCode
    http status code.
    Mandatory
    STRING
     
    200
    statusDescription
    Narrative status of the request.
    Mandatory
    STRING
     
    Request Completed Successfully
    batchId
    Unique batch Id passed by the corporate\client.
    Mandatory
    STRING
    Max 16
    UAT2705001
    msBatchReferenceNumber
    Once bank receives the batch request transaction it assigns or generate a batch number to the request.
    Mandatory
    STRING
    Max 16
    Mb5b20f20c
    isFinalStatus
    It can be Y or N. Y = No further status of transaction is expected Transaction is concluded. N = Transaction is still in transit and status is expected to change
    Mandatory
    STRING
    Min 1
    Y
    accountbalancedetails
    Prefix to start the block for multiple CIF.
    Mandatory
     
     
     
    cif
    Unique CIF number
    Mandatory
    STRING
    Max 9
    123456789
    msTxnReferenceNumber
    Unique reference number of request at each account
    Mandatory
    STRING
    Max 16
     
    details
    Block starts for account number.
    Mandatory
     
     
     
    accountNumber
    Real account number
    Mandatory
    STRING
    Max 12
    123456789012
    accountTitle
    Account title for the Real account
    Mandatory
    STRING
     
    ABC ACCOUNT
    accountCurrency
    Currency of the account
    Mandatory
    STRING
     
    AED
    availableBalance
    Balance that can be utilized.
    Mandatory
    DECIMAL
    Max 22 - Min 3
    1514448291.50
    currentBalance
    Total amount in the account
    Mandatory
    DECIMAL
    Max 22 - Min 3
    1514448191.50
    overdraftLimit
    Pre-approved limit
    Mandatory
    DECIMAL
    Max 22 - Min 3
    100.00
    accStatus
    Status of the account
    Mandatory
    STRING
     
    ACTIVE
    isFinalStatus
    It can be Y or N. Y = No further status of transaction is expected Transaction is concluded. N = Transaction is still in transit and status is expected to change
    Mandatory
    STRING
    Min 1
    Y
    status
    Shows the status of the request
    Mandatory
    STRING
    Max 20
    SUCCESS
    statusCode
    http status code.
    Mandatory
    STRING
     
    200
    statusDescription
    Narrative status of the request.
    Mandatory
    STRING
     
    Balance fetched successfully

    Status Code Information:

    Status
    Status Code
    Description
    Success
    200
    Request completed successfully
     
    200
    Balance fetched successfully
     
    201
    Request Initiated
    Rejected
    400
    CIF is mandatory
     
    400
    Account max length is 12 digits
     
    400
    Allowed value of Account should be Numeric
     
    400
    Account number or IBAN is mandatory
     
    400
    Account_number not valid/not exist
     
    400
    Account_number is not Authorized to view Balance details
     
    400
    IBAN Max length is 23 digits
     
    400
    Allowed value of IBAN should be Alphanumeric
     
    400
    IBAN_number not valid
     
    400
    User is not authorized to view balance details for IBAN_number
     
    400
    Account is not valid or not mapped to specific CIF
     
    400
    Mentioned CIF "CIF no" is not mapped to GCIF "GCIF no".
     
    401
    Multiple Client Ids found
     
    401
    Invalid client id or secret code
     
    401
    Unauthorized CIF - "CIF_Number"
     
    401
    API_BANKING_DISABLED for CIF - "CIF_Number"
    Failed
    500
    Due technical error
    IMPORTANTS NOTES:
    • Bulk support is against one CIF ID i.e. multiple entries can be updated in one batch referring to a single CIF.
    • You may have to initiate a new batch for a different CIF.
    • For enquiry CIF and Batch id mandatory.
    View API Specifications
Number of API/s
1
Number of APIs
APIC Calls
160
K
Calls per month
Active users
250
Active users
UAE Qatar Bahrain
Regions
Overview
Overview

Mashreq’s Account Balance APIs eliminate the need for manual balance checks or batch file downloads. By exposing secure, on-demand access to account balances, corporates can optimise working capital, validate funds before initiating transactions, and monitor balances to detect anomalies or risks.

What are the benefits?
  • Real-Time Cash Visibility

    Corporates can instantly retrieve balances for all accounts held within the bank, supporting time-sensitive financial decisions.

  • Automated Reconciliation

    Streamline financial operations by syncing real-time balance data with internal ERP or treasury systems, reducing manual effort and errors

  • Optimised Liquidity Management

    Monitor cash positions continuously to manage idle funds, avoid overdrafts, and make informed investment or payment decisions.

  • Enhanced Payment Control

    Validate sufficient balances before initiating large-value or bulk payments, helping prevent failed or delayed transactions.

  • Reduced Fraud and Operational Risk

    Frequent balance checks help detect unusual activity or unauthorised transactions, strengthening financial control.

  • Improved Financial Reporting

    Generate up-to-date, accurate reports on account positions for audits or internal compliance reviews.

 
Which APIs are offered?
  • Account Balance API: This API provides customers with real-time information on their current and available account balances. It improves cash visibility, automates reconciliation, and enhances the efficiency of financial operations.

 

By leveraging Mashreq’s Account Balance APIs, corporate clients can significantly enhance their financial operations, ensuring more efficient, accurate, and secure management of their financial activities. 

What can I do with this API ?
icon
icon
icon
icon
Product benefits
Fetch real-time current and available balances of one or multiple internal accounts.
Validate sufficient funds before initiating domestic fund transfers, salary payouts, or vendor settlements.
Enable automated cash reconciliation by syncing account balances with internal ledgers.
Monitor cash thresholds and trigger alerts when balances fall below or exceed predefined limits.
Account Balance
Engage with us
Get started today or reach out to learn more.
 
Register today to access and get started with our tools and API documentation.
Get Started
 
Schedule a call with our team to understand how our offering can support you and your customers.
Schedule a call
 
 
icon
icon
icon
icon
icon
  • Cookies Policy
  • Privacy Policy
  • Disclaimer
  • Terms & Condition
  • Contact Us
Mashreqbank PSC is regulated by the Central Bank of the United Arab Emirates.