Securely upload and process bulk employee salary payments with real-time status tracking.
- Overview
- APIs Offered
- This API offers 2 operation types namely initiatePayroll and enquirePayroll.
- 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
- “isFinalStatusFlag” It can be Y or N. if “Y” it means no further status of transaction is expected i.e. either Transaction is completed or rejected. Please read this with “processingStatus” If “N” it means transaction is still in transit and status update is expected to change.
- Please verify CURL URLs as they may differ in CURL please align as defined in the URL document.
- Public key to be used to encrypt the payment initiation request.
The Payroll API (File-Based) allows corporate clients to submit employee salary payments in bulk [NWPS LCY and FCY/ WPS] through a secure file upload. Files are validated and processed as defined workflows, with status updates provided for easy tracking.
The Payroll API (File-Based) allows corporate clients to submit employee salary payments in bulk [NWPS LCY and FCY/ WPS] through a secure file upload. Files are validated and processed as defined workflows, with status updates provided for easy tracking.
NOTE:
Flow Chart
What operations can be performed?
1. initiate: Initiate Payroll API allows to upload the bulk payroll file. i.e., NWPS LCY/FCY files and WPS files.
Request Headers:
Request Parameters:
Max16
Max16
WPSUAE or WPSQATAR,
NWPS:
TMPXXXXXX (where 'XXXXXX' represents the Template ID
NON WPS - .txt or .csv
QATAR WPS - .csv
Max 23 [UAE]
Max 29 [QATAR]
Response Parameters:
Y = No further status of transaction is expected Transaction is concluded.
N = Transaction is still in transit and status is expected to change.
Status Code Information:
2. enquire: This is a GET method and enables corporates to retrieve a Payroll files transaction latest status. Mashreq exposes this service to retrieve the transaction status.
Request Parameters:
Response Parameters:
Applicable only for WPS.
Status Code Information:
IMPORTANTS NOTES:
The Payroll API (File-Based) allows corporate clients to submit employee salary payments in bulk [NWPS LCY and FCY/ WPS] through a secure file upload. Files are validated and processed as defined workflows, with status updates provided for easy tracking.
What are the benefits?
Automated Salary Disbursement
Enables seamless and automated salary payments to employees, reducing manual processing and operational effort.
Real-Time Payment Status
Provides instant visibility into payroll transaction status, helping organizations track salary payments efficiently
Faster Payroll Processing
Accelerates salary file submission, validation, and payment execution, ensuring timely employee payouts.
Seamless ERP & HRMS Integration
Integrates directly with corporate payroll, HRMS, and ERP systems, eliminating manual data exchange.
Reduced Operational Costs
Minimizes administrative workload and manual intervention, improving overall payroll efficiency.
Enhanced Security & Compliance
Supports secure authentication, authorization, and audit trails to ensure payroll data confidentiality and regulatory compliance.
Improved Reconciliation
Provides consolidated payroll transaction details and reporting, simplifying reconciliation and exception handling.
Scalable Corporate Payroll Management
Supports bulk salary payments across large employee bases, making it ideal for organizations of any size.
Which APIs are offered?
- Payroll Initiate API: Initiate Payroll API allows to upload the bulk payroll file. i.e., NWPS LCY/FCY files and WPS files
- Payroll Enquiry API: This service is a GET method and enables corporates to retrieve a Payroll files transaction latest status. Mashreq exposes this service for corporates to retrieve the transaction status.