These APIs provide services that enable businesses to receive payments from their customers efficiently. They are used to manage receivables and streamline the inflow of funds into a corporate account.
- Overview
- APIs Offered
- 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
- UETR reference number may not appear upfront in the initial response when the transactions are initiated, it may appear during inquiry call.
- UETR reference is not available for account-to-account transactions.
- “Finalstatus” can be Y or N. “Y” means no further status of transaction is expected i.e. either Transaction is completed or rejected. “N” means transaction is still in transit and status update is expected to change.
- 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
- UETR reference number may not appear upfront in the initial response when the transactions are initiated, it may appear during inquiry call.
- UETR reference is not available for account-to-account transactions.
- “Finalstatus” can be Y or N. “Y” means no further status of transaction is expected i.e. either Transaction is completed or rejected. “N” means transaction is still in transit and status update is expected to change.
- 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
- This API is used to inquire about the status of previously initiated collection request.
- This is a bulk API and supports batch request processing.
- The “collectionStatus” indicates the status of previously initiated collection request and “status” indicates whether the API call is successful or not.
- 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
- This API is used to initiate payment collection from customers.
- This is a bulk API and supports batch request processing.
- This API provides detailed response for the status of collection request initiated with status code, description and additional remarks
This API allows clients to register a customer’s Direct Debit Authorisation (DDA) details into the system securely. This API captures essential banking and customer information required to set up recurring payments via direct debit.
NOTE:
Flow Chart
What operations can be performed?
1. dda-registration: This service is a POST method and enables corporates to initiate registration for Direct Debit Authorisation and returns the interim status.
Request Headers:
Request Parameters:
Response Parameters:
Status Code Information:
IMPORTANTS NOTES:
This API allows clients to initiate a Direct Debit Authorisation (DDA) status inquiry and returns the interim status.
NOTE:
Flow Chart
What operations can be performed?
1. dda-inquiry: This is a GET method that allows clients to fetch the status of previously initiated Direct Debit Authorisation registration.
Request Headers:
Request Parameters:
Response Parameters:
Status Code Information:
IMPORTANTS NOTES:
This API enables clients to fetch the details of collection requests initiated by clients and supports real-time inquiries to verify the status, reference details, and settlement updates of those requests
NOTE:
Flow Chart
What operations can be performed?
1. collectionFetchAndInquiry: This is a POST method that allows the clients to fetch details and inquiry about the previously initiated collection request..
Request Headers:
Request Parameters:
Response Parameters:
Status Code Information:
IMPORTANTS NOTES:
This API allows clients to initiate, track, and manage payment collection requests from customers.
NOTE:
Flow Chart
What operations can be performed?
1. collectionRequest: This is a POST method that allows the clients to initiate, track, and manage payment collection requests from customers.
Request Headers:
Request Parameters:
Response Parameters:
Status Code Information:
IMPORTANTS NOTES:
Mashreq’s Collection APIs enable corporate clients to efficiently manage and automate the collection of payments from their customers, partners, or subsidiaries. The product supports multiple collection channels like Direct Debit Authorisation (DDA) to streamline receivables, enhance cash flow visibility, and simplify reconciliation.
What are the benefits?
Instant Payment Visibility
Provides instant access to payment status, supporting better cash flow and liquidity management.
Automated Payment Collection
Reduces manual effort by enabling scheduled, rule-based collections directly from customer accounts.
Improved Reconciliation
Simplifies reconciliation of payments with online tracking and detailed transaction records.
Reduced Fraud Risk
Direct debit mandates verify customer accounts upfront, lowering the risk of fraudulent transactions.
Operational Efficiency
Minimises errors, reduces manual tracking, and integrates easily with ERP and treasury systems.
Timely Payments
Reduces the likelihood of missed or delayed payments, improving payment efficiency.
Which APIs are offered?
- Direct Debit Authorisation Registration API: This API allows clients to register a customer’s Direct Debit Authorisation (DDA) details into the system securely. This API captures essential banking and customer information required to set up recurring payments via direct debit.
- Direct Debit Authorisation Inquiry API: This API allows clients to initiate a Direct Debit Authorisation (DDA) status inquiry and returns the interim status.
By leveraging Mashreq’s Collection APIs, corporates can achieve faster payment cycles, improved liquidity, and greater operational efficiency by making receivables management seamless, secure, and scalable.