Corporate
CreditDebit Notification
Credit-Debit Notification

Description

These APIs provide businesses with real time, instant alerts for credit and debit transactions on their accounts that enhance their ability to monitor and manage their financial activities effectively.

In order to subscribe, Please

  • Overview
  • APIs Offered
  • Use Cases
    Credit Debit Notification API
    View API Specifications

    This API provides customers with real-time alerts for credit and debit transactions on their accounts, assisting in the maintenance of accurate financial records and the detection of fraudulent activity.

    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.
    • The customer will expose this API, which will then be consumed by the bank to deliver credit/debit notifications

    Flow Chart

    Image
    Flow Chart Credit-Debit Notification API

    What operations can be performed?

    1. creditDebitNotification: This POST method is used to get credit/debit notification response for a transaction.

    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 Name
    Field Format
    Mandatory/Optional
    Data Type
    Length
    Unique CIF number
    cif
    Mandatory
    STRING
    9
    Account Number
    accountNo
    Mandatory
    STRING
    20
    MS level reference no
    msReferenceNo
    Mandatory
    STRING
    16
    Transactions List (can contain multiple transactions in single request)
    accountTxns
    Mandatory
    ARRAY
    NA
    Account Currency
    accountCurrency
    Mandatory
    STRING
    3
    Instrument number
    instrumentNo
    Optional
    STRING
    16
    Account currency amount
    txnLcyAmount
    Mandatory
    STRING
    26
    Value Date
    txnValueDate
    Mandatory
    STRING
    10 (YYYY-MM-DD) ex:2024-11-14)
    Transaction Posting Time
    txnPostingTime
    Mandatory
    STRING
    20 (YYYY-MM-DD HH:MM:SS eg: 2024-11-14 14:18:56)
    Unique CIF number
    cifNo
    Mandatory
    STRING
    9
    Remarks or Narration
    txnNarration
    Mandatory
    STRING
    1000
    Transaction Type (D - Debit / C - Credit)
    txnType
    Mandatory
    STRING
    1
    Transaction reference no
    txnReferenceNo
    Mandatory
    STRING
    16
    Virtual account no
    virtualAccountNo
    Mandatory
    STRING
    12
    Core reference no
    coreReferenceNo
    Mandatory
    STRING
    16

    Response Parameters:

    Fields
    Description
    Mandatory/Optional
    Data Type
    Length
    Sample value
    status
    Shows the status of transaction as soon as transaction is initiated
    Mandatory
    STRING
    Max 10
    SUCCESS
    msReferenceNo
    Reference no. assigned by bank
    Mandatory
    STRING
    Max 16
    ms123456789012

    Status Code Information:

    Status code
    Status
    Description
    200
    SUCCESS
    Transaction details received successfully
    400
    REJECTED
    Invalid request
    401
    REJECTED
    Enquiry Rejected due to Unauthorised user
    500
    FAILED
    Failed to receive the transaction details due to internal server error.
    IMPORTANTS NOTES:
    • Corporates will have to align with the format defined for notifications to consume the same form, Mashreq.
    • Prerequisites for the notification are to provide CIF and account details for which notifications are required. This information is required by the bank to set up.
    • Corporates are to provide a URL to the bank; the provided URL should be used as receipt data from the bank.
Number of API/s
1
Number of APIs
APIC Calls
160
K
Calls per month
Active users
250
Active users
Regions
Overview
Overview

Credit/Debit Notification APIs work on the webhook concept, streaming information continuously and in real-time, offering immediate visibility into account activities, and allowing businesses to respond quickly to account activities. This capability is essential for maintaining accurate financial records, detecting fraudulent activities, and ensuring compliance with regulatory requirements. 

What are the benefits?
  • Immediate Alerts

    Receive instant notifications for all credit and debit transactions, ensuring timely awareness of account activities.

  • Operational Efficiency

    Automate the monitoring of account activities, reducing the need for manual checks and improving accuracy.

  • Improved Cash Flow Management

    Gain real-time insights into cash flows, enabling better financial planning and liquidity management.

  • Enhanced Security

    Monitor account activities in real-time to detect and respond to unauthorized transactions promptly.

  • Compliance

    Ensure compliance with regulatory requirements by maintaining accurate and up-to-date financial records.

  • Customer Satisfaction

    Provide clients with real-time updates on their transactions, enhancing transparency and trust.

Which APIs are offered?
  • Credit/Debit Notification API: This API provides customers with real-time alerts for credit and debit transactions on their accounts, assisting in the maintenance of accurate financial records and the detection of fraudulent activity.

 

By leveraging Mashreq’s Credit/Debit Notification 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
Product benefits
Track incoming and outgoing payments in real-time, helping businesses manage liquidity and optimize financial planning.
Receive instant notifications for expenses, enabling better control and management of business expenditures.
Provide clients with real-time updates on their transactions, improving customer service and satisfaction.
Monitor payments to suppliers and vendors in real-time, ensuring timely and accurate processing of transactions.
Credit-Debit Notification
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.
 
Schedule a call with our team to understand how our offering can support you and your customers.