These APIs provide corporate customers with real-time information on bank account statements, virtual account statements, and MT940 statements, allowing for easy integration with internal financial systems or ERPs.
- Overview
- APIs Offered
- Use Cases
- 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
- BENEFICIARY_NAME
- CUSTOMER_REFERENCE_NUMBER
- BANK_REFERENCE_NUMBER
- DEBIT_AMOUNT
- CREDIT_AMOUNT
- BATCH_ID
- LAST_10_TRANSACTIONS
- PREVIOUS_DAY_TRANSACTIONS
- SELECTIVE_DATE_RANGE_TRANSACTIONS
- BENEFICIARY_NAME
- CUSTOMER_REFERENCE_NUMBER
- BANK_REFERENCE_NUMBER
- DEBIT_AMOUNT
- CREDIT_AMOUNT
- BATCH_ID
- BENEFICIARY_NAME
- CUSTOMER_REFERENCE_NUMBER
- BANK_REFERENCE_NUMBER
- DEBIT_AMOUNT
- CREDIT_AMOUNT
- BATCH_ID
- SELECTIVE_DATE_RANGE_TRANSACTIONS
- BENEFICIARY_NAME
- CUSTOMER_REFERENCE_NUMBER
- BANK_REFERENCE_NUMBER
- DEBIT_AMOUNT
- CREDIT_AMOUNT
- SELECTIVE_DATE_RANGE_TRANSACTIONS
- SUCCESS
- FAILED
- REJECTED
- STATEMENTS_FETCHED_SUCCESSFULLY
- NO_RECORDS_FOUND
- FIELDS_LIMIT_EXCEEDED
- INVALID_SEARCH_BY
- INVALID_ACCT_TYPE
- INVALID_ACCOUNT_NUMBER
- INVALID_DATE_FIELDS
- TO_DATE_IS_AFTER_CURRENT_DATE
- DATE_FIELDS_MISSING
- FROM_DATE_IS_AFTER_CURRENT_DATE
- acctNumber
- acctTitle
- acctCurrency
- fromDate
- toDate
- No date range or search value is required when Last_10_Transaction OR PREVIOUS_DAY_ TRANSACTIONS are looked for in the statement.
- Batch ID search along with date range enables you to look for the debits for that specific batch
- Date range criteria are required with every search except for the last 10 and previous day transactions.
- Please note these are parameters and should be used as parameters in the request.
- 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
- BENEFICIARY_NAME
- CUSTOMER_REFERENCE_NUMBER
- BANK_REFERENCE_NUMBER
- DEBIT_AMOUNT
- CREDIT_AMOUNT
- BATCH_ID
- LAST_10_TRANSACTIONS
- PREVIOUS_DAY_TRANSACTIONS
- SELECTIVE_DATE_RANGE_TRANSACTIONS
- BENEFICIARY_NAME
- CUSTOMER_REFERENCE_NUMBER
- BANK_REFERENCE_NUMBER
- DEBIT_AMOUNT
- CREDIT_AMOUNT
- BATCH_ID
- BENEFICIARY_NAME
- CUSTOMER_REFERENCE_NUMBER
- BANK_REFERENCE_NUMBER
- DEBIT_AMOUNT
- CREDIT_AMOUNT
- BATCH_ID
- SELECTIVE_DATE_RANGE_TRANSACTIONS
- BENEFICIARY_NAME
- CUSTOMER_REFERENCE_NUMBER
- BANK_REFERENCE_NUMBER
- DEBIT_AMOUNT
- CREDIT_AMOUNT
- SELECTIVE_DATE_RANGE_TRANSACTIONS
- SUCCESS
- FAILED
- REJECTED
- STATEMENTS_FETCHED_SUCCESSFULLY
- NO_RECORDS_FOUND
- FIELDS_LIMIT_EXCEEDED
- INVALID_SEARCH_BY
- INVALID_ACCT_TYPE
- INVALID_ACCOUNT_NUMBER
- INVALID_DATE_FIELDS
- TO_DATE_IS_AFTER_CURRENT_DATE
- DATE_FIELDS_MISSING
- FROM_DATE_IS_AFTER_CURRENT_DATE
- acctNumber
- acctTitle
- acctCurrency
- fromDate
- toDate
- transactionDate
- transactionDescription
- transactionReference
- transactionRemarks
- debitAmount
- creditAmount
- balance
- customerReference
- valueDate
- channelReferenceNumber
- popCodeDetails
- beneName
- beneAccountNumber
- No date range or search value is required when Last_10_Transaction OR PREVIOUS_DAY_ TRANSACTIONS are looked for in the statement.
- Batch ID search along with date range enables you to look for the debits for that specific batch
- Date range criteria are required with every search except for the last 10 and previous day transactions.
- Please note these are parameters and should be used as parameters in the request.
- 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
- Request Initiated
- SUCCESS
- FAILED
- REJECTED
- SUCCESS - 200
- Request Initiated - 201
- REJECTED - 401
- FAILED - 500
- reqType
- cif
- virtualEntityId
- virtualAccNumber
- fromDate
- toDate
- Request Initiated
- SUCCESS
- FAILED
- REJECTED
- SUCCESS - 200
- Request Initiated - 201
- REJECTED - 401
- FAILED - 500
- txnReferenceNumber
- drCr
- msgText
- valueDate
- accountId
- transactionStatus
- trnDate
- transactionAmount
- runningBalance
- Active (A)
- Reversed (R)
- Pending (P)
- Expired (E)
- If same customer is requesting statement for same VA account, more than 20 times in same day, “REJECTED” response will be sent with reason “maximum limit for fetching statement exhausted. Please try on next calendar day”.
This API provides corporate clients with detailed electronic bank statements in the MT940 format, a standardized SWIFT message format used globally for end-of-day bank statements
NOTE:
Flow Chart
What operations can be performed?
1. downloadStatement: This service is required to download debit and credit information from the account statements in globally recognized MT940 format. This is a GET method.
Request Headers:
Request Parameters:
Options for search filters are as under.
The value to search. Must be used together with searchBy values for
Must be used together with toDate and with mentioned below searchBy values.
The end date for the statements must not exceed 6 months. Must be used together with fromDate and with below searchBy values.
F_MT940 STATEMENT (Returns MT940 STATEMENT as file attachment in response).
MT940 STATEMENT (Returns MT940 STATEMENT as part of response with the message).
Response Headers:
Response Parameters:
Status of the request whether it is success or failed with below values.
Additional message/description of the status with below possible values.
Summary Object of the given account number consists of below fields.
Status Code Information:
IMPORTANTS NOTES:
This API enables clients to retrieve detailed account information, credit and debit information, transaction histories, and other financial data efficiently and securely.
NOTE:
Flow Chart
What operations can be performed?
1. pullStatement: This is a GET method that is required to fetch debit and credit information from the account statements with different criteria.
Request Headers:
Request Parameters:
CASA
Options for search filters are as under.
The value to search. Must be used together with searchBy values for
Must be used together with toDate and with mentioned below searchBy values.
The end date for the statements must not exceed 6 months. Must be used together with fromDate and with below searchBy values.
Response Parameters:
Status of the request whether it is success or failed with below values
Additional message/description of the status with below possible values.
Summary Object of the given account number consists of below fields.
Array of statement records consists of below fields for each transaction.
Status Code Information:
IMPORTANTS NOTES:
This API allows corporate clients to fetch information and inquire about virtual account transactions occurred in one or more virtual accounts associated with the client.
NOTE:
Flow Chart
What operations can be performed?
1. initiateVirtualAccountEntries: This POST method allows the customer to make a manual credit entry into one or more associated virtual accounts using the virtual account numbers.
Request Headers:
Request Parameters:
Response Parameters:
Status of the request whether it is success or failed with below values
Status code can be any one of the below:
Contains the request details of below parameters:
Status Code Information:
2. virtualAccountEntriesEnquiry: This GET service enables the customer to make an inquiry request about the manual credit entry status in one or more virtual accounts associated with them.
Request Headers:
Response Parameters:
Status of the request whether it is success or failed with below values
Status code can be any one of the below:
Array of statement records consists of below fields for each transaction.
This is to provide transaction status to Customer. Possible values are:
IMPORTANTS NOTES:
Statement APIs offer a direct link between corporate financial systems and banking services, ensuring that businesses have up-to-date information at their fingertips. This integration enhances transparency, improves financial management, and supports compliance with regulatory requirements.
What are the benefits?
Real-Time Access
Obtain up-to-date financial statements and transaction details instantly, enabling timely decision-making.
Enhanced Accuracy
Reduce errors by automating the retrieval of financial data, minimizing manual data entry.
Improved Financial Management
Gain better insights into cash flows, account balances, and transaction histories, facilitating more effective financial planning.
Security
Ensure the protection of sensitive financial information with robust security measures, including encryption and secure authentication.
Compliance
Simplify compliance with financial regulations by providing accurate and timely financial data.
Standardization
Access bank statements in the globally recognized MT940 format, ensuring consistency and compatibility with various financial systems.
Which APIs are offered?
- Account Statement API: This API enables clients to pull or retrieve detailed account information, credit and debit information, transaction histories, and other financial data efficiently and securely.
- Virtual Account Statement API: This API allows corporate clients to fetch information regarding virtual account transactions occurred in one or more virtual accounts associated with the client.
- MT940 Statement API: This API provides corporate clients with detailed electronic bank statements in the MT940 format, a standardized SWIFT message format used globally for end-of-day bank statements.
By leveraging Mashreq’s Statement APIs, corporate clients can significantly enhance their financial operations, ensuring more efficient, accurate, and secure management of their financial data. This product empowers businesses to focus on their core activities while maintaining robust and efficient financial management systems
The client assigned unique virtual account numbers to property buyers and tenants for streamlined payment tracking and reconciliation.
Provides real-time capability for timely settlements, enhanced cash flow and operational efficiency.
